RenderAreaListenerOnKeyDown Method |
Triggered when a KeyDown event is received from the client.
Namespace: OIV.RemoteViz.RenderingAssembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 9.9.13.0 (9.9.13.0)
Syntaxpublic virtual bool OnKeyDown(
RenderArea renderArea,
Connection sender,
int x,
int y,
out SoKeyboardEventKeys key
)
Public Overridable Function OnKeyDown (
renderArea As RenderArea,
sender As Connection,
x As Integer,
y As Integer,
<OutAttribute> ByRef key As SoKeyboardEventKeys
) As Boolean
public:
virtual bool OnKeyDown(
RenderArea^ renderArea,
Connection^ sender,
int x,
int y,
[OutAttribute] SoKeyboardEventKeys% key
)
abstract OnKeyDown :
renderArea : RenderArea *
sender : Connection *
x : int *
y : int *
key : SoKeyboardEventKeys byref -> bool
override OnKeyDown :
renderArea : RenderArea *
sender : Connection *
x : int *
y : int *
key : SoKeyboardEventKeys byref -> bool
Parameters
- renderArea
- Type: OIV.RemoteViz.RenderingRenderArea
: pointer to the RenderArea
- sender
- Type: OIV.RemoteViz.RenderingConnection
: pointer to the connection that send the event
- x
- Type: SystemInt32
: horizontal coordinate
- y
- Type: SystemInt32
: vertical coordinate
- key
- Type: OIV.Inventor.EventsSoKeyboardEventKeys
: pressed key
Return Value
Type:
Booleantrue to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.
Remarks
Default behavior : accept the event by returning true.
See Also