Enum that specifies type of a system event. More...

#include <SystemEvents.h>

Inheritance diagram for trCore::SystemEvents:

Collaboration diagram for trCore::SystemEvents:

Static Public Attributes
static const SystemEvents	EVENT_TRAVERSAL
	The event traversal event. More...

static const SystemEvents	POST_EVENT_TRAVERSAL
	The post event traversal event. More...

static const SystemEvents	PRE_FRAME
	The pre frame event. More...

static const SystemEvents	CAMERA_SYNCH
	The camera synchronization event. More...

static const SystemEvents	FRAME_SYNCH
	The frame synchronization event. More...

static const SystemEvents	FRAME
	The frame event. More...

static const SystemEvents	POST_FRAME
	The post frame event. More...

static const SystemEvents	PAUSED
	The paused event. More...

static const SystemEvents	UNPAUSED
	The unpaused event. More...

static const SystemEvents	TIME_SCALE_CHANGED
	Indicates a change in the time scale. More...

static const SystemEvents	SHUTTING_DOWN
	Gets sent out when the system is shutting down. More...

Protected Member Functions
	SystemEvents (const std::string &name, unsigned int id)
	Constructor, protected to prevent creation of an instance. More...

Protected Member Functions inherited from trUtil::EnumerationNumeric
	EnumerationNumeric (const std::string &name, unsigned int orderId)
	ctor Protected to prevent creation of an instance. More...

	~EnumerationNumeric ()
	dtor. More...

Protected Member Functions inherited from trUtil::EnumerationString
virtual int	Compare (const std::string &nameString) const
	Virtual string compare method to used by the operators that take a string. More...

virtual	~EnumerationString ()
	Private virtual destructor to get rid of compile warning. More...

	EnumerationString (const std::string &name)
	Construct the EnumerationString. More...

Additional Inherited Members
Public Types inherited from trUtil::EnumerationNumeric
using	BaseClass = EnumerationString
	/ Adds an easy and swappable access to the base class. More...

Public Member Functions inherited from trUtil::EnumerationNumeric
unsigned int	GetID () const
	Returns the Numeric value of the Enum. More...

bool	operator== (const unsigned int &id) const
	Equality test for an EnumerationNumeric. More...

bool	operator!= (const unsigned int &id) const
	Inequality test for an EnumerationNumeric. More...

bool	operator> (const unsigned int &id) const
	Greater than test for an EnumerationNumeric. More...

bool	operator< (const unsigned int &id) const
	Less than test for an EnumerationNumeric. More...

bool	operator> (const EnumerationNumeric &e) const
	Greater than test for an EnumerationNumeric. More...

bool	operator< (const EnumerationNumeric &e) const
	Less than test for an EnumerationNumeric. More...

bool	operator== (const EnumerationNumeric &e) const
	Equality test for an EnumerationNumeric. More...

bool	operator!= (const EnumerationNumeric &e) const
	Inequality test for an EnumerationNumeric. More...

bool	operator== (const std::string &rhs) const
	Overloaded string compare operator for the EnumerationNumeric. More...

bool	operator!= (const std::string &rhs) const
	Overloaded inequality test for this EnumerationNumeric's string value. More...

bool	operator< (const std::string &rhs) const
	Overloaded less than test for this EnumerationNumeric's string value. More...

bool	operator> (const std::string &rhs) const
	Overloaded greater than test for this EnumerationNumeric's string value. More...

Public Member Functions inherited from trUtil::EnumerationString
const std::string &	GetName () const
	Inlined because it's called frequently. More...

bool	operator== (const EnumerationString &rhs) const
	Equality test for an EnumerationString. More...

bool	operator!= (const EnumerationString &rhs) const
	Inequality test for an EnumerationString. More...

bool	operator== (const std::string &rhs) const
	Overloaded string compare operator for the EnumerationString. More...

bool	operator!= (const std::string &rhs) const
	Overloaded inequality test for this EnumerationString's string value. More...

bool	operator< (const std::string &rhs) const
	Overloaded less than test for this EnumerationString's string value. More...

bool	operator> (const std::string &rhs) const
	Overloaded greater than test for this EnumerationString's string value. More...

bool	operator< (const EnumerationString &rhs) const
	Overloaded less than operator. More...

Detailed Description

Enum that specifies type of a system event.

Definition at line 35 of file SystemEvents.h.

Constructor & Destructor Documentation

◆ SystemEvents()

trCore::SystemEvents::SystemEvents	(	const std::string &	name,
		unsigned int	id
	)

protected

Constructor, protected to prevent creation of an instance.

Parameters

name	The name.
id	The identifier.

Definition at line 29 of file SystemEvents.cpp.

References CAMERA_SYNCH, EVENT_TRAVERSAL, FRAME, FRAME_SYNCH, PAUSED, POST_EVENT_TRAVERSAL, POST_FRAME, PRE_FRAME, SHUTTING_DOWN, TIME_SCALE_CHANGED, and UNPAUSED.

Member Data Documentation

◆ CAMERA_SYNCH

const SystemEvents trCore::SystemEvents::CAMERA_SYNCH

static

The camera synchronization event.

Definition at line 50 of file SystemEvents.h.

Referenced by trCore::SystemDirector::CameraSynch(), and SystemEvents().

◆ EVENT_TRAVERSAL

const SystemEvents trCore::SystemEvents::EVENT_TRAVERSAL

static

The event traversal event.

Definition at line 41 of file SystemEvents.h.

Referenced by trCore::SystemDirector::EventTraversal(), and SystemEvents().

◆ FRAME

const SystemEvents trCore::SystemEvents::FRAME

static

The frame event.

Definition at line 56 of file SystemEvents.h.

Referenced by trCore::SystemDirector::Frame(), and SystemEvents().

◆ FRAME_SYNCH

const SystemEvents trCore::SystemEvents::FRAME_SYNCH

static

The frame synchronization event.

Definition at line 53 of file SystemEvents.h.

Referenced by trCore::SystemDirector::FrameSynch(), and SystemEvents().

◆ PAUSED

const SystemEvents trCore::SystemEvents::PAUSED

static

The paused event.

Definition at line 62 of file SystemEvents.h.

Referenced by SystemEvents().

◆ POST_EVENT_TRAVERSAL

const SystemEvents trCore::SystemEvents::POST_EVENT_TRAVERSAL

static

The post event traversal event.

Definition at line 44 of file SystemEvents.h.

Referenced by trCore::SystemDirector::PostEventTraversal(), and SystemEvents().

◆ POST_FRAME

const SystemEvents trCore::SystemEvents::POST_FRAME

static

The post frame event.

Definition at line 59 of file SystemEvents.h.

Referenced by trCore::SystemDirector::PostFrame(), and SystemEvents().

◆ PRE_FRAME

const SystemEvents trCore::SystemEvents::PRE_FRAME

static

The pre frame event.

Definition at line 47 of file SystemEvents.h.

Referenced by trCore::SystemDirector::PreFrame(), and SystemEvents().

◆ SHUTTING_DOWN

const SystemEvents trCore::SystemEvents::SHUTTING_DOWN

static

Gets sent out when the system is shutting down.

Definition at line 71 of file SystemEvents.h.

Referenced by trCore::SystemDirector::ShutDown(), and SystemEvents().

◆ TIME_SCALE_CHANGED

const SystemEvents trCore::SystemEvents::TIME_SCALE_CHANGED

static

Indicates a change in the time scale.

Definition at line 68 of file SystemEvents.h.

Referenced by trCore::SystemDirector::SetTimeScale(), and SystemEvents().

◆ UNPAUSED

const SystemEvents trCore::SystemEvents::UNPAUSED

static

The unpaused event.

Definition at line 65 of file SystemEvents.h.

Referenced by SystemEvents().

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

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SystemEvents()

Member Data Documentation

◆ CAMERA_SYNCH

◆ EVENT_TRAVERSAL

◆ FRAME

◆ FRAME_SYNCH

◆ PAUSED

◆ POST_EVENT_TRAVERSAL

◆ POST_FRAME

◆ PRE_FRAME

◆ SHUTTING_DOWN

◆ TIME_SCALE_CHANGED

◆ UNPAUSED