Aspect_VKeySet Class Reference

Structure defining key state. More...

#include <Aspect_VKeySet.hxx>

Inheritance diagram for Aspect_VKeySet:

Public Member Functions
	Aspect_VKeySet ()
	Main constructor.
Aspect_VKeyFlags	Modifiers () const
	Return active modifiers.
double	DownTime (Aspect_VKey theKey) const
	Return timestamp of press event.
double	TimeUp (Aspect_VKey theKey) const
	Return timestamp of release event.
bool	IsFreeKey (Aspect_VKey theKey) const
	Return TRUE if key is in Free state.
bool	IsKeyDown (Aspect_VKey theKey) const
	Return TRUE if key is in Pressed state.
Standard_Mutex &	Mutex ()
	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.
void	Reset ()
	Reset the key state into unpressed state.
void	KeyDown (Aspect_VKey theKey, double theTime, double thePressure=1.0)
	Press key.
void	KeyUp (Aspect_VKey theKey, double theTime)
	Release key.
void	KeyFromAxis (Aspect_VKey theNegative, Aspect_VKey thePositive, double theTime, double thePressure)
	Simulate key up/down events from axis value.
bool	HoldDuration (Aspect_VKey theKey, double theTime, double &theDuration)
	Return duration of the button in pressed state.
bool	HoldDuration (Aspect_VKey theKey, double theTime, double &theDuration, double &thePressure)
	Return duration of the button in pressed state.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
Standard_Transient *	This () 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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

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

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

theKey	key to check
theTime	current time (for computing duration from key down time)
theDuration	key 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

theKey	key to check
theTime	current time (for computing duration from key down time)
theDuration	key press duration
thePressure	key 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

theKey	key pressed
theTime	event 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

theKey	key pressed
theTime	event 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:

• Aspect_VKeySet.hxx