VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes
DtDetonationTimerData Class Reference

DtDetonationTimerData; Container holding a detonation interaction and user data. More...

List of all members.

Public Member Functions

 DtDetonationTimerData ()
 constructor
 DtDetonationTimerData (const DtDetonationTimerData &orig)
 copy constructor
const DtDetonationTimerDataoperator= (const DtDetonationTimerData &orig)
 assignment operator
virtual ~DtDetonationTimerData ()
 destructor - destroys myDetonation
virtual void * userData () const
virtual void setUserData (void *userData)
virtual DtDetonationInteractiondetonation () const
 Accessor/mutator for myDetonation.
virtual void setDetonation (DtDetonationInteraction *detonation)
 Accessor/mutator for myDetonation.

Protected Attributes

void * myUserData
DtDetonationInteractionmyDetonation

Detailed Description

DtDetonationTimerData; Container holding a detonation interaction and user data.

DtDetonationTimerData contains a pointer to a detonation interaction and a usr data ptr (usually the 'this' ptr of the instance registering the detonation) to use as user data for a timer. Generally this class is used when a detonation interaction needs to be scheduled for a later time. To make it easier for users of this class to "hand-off" their detonations, this class assumes ownership of the pointers, and will garbage collect them in its destructor.


Constructor & Destructor Documentation

constructor

copy constructor

destructor - destroys myDetonation


Member Function Documentation

const DtDetonationTimerData& DtDetonationTimerData::operator= ( const DtDetonationTimerData orig)

assignment operator

Accessor/mutator for myDetonation.

DtDetonationTimerData will assume ownership of this pointer and it will be garbage collected in the destructor.

virtual void DtDetonationTimerData::setDetonation ( DtDetonationInteraction detonation) [virtual]

Accessor/mutator for myDetonation.

DtDetonationTimerData will assume ownership of this pointer and it will be garbage collected in the destructor.

virtual void* DtDetonationTimerData::userData ( ) const [virtual]
virtual void DtDetonationTimerData::setUserData ( void *  userData) [virtual]

Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)