Open CASCADE Technology  7.4.1.dev
Data Structures | Public Member Functions
Aspect_VKeySet Class Reference

Structure defining key state. More...

#include <Aspect_VKeySet.hxx>

Inheritance diagram for Aspect_VKeySet:
Inheritance graph
[legend]

Public Member Functions

 Aspect_VKeySet ()
 Main constructor. More...
 
Aspect_VKeyFlags Modifiers () const
 Return active modifiers. More...
 
double DownTime (Aspect_VKey theKey) const
 Return timestamp of press event. More...
 
double TimeUp (Aspect_VKey theKey) const
 Return timestamp of release event. More...
 
bool IsFreeKey (Aspect_VKey theKey) const
 Return TRUE if key is in Free state. More...
 
bool IsKeyDown (Aspect_VKey theKey) const
 Return TRUE if key is in Pressed state. More...
 
Standard_MutexMutex ()
 Return mutex for thread-safe updates. All operations in class implicitly locks this mutex, so this method could be used only for batch processing of keys. More...
 
void Reset ()
 Reset the key state into unpressed state. More...
 
void KeyDown (Aspect_VKey theKey, double theTime, double thePressure=1.0)
 Press key. More...
 
void KeyUp (Aspect_VKey theKey, double theTime)
 Release key. More...
 
void KeyFromAxis (Aspect_VKey theNegative, Aspect_VKey thePositive, double theTime, double thePressure)
 Simulate key up/down events from axis value. More...
 
bool HoldDuration (Aspect_VKey theKey, double theTime, double &theDuration)
 Return duration of the button in pressed state. More...
 
bool HoldDuration (Aspect_VKey theKey, double theTime, double &theDuration, double &thePressure)
 Return duration of the button in pressed state. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Structure defining key state.

Constructor & Destructor Documentation

◆ Aspect_VKeySet()

Aspect_VKeySet::Aspect_VKeySet ( )

Main constructor.

Member Function Documentation

◆ DownTime()

double Aspect_VKeySet::DownTime ( Aspect_VKey  theKey) const
inline

Return timestamp of press event.

◆ HoldDuration() [1/2]

bool Aspect_VKeySet::HoldDuration ( Aspect_VKey  theKey,
double  theTime,
double &  theDuration 
)
inline

Return duration of the button in pressed state.

Parameters
theKeykey to check
theTimecurrent time (for computing duration from key down time)
theDurationkey press duration
Returns
TRUE if key was in pressed state

◆ HoldDuration() [2/2]

bool Aspect_VKeySet::HoldDuration ( Aspect_VKey  theKey,
double  theTime,
double &  theDuration,
double &  thePressure 
)

Return duration of the button in pressed state.

Parameters
theKeykey to check
theTimecurrent time (for computing duration from key down time)
theDurationkey press duration
thePressurekey pressure
Returns
TRUE if key was in pressed state

◆ IsFreeKey()

bool Aspect_VKeySet::IsFreeKey ( Aspect_VKey  theKey) const
inline

Return TRUE if key is in Free state.

◆ IsKeyDown()

bool Aspect_VKeySet::IsKeyDown ( Aspect_VKey  theKey) const
inline

Return TRUE if key is in Pressed state.

◆ KeyDown()

void Aspect_VKeySet::KeyDown ( Aspect_VKey  theKey,
double  theTime,
double  thePressure = 1.0 
)

Press key.

Parameters
theKeykey pressed
theTimeevent timestamp

◆ KeyFromAxis()

void Aspect_VKeySet::KeyFromAxis ( Aspect_VKey  theNegative,
Aspect_VKey  thePositive,
double  theTime,
double  thePressure 
)

Simulate key up/down events from axis value.

◆ KeyUp()

void Aspect_VKeySet::KeyUp ( Aspect_VKey  theKey,
double  theTime 
)

Release key.

Parameters
theKeykey pressed
theTimeevent timestamp

◆ Modifiers()

Aspect_VKeyFlags Aspect_VKeySet::Modifiers ( ) const
inline

Return active modifiers.

◆ Mutex()

Standard_Mutex& Aspect_VKeySet::Mutex ( )
inline

Return mutex for thread-safe updates. All operations in class implicitly locks this mutex, so this method could be used only for batch processing of keys.

◆ Reset()

void Aspect_VKeySet::Reset ( )

Reset the key state into unpressed state.

◆ TimeUp()

double Aspect_VKeySet::TimeUp ( Aspect_VKey  theKey) const
inline

Return timestamp of release event.


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