Click or drag to resize
SoKeyboardEvent Class

Keyboard key press and release events.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.EventsSoEvent
      OIV.Inventor.EventsSoButtonEvent
        OIV.Inventor.EventsSoKeyboardEvent

Namespace: OIV.Inventor.Events
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoKeyboardEvent : SoButtonEvent

The SoKeyboardEvent type exposes the following members.

Constructors
  NameDescription
Public methodSoKeyboardEvent

Constructor.

Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetKey

Gets which key generated the event.

Public methodGetNormalizedPosition

Gets the normalized location of the cursor when the event occurred, relative to the specified viewport region.

(Inherited from SoEvent.)
Public methodGetPosition

Returns the window pixel location of the cursor when the event occurred as integer values.

(Inherited from SoEvent.)
Public methodGetPosition(SbViewportRegion)

Gets the viewport pixel location of the cursor when the event occurred, relative to the origin of the specified viewport region, as integer values.

(Inherited from SoEvent.)
Public methodGetPositionFloat

Returns the window pixel location of the cursor when the event occurred as float values.

(Inherited from SoEvent.)
Public methodGetPositionFloat(SbViewportRegion)

Gets the viewport pixel location of the cursor when the event occurred, relative to the origin of the specified viewport region, as float values.

(Inherited from SoEvent.)
Public methodGetPrintableCharacter

Convenience routine that returns the character representing the key, if it's printable.

Public methodGetState

Gets the state of the button.

(Inherited from SoButtonEvent.)
Public methodGetTime

Gets the time at which the event occurred.

(Inherited from SoEvent.)
Public methodGetTrackerInfo

Gets whether an event object has associated tracker information.

(Inherited from SoEvent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberIsKeyPressEvent

Returns whether the passed event is a keyboard press event of the passed key.

Public methodStatic memberIsKeyReleaseEvent

Returns whether the passed event is a keyboard release event of the passed key.

Public methodSetAltDown

Sets whether the ALT key was down when the event occurred.

(Inherited from SoEvent.)
Public methodSetButton1Down

Sets whether mouse Button 1 was down when the event occurred.

(Inherited from SoEvent.)
Public methodSetCtrlDown

Sets whether the CTRL key was down when the event occurred.

(Inherited from SoEvent.)
Public methodSetKey

Sets which key generated the event.

Public methodSetPosition(SbVec2f) (Inherited from SoEvent.)
Public methodSetPosition(SbVec2s)

Sets the window pixel location of the cursor when the event occurred.

(Inherited from SoEvent.)
Public methodSetShiftDown

Sets whether the shift key was down when the event occurred.

(Inherited from SoEvent.)
Public methodSetState

Sets the state of the button.

(Inherited from SoButtonEvent.)
Public methodSetTime

Sets the time at which the event occurred.

(Inherited from SoEvent.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWasAltDown

Returns true if the ALT key was down when the event occurred.

(Inherited from SoEvent.)
Public methodWasButton1Down

Returns true if mouse button 1 was down when the event occurred.

(Inherited from SoEvent.)
Public methodWasCtrlDown

Returns true if the CTRL key was down when the event occurred.

(Inherited from SoEvent.)
Public methodWasShiftDown

Returns true if the shift key was down when the event occurred.

(Inherited from SoEvent.)
Top
Remarks

OIV.Inventor.Events.SoKeyboardEvent represents keyboard key press and release events in the Open Inventor event model.

Add an OIV.Inventor.Nodes.SoEventCallback node to the scene graph to handle Open Inventor events.

See Also