HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SIM_GuideShared Class Reference

#include <SIM_GuideShared.h>

+ Inheritance diagram for SIM_GuideShared:

Public Member Functions

 SIM_GuideShared (const SIM_Data *owner, bool displayonce)
 Constructor which takes a const SIM_Data as our owner. More...
 
virtual ~SIM_GuideShared ()
 Destructor for this class. More...
 
- Public Member Functions inherited from SIM_Guide
 SIM_Guide (const SIM_Data *owner)
 Constructor which takes a const SIM_Data as our owner. More...
 
virtual ~SIM_Guide ()
 Destructor for this class. More...
 
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
 
DEP_MicroNodeguideMicroNode ()
 
const DEP_MicroNodeguideMicroNode () const
 

Protected Member Functions

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. More...
 
- Protected Member Functions inherited from SIM_Guide
const SIM_DatagetOwner () const
 Returns our owner data. More...
 
const SIM_TimegetSimulationTime () const
 Returns the current simulation time. More...
 
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. More...
 

Detailed Description

This SIM_Guide subclass caches the geometry and transform from the first object it is asked to build for. Subsequent requests for other objects return null geometry. This way this guide geometry will only be rendered once, not once for each object it is attached to.

Examples:
SIM/SIM_ForceOrbit.C, and SIM/SNOW_Solver.C.

Definition at line 20 of file SIM_GuideShared.h.

Constructor & Destructor Documentation

SIM_GuideShared::SIM_GuideShared ( const SIM_Data owner,
bool  displayonce 
)
explicit

Constructor which takes a const SIM_Data as our owner.

virtual SIM_GuideShared::~SIM_GuideShared ( )
virtual

Destructor for this class.

Member Function Documentation

virtual void SIM_GuideShared::clearSubclass ( )
protectedvirtual

Override this function to clear any data create by this class.

Reimplemented from SIM_Guide.

virtual GU_ConstDetailHandle SIM_GuideShared::getGuideGeometrySubclass ( const SIM_RootData root,
UT_DMatrix4 xform,
const SIM_Time t 
)
protectedvirtual

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 from SIM_Guide.

virtual int64 SIM_GuideShared::getMemorySizeSubclass ( ) const
protectedvirtual

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 from SIM_Guide.


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