Open Inventor Release 2024.1.2
 
Loading...
Searching...
No Matches
SoScaleGestureEvent Class Reference

Class for scale (pinch) gesture events. More...

#include <Inventor/gestures/events/SoScaleGestureEvent.h>

+ Inheritance diagram for SoScaleGestureEvent:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoScaleGestureEvent ()
 Constructor.
 
float getScaleFactor () const
 Gets the ratio between the current fingers distance and the first distance evaluated after the second down event.
 
float getDeltaScaleFactor () const
 Gets the ratio between the current fingers distance and the previous distance.
 
- Public Member Functions inherited from SoGestureEvent
 SoGestureEvent ()
 Constructor.
 
virtual ~SoGestureEvent ()
 Destructor.
 
GestureState getGestureState () const
 Gets the gesture event state (Begin,Delta,End).
 
- Public Member Functions inherited from SoEvent
 SoEvent ()
 Constructor.
 
virtual ~SoEvent ()
 Destructor.
 
virtual void setTime (SbTime t)
 Sets the time at which the event occurred.
 
SbTime getTime () const
 Gets the time at which the event occurred.
 
virtual void setPosition (const SbVec2s &p)
 Sets the window pixel location of the cursor when the event occurred.
 
virtual void setPosition (const SbVec2f &p)
 Float version of setPosition(const SbVec2s &p).
 
const SbVec2sgetPosition () const
 Returns the window pixel location of the cursor when the event occurred as integer values.
 
const SbVec2fgetPositionFloat () const
 Returns the window pixel location of the cursor when the event occurred as float values.
 
const SbVec2sgetPosition (const SbViewportRegion &vpRgn) const
 Gets the viewport pixel location of the cursor when the event occurred, relative to the origin of the specified viewport region, as integer values.
 
const SbVec2fgetPositionFloat (const SbViewportRegion &vpRgn) const
 Gets the viewport pixel location of the cursor when the event occurred, relative to the origin of the specified viewport region, as float values.
 
const SbVec2fgetNormalizedPosition (const SbViewportRegion &vpRgn) const
 Gets the normalized location of the cursor when the event occurred, relative to the specified viewport region.
 
void setShiftDown (SbBool isDown)
 Sets whether the shift key was down when the event occurred.
 
void setCtrlDown (SbBool isDown)
 Sets whether the CTRL key was down when the event occurred.
 
void setAltDown (SbBool isDown)
 Sets whether the ALT key was down when the event occurred.
 
void setButton1Down (SbBool isDown)
 Sets whether mouse Button 1 was down when the event occurred.
 
SbBool wasShiftDown () const
 Returns true if the shift key was down when the event occurred.
 
SbBool wasCtrlDown () const
 Returns true if the CTRL key was down when the event occurred.
 
SbBool wasAltDown () const
 Returns true if the ALT key was down when the event occurred.
 
SbBool wasButton1Down () const
 Returns true if mouse button 1 was down when the event occurred.
 
virtual const SbTrackerInfogetTrackerInfo () const
 Gets whether an event object has associated tracker information.
 
SbTrackerInfogetTrackerInfo ()
 Gets whether an event object has associated tracker information.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoGestureEvent
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoEvent
static SoType getClassTypeId ()
 Returns the type id for the SoEvent class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Additional Inherited Members

- Public Types inherited from SoGestureEvent
enum  GestureState {
  BEGIN ,
  DELTA ,
  END
}
 The different states a gesture event can have. More...
 

Detailed Description

Class for scale (pinch) gesture events.

SoScaleGestureEvent represents a pinch gesture in the Open Inventor event model. Touch events are analyzed by a SoScaleGestureRecognizer. When a scale gesture is recognized, the recognizer generates this event. The gesture begins with a BEGIN state event. DELTA state events are generated until the end of the gesture which generates an END state event. See SoGestureEvent::getGestureState().

Note:

  • In order to get touch events for the gesture recognizer(s) to recognize, the application must explicitly register a touch screen device (SoWinTouchScreen, SoQtTouchScreen, etc).
  • In order to get gesture events, the application must explicitly register gesture recognizers with the touch screen device's touch manager (SoTouchManager).

SEE ALSO

SoEvent, SoGestureEvent, SoDoubleTapGestureEvent, SoLongTapGestureEvent, SoRotateGestureEvent, SoScaleGestureRecognizer

Definition at line 85 of file SoScaleGestureEvent.h.

Constructor & Destructor Documentation

◆ SoScaleGestureEvent()

SoScaleGestureEvent::SoScaleGestureEvent ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoScaleGestureEvent::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getDeltaScaleFactor()

float SoScaleGestureEvent::getDeltaScaleFactor ( ) const

Gets the ratio between the current fingers distance and the previous distance.

◆ getScaleFactor()

float SoScaleGestureEvent::getScaleFactor ( ) const

Gets the ratio between the current fingers distance and the first distance evaluated after the second down event.

◆ getTypeId()

virtual SoType SoScaleGestureEvent::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoGestureEvent.


The documentation for this class was generated from the following file: