| SoMouseWheelEvent Class |
Mouse wheel events.
Inheritance HierarchyNamespace: OIV.Inventor.Events
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe SoMouseWheelEvent type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoMouseWheelEvent | Constructor. |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetDelta | Gets the mouse wheel delta. |
| 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. |
| 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. |
| SetDelta | Sets the mouse wheel delta. |
| 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. |
| 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.SoMouseWheelEvent represents a change in mouse wheel rotation event in the Open Inventor event model.
The wheel has discrete, evenly spaced notches. When you rotate the wheel, a wheel message is sent as each notch is encountered. Most modern mouse wheels generate an event with a value of 120 per each notch of the wheel. Pressing the shift key while moving the mouse wheel will generate events of double the wheel delta (i.e., 240 by default). If necessary, you can use environment variable OIV_WHEEL_DELTA to change this value (see OIV.Inventor.SoPreferences).
The OIV.Inventor.Events.SoMouseWheelEvent.GetDelta() method returns the distance that the mouse wheel has been rotated. A positive value indicates the wheel was rotated forward (away from the user); a negative value indicates the wheel was rotated backwards (toward the user). The values are specified in multiples of the wheel delta.
NOTE: Wheel delta values are NOT always +/- 120. In the case of wheel delta values in a browser, i.e. using RemoteViz, the base delta value seems to be scaled by the Windows Zoom level. E.g. with Windows 7 and Chrome, when using the default/typical "Medium" setting, the zoom level is 125% and the browser returns 125% * 120 = 150. It is safe to use the sign of the value (positive or negative).
See Also