SIM_Geometry Class Reference
#include <SIM_Geometry.h>
Public Member Functions | |
| GETSET_DATA_FUNCS_S (SIM_NAME_POSITIONPATH, PositionPath) | |
| GU_ConstDetailHandle | getGeometry () const |
| void | getTransform (UT_DMatrix4 &xform) const |
Protected Member Functions | |
| SIM_Geometry (const SIM_DataFactory *factory) | |
| virtual | ~SIM_Geometry () |
| virtual void | initializeSubclass () |
| Set initial values on all the geometry attributes. | |
| virtual void | makeEqualSubclass (const SIM_Data *source) |
| Makes this geometry equal to some other SIM_Geometry. | |
| virtual void | saveSubclass (ostream &os) const |
| Saves our attributes, and our internal data if it has been set. | |
| virtual bool | loadSubclass (UT_IStream &is) |
| Loads our attributes and internal data if it was set when we saved. | |
| virtual SIM_Query * | createQueryObjectSubclass () const |
| virtual void | interpolateSubclass (const SIM_Data *source1, const SIM_Data *source2, fpreal interp) |
| virtual int64 | getMemorySizeSubclass () const |
| virtual GU_ConstDetailHandle | getGeometrySubclass () const |
| virtual void | getTransformSubclass (UT_DMatrix4 &xform) const |
| void | setOwnGeometry (GU_Detail *gdp) |
| void | setOwnGeometry (const GU_DetailHandle &gdh) |
| GU_ConstDetailHandle | getOwnGeometry () const |
| Returns a const pointer to our internal geometry data, if it is set. | |
| GU_DetailHandle | getOwnGeometry () |
| Returns a pointer to our internal geometry data, if it is set. | |
| void | setOwnTransform (UT_DMatrix4 *xform) |
| const UT_DMatrix4 * | getOwnTransform () const |
| Returns a const pointer to our internal transform data, if it is set. | |
| UT_DMatrix4 * | getOwnTransform () |
| Returns a pointer to our internal transform data, if it is set. | |
Detailed Description
This is the definitions for the SIM_Geometry interface. It also provides a default implementation that returns an empty geometry and an identity transform. It also has the facility to hold its own geometry and transform as internal data. If set, these are saved and loaded automatically. But there is no way for anyone except subclasses to set these internal data. Thus they are really just a convenience when writing SIM_Geometry subcalsses.- Examples:
-
SIM/SIM_SolverHair.C, SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.
Definition at line 32 of file SIM_Geometry.h.
Constructor & Destructor Documentation
| SIM_Geometry::SIM_Geometry | ( | const SIM_DataFactory * | factory | ) | [explicit, protected] |
| virtual SIM_Geometry::~SIM_Geometry | ( | ) | [protected, virtual] |
Member Function Documentation
| virtual SIM_Query* SIM_Geometry::createQueryObjectSubclass | ( | ) | const [protected, virtual] |
Creates a query object specifically for geometry data to access the transforms associated with geometry data.
Reimplemented from SIM_Data.
| GU_ConstDetailHandle SIM_Geometry::getGeometry | ( | ) | const |
Method for accessing the geometry. If we have some internal geometry data, we return that. Otherwise this function calls getGeometrySubclass().
- Examples:
- SIM/SIM_SolverHair.C, and SIM/SNOW_Solver.C.
| virtual GU_ConstDetailHandle SIM_Geometry::getGeometrySubclass | ( | ) | const [protected, virtual] |
This function is called by getGeometry() to return the actual geometry data. The default implementation returns an empty geometry.
Reimplemented in HDK_Sample::SNOW_VoxelArray.
| virtual int64 SIM_Geometry::getMemorySizeSubclass | ( | ) | const [protected, virtual] |
Override this function to return an accurate representation of the amount of memory used by this piece of data. The size of subdata should not be included in this calculation.
Reimplemented from SIM_Data.
Reimplemented in SIM_PopGeometry, and HDK_Sample::SNOW_VoxelArray.
| GU_DetailHandle SIM_Geometry::getOwnGeometry | ( | ) | [protected] |
Returns a pointer to our internal geometry data, if it is set.
| GU_ConstDetailHandle SIM_Geometry::getOwnGeometry | ( | ) | const [protected] |
Returns a const pointer to our internal geometry data, if it is set.
| UT_DMatrix4* SIM_Geometry::getOwnTransform | ( | ) | [protected] |
Returns a pointer to our internal transform data, if it is set.
| const UT_DMatrix4* SIM_Geometry::getOwnTransform | ( | ) | const [protected] |
Returns a const pointer to our internal transform data, if it is set.
| SIM_Geometry::GETSET_DATA_FUNCS_S | ( | SIM_NAME_POSITIONPATH | , | |
| PositionPath | ||||
| ) |
Accesses the relative path to the position data associated with this geometry.
| void SIM_Geometry::getTransform | ( | UT_DMatrix4 & | xform | ) | const |
Get the geometry transform. If we have some internal transform data, we return that. Otherwise this function calls getTransformSubclass().
- Examples:
- SIM/SIM_SolverHair.C, and SIM/SNOW_Solver.C.
| virtual void SIM_Geometry::getTransformSubclass | ( | UT_DMatrix4 & | xform | ) | const [protected, virtual] |
This function is called by getTransform() to return the actual transform data. The default implementation returns an identity matrix.
| virtual void SIM_Geometry::initializeSubclass | ( | ) | [protected, virtual] |
Set initial values on all the geometry attributes.
Reimplemented from SIM_Data.
Reimplemented in SIM_GeometryCopy, SIM_PopGeometry, and HDK_Sample::SNOW_VoxelArray.
| virtual void SIM_Geometry::interpolateSubclass | ( | const SIM_Data * | source1, | |
| const SIM_Data * | source2, | |||
| fpreal | interp | |||
| ) | [protected, virtual] |
Create an interpolation between two other SIM_Geometry subclasses. This is one place where the internal data gets used automatically. Since the source data may be of any subclass, the only way to safely and correctly interpolate between two SIM_Geometry subclasses is to copy one of the source geometry and transform to our internal data, and then do a blend towards the second source data.
Reimplemented from SIM_Data.
Reimplemented in SIM_SopGeometry.
| virtual bool SIM_Geometry::loadSubclass | ( | UT_IStream & | is | ) | [protected, virtual] |
Loads our attributes and internal data if it was set when we saved.
Reimplemented from SIM_Data.
Reimplemented in SIM_PopGeometry, and HDK_Sample::SNOW_VoxelArray.
| virtual void SIM_Geometry::makeEqualSubclass | ( | const SIM_Data * | source | ) | [protected, virtual] |
Makes this geometry equal to some other SIM_Geometry.
Reimplemented from SIM_Data.
Reimplemented in SIM_GeometryCopy, SIM_PopGeometry, and HDK_Sample::SNOW_VoxelArray.
| virtual void SIM_Geometry::saveSubclass | ( | ostream & | os | ) | const [protected, virtual] |
Saves our attributes, and our internal data if it has been set.
Reimplemented from SIM_Data.
Reimplemented in HDK_Sample::SNOW_VoxelArray.
| void SIM_Geometry::setOwnGeometry | ( | const GU_DetailHandle & | gdh | ) | [protected] |
Set our internal geometry data from an existing GU_DetailHandle. If some internal data already exists, it is deleted.
| void SIM_Geometry::setOwnGeometry | ( | GU_Detail * | gdp | ) | [protected] |
Set our internal geometry data. If some internal data already exists, it is deleted. The pointer passed in becomes controlled by the SIM_Geometry so must not be deleted by external code. A null pointer can be passed in to clear our internal geometry data.
| void SIM_Geometry::setOwnTransform | ( | UT_DMatrix4 * | xform | ) | [protected] |
Set our internal transform data. If some internal data already exists, it is deleted. The pointer passed in becomes controlled by the SIM_Geometry so must not be deleted by external code. A null pointer can be passed in to clear our internal transform data.
The documentation for this class was generated from the following file:
- SIM/SIM_Geometry.h
