| SoButtonEvent Class |
Base class for all button events.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.EventsSoEvent
OIV.Inventor.EventsSoButtonEvent
OIV.Inventor.EventsSoControllerButtonEvent
OIV.Inventor.EventsSoKeyboardEvent
OIV.Inventor.EventsSoMouseButtonEvent
OIV.Inventor.EventsSoSpaceballButtonEvent
Namespace: OIV.Inventor.Events
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe SoButtonEvent type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoButtonEvent | Constructor. |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetNormalizedPosition | Gets the normalized location of the cursor when the event occurred, relative to the specified viewport region. |
| GetPosition | Returns the window pixel location of the cursor when the event occurred as integer values. |
| GetPosition(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. |
| GetPositionFloat | Returns the window pixel location of the cursor when the event occurred as float values. |
| GetPositionFloat(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. |
| GetState | Gets the state of the button. |
| GetTime | Gets the time at which the event occurred. |
| GetTrackerInfo | Gets whether an event object has associated tracker information. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| SetAltDown | Sets whether the ALT key was down when the event occurred. |
| SetButton1Down | Sets whether mouse Button 1 was down when the event occurred. |
| SetCtrlDown | Sets whether the CTRL key was down when the event occurred. |
| SetPosition(SbVec2f) | Float version of OIV.Inventor.Events.SoEvent.SetPosition(OIV.Inventor.SbVec2s). |
| SetPosition(SbVec2s) | Sets the window pixel location of the cursor when the event occurred. |
| SetShiftDown | Sets whether the shift key was down when the event occurred. |
| SetState | Sets the state of the button. |
| SetTime | Sets the time at which the event occurred. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WasAltDown | Returns true if the ALT key was down when the event occurred. |
| WasButton1Down | Returns true if mouse button 1 was down when the event occurred. |
| WasCtrlDown | Returns true if the CTRL key was down when the event occurred. |
| WasShiftDown | Returns true if the shift key was down when the event occurred. |
RemarksOIV.Inventor.Events.SoButtonEvent represents generic button press and release events in the Open Inventor event model. It is the base class for device-specific button events, namely OIV.Inventor.Events.SoControllerButtonEvent, OIV.Inventor.Events.SoKeyboardEvent, OIV.Inventor.Events.SoMouseButtonEvent, and OIV.Inventor.Events.SoSpaceballButtonEvent. This class stores the down/up state of the button when the event occurred.
See Also