Media_Timer Class Reference

Auxiliary class defining the animation timer. More...

#include <Media_Timer.hxx>

Inheritance diagram for Media_Timer:

Public Member Functions
	Media_Timer ()
	Empty constructor.
Standard_Real	ElapsedTime () const
	Return elapsed time in seconds.
Standard_Real	PlaybackSpeed () const
	Return playback speed coefficient (1.0 means normal speed).
void	SetPlaybackSpeed (const Standard_Real theSpeed)
	Setup playback speed coefficient.
Standard_Boolean	IsStarted () const
	Return true if timer has been started.
void	Start ()
	Start the timer.
void	Pause ()
	Pause the timer.
void	Stop ()
	Stop the timer.
void	Seek (const Standard_Real theTime)
	Seek the timer to specified position.
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.

Protected Attributes
OSD_Timer	myTimer
Standard_Real	myTimerFrom
Standard_Real	myTimerSpeed

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

Auxiliary class defining the animation timer.

Constructor & Destructor Documentation

Media_Timer()

Media_Timer::Media_Timer ( )

inline

Empty constructor.

Member Function Documentation

ElapsedTime()

Standard_Real Media_Timer::ElapsedTime ( ) const

inline

Return elapsed time in seconds.

IsStarted()

Standard_Boolean Media_Timer::IsStarted ( ) const

inline

Return true if timer has been started.

Pause()

void Media_Timer::Pause

(

)

Pause the timer.

PlaybackSpeed()

Standard_Real Media_Timer::PlaybackSpeed ( ) const

inline

Return playback speed coefficient (1.0 means normal speed).

Seek()

void Media_Timer::Seek

(

const Standard_Real

theTime

)

Seek the timer to specified position.

SetPlaybackSpeed()

void Media_Timer::SetPlaybackSpeed

(

const Standard_Real

theSpeed

)

Setup playback speed coefficient.

Start()

void Media_Timer::Start ( )

inline

Start the timer.

Stop()

void Media_Timer::Stop

(

)

Stop the timer.

Field Documentation

myTimer

OSD_Timer Media_Timer::myTimer

protected

myTimerFrom

Standard_Real Media_Timer::myTimerFrom

protected

myTimerSpeed

Standard_Real Media_Timer::myTimerSpeed

protected

---

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

• Media_Timer.hxx