osg::FrameStamp Class Reference

Class which encapsulates the frame number, reference time and calendar time of specific frame, used to synchronize operations on the scene graph and other machines when using a graphics cluster. More...

Inheritance diagram for osg::FrameStamp:

Public Member Functions
	FrameStamp ()
	FrameStamp (const FrameStamp &fs)
FrameStamp &	operator= (const FrameStamp &fs)
void	setFrameNumber (unsigned int fnum)
unsigned int	getFrameNumber () const
void	setReferenceTime (double refTime)
double	getReferenceTime () const
void	setSimulationTime (double refTime)
double	getSimulationTime () const
void	setCalendarTime (const tm &calendarTime)
void	getCalendarTime (tm &calendarTime) const
virtual	~FrameStamp ()
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
virtual void	setThreadSafeRefUnref (bool)
	Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called. More...
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	referenceCount () const
	Return the number of pointers currently referencing this object. More...
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Protected Attributes
unsigned int	_frameNumber
double	_referenceTime
double	_simulationTime
int	tm_sec
int	tm_min
int	tm_hour
int	tm_mday
int	tm_mon
int	tm_year
int	tm_wday
int	tm_yday
int	tm_isdst
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Additional Inherited Members
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Detailed Description

Class which encapsulates the frame number, reference time and calendar time of specific frame, used to synchronize operations on the scene graph and other machines when using a graphics cluster.

Note the calendar time can be an artificial simulation time or capture the real time of day etc.

Constructor & Destructor Documentation

FrameStamp() [1/2]

osg::FrameStamp::FrameStamp

(

)

FrameStamp() [2/2]

osg::FrameStamp::FrameStamp

(

const FrameStamp &

fs

)

~FrameStamp()

virtual osg::FrameStamp::~FrameStamp ( )

virtual

Member Function Documentation

getCalendarTime()

void osg::FrameStamp::getCalendarTime

(

tm &

calendarTime

)

const

getFrameNumber()

unsigned int osg::FrameStamp::getFrameNumber ( ) const

inline

getReferenceTime()

double osg::FrameStamp::getReferenceTime ( ) const

inline

getSimulationTime()

double osg::FrameStamp::getSimulationTime ( ) const

inline

operator=()

FrameStamp& osg::FrameStamp::operator=

(

const FrameStamp &

fs

)

setCalendarTime()

void osg::FrameStamp::setCalendarTime

(

const tm &

calendarTime

)

setFrameNumber()

void osg::FrameStamp::setFrameNumber ( unsigned int  fnum )

inline

setReferenceTime()

void osg::FrameStamp::setReferenceTime ( double  refTime )

inline

setSimulationTime()

void osg::FrameStamp::setSimulationTime ( double  refTime )

inline

Member Data Documentation

_frameNumber

unsigned int osg::FrameStamp::_frameNumber

protected

_referenceTime

double osg::FrameStamp::_referenceTime

protected

_simulationTime

double osg::FrameStamp::_simulationTime

protected

tm_hour

int osg::FrameStamp::tm_hour

protected

tm_isdst

int osg::FrameStamp::tm_isdst

protected

tm_mday

int osg::FrameStamp::tm_mday

protected

tm_min

int osg::FrameStamp::tm_min

protected

tm_mon

int osg::FrameStamp::tm_mon

protected

tm_sec

int osg::FrameStamp::tm_sec

protected

tm_wday

int osg::FrameStamp::tm_wday

protected

tm_yday

int osg::FrameStamp::tm_yday

protected

tm_year

int osg::FrameStamp::tm_year

protected

---

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

• osg/FrameStamp