SIM_Guide Class Reference
#include <SIM_Guide.h>
Public Member Functions | |
| SIM_Guide (const SIM_Data *owner) | |
| Constructor which takes a const SIM_Data as our owner. | |
| virtual | ~SIM_Guide () |
| Destructor for this class. | |
| GU_ConstDetailHandle | getGuideGeometry (const SIM_RootData &root, UT_DMatrix4 &xform, const SIM_Time &t) |
| int64 | getMemorySize () const |
| void | clear () |
| void | setParmVersion (long version) |
| long | getParmVersion () const |
Protected Member Functions | |
| const SIM_Data & | getOwner () const |
| Returns our owner data. | |
| const SIM_Time & | getSimulationTime () const |
| Returns the current simulation time. | |
| bool | buildGuideGeometry (const SIM_RootData &root, const GU_DetailHandle &gdh, UT_DMatrix4 *xform, const SIM_Time &t) const |
| Calls SIM_Data::buildGuideGeometry() on the owner data. | |
| virtual GU_ConstDetailHandle | getGuideGeometrySubclass (const SIM_RootData &root, UT_DMatrix4 &xform, const SIM_Time &t) |
| virtual int64 | getMemorySizeSubclass () const |
| virtual void | clearSubclass () |
| Override this function to clear any data create by this class. | |
Detailed Description
This class provides an interface between a SIM_Data and its guide geometry. It decides when it is necessary to actually build the geometry.- Examples:
-
SIM/SIM_ForceOrbit.C, SIM/SIM_ForceOrbit.h, SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.
Definition at line 29 of file SIM_Guide.h.
Constructor & Destructor Documentation
| SIM_Guide::SIM_Guide | ( | const SIM_Data * | owner | ) | [explicit] |
Constructor which takes a const SIM_Data as our owner.
| virtual SIM_Guide::~SIM_Guide | ( | ) | [virtual] |
Destructor for this class.
Member Function Documentation
| bool SIM_Guide::buildGuideGeometry | ( | const SIM_RootData & | root, | |
| const GU_DetailHandle & | gdh, | |||
| UT_DMatrix4 * | xform, | |||
| const SIM_Time & | t | |||
| ) | const [protected] |
Calls SIM_Data::buildGuideGeometry() on the owner data.
| void SIM_Guide::clear | ( | ) |
This function clears all guide geometry information. It calls clearSubclass() to do the actual work.
| virtual void SIM_Guide::clearSubclass | ( | ) | [protected, virtual] |
Override this function to clear any data create by this class.
Reimplemented in SIM_GuidePerObject, SIM_GuideShared, and SIM_GuideStatic.
| GU_ConstDetailHandle SIM_Guide::getGuideGeometry | ( | const SIM_RootData & | root, | |
| UT_DMatrix4 & | xform, | |||
| const SIM_Time & | t | |||
| ) |
This function retrieves some guide geometry and a transform. getGuideGeometrySubclass() does all the real work.
| virtual GU_ConstDetailHandle SIM_Guide::getGuideGeometrySubclass | ( | const SIM_RootData & | root, | |
| UT_DMatrix4 & | xform, | |||
| const SIM_Time & | t | |||
| ) | [protected, virtual] |
Override this function to customize how guide geometry is created or retrieved. Implementing this function is the whole point of this class. This function may build geometry, fetch existing geometry, modify existing geometry, or whatever else it sees fit.
Reimplemented in SIM_GuidePerObject, SIM_GuideShared, and SIM_GuideStatic.
| int64 SIM_Guide::getMemorySize | ( | ) | const |
Returns the amount of memory used by this guide object. This function calls getMemorySizeSubclass().
| virtual int64 SIM_Guide::getMemorySizeSubclass | ( | ) | const [protected, virtual] |
Override this to report the amount of memory used by this object. Call the base class implementation as well and add that to the subclass-specific memory size.
Reimplemented in SIM_GuidePerObject, and SIM_GuideShared.
| const SIM_Data& SIM_Guide::getOwner | ( | ) | const [protected] |
Returns our owner data.
| long SIM_Guide::getParmVersion | ( | ) | const |
Gets the version parms value that was set when this object was created.
| const SIM_Time& SIM_Guide::getSimulationTime | ( | ) | const [protected] |
Returns the current simulation time.
| void SIM_Guide::setParmVersion | ( | long | version | ) |
Sets the version parms value of our creator node at the time the guide geometry was created.
The documentation for this class was generated from the following file:
- SIM/SIM_Guide.h
