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

#include <SIM_PositionSimple.h>

+ Inheritance diagram for SIM_PositionSimple:

Public Member Functions

 GETSET_DATA_FUNCS_V3 (SIM_NAME_POSITION, Position)
 Control the translation attribute of the position. More...
 
 GETSET_DATA_FUNCS_V3 (SIM_NAME_PIVOT, Pivot)
 Control the pivot point which the orientation is applied to. More...
 
 GETSET_DATA_FUNCS_Q (SIM_NAME_ORIENTATION, Orientation)
 Control the orientation attribute of the position. More...
 
- Public Member Functions inherited from SIM_Position
void getTransform (UT_DMatrix4 &xform) const
 
void getInverseTransform (UT_DMatrix4 &xform) const
 
void getOrientation (UT_Quaternion &q) const
 
void getPosition (UT_Vector3 &t) const
 
void getPivot (UT_Vector3 &p) const
 
UT_Vector3 selfToWorld (const UT_Vector3 &p) const
 
UT_Vector3 worldToSelf (const UT_Vector3 &p) const
 
UT_Vector3 selfToWorldVector (const UT_Vector3 &p) const
 
UT_Vector3 worldToSelfVector (const UT_Vector3 &p) const
 
- Public Member Functions inherited from SIM_Data
const UT_StringgetDataType () const
 
void initialize (const SIM_SubdataBehavior &subdatabehavior)
 
void makeEqual (const SIM_Data *source, const SIM_SubdataBehavior &subdatabehavior)
 
void setParameters (const SIM_Options &parms)
 
void interpolate (const SIM_Data *source1, const SIM_Data *source2, fpreal interp)
 
int64 getMemorySize () const
 
bool getIsAlternateRepresentation () const
 
bool saveToFile (const char *filename, UT_CompressionType compressionType) const
 
bool saveToStream (std::ostream &os, UT_CompressionType compressionType) const
 
bool loadFromFile (const char *filename)
 
bool loadFromStream (UT_IStream &is, bool skiptype=false)
 
bool getIsOfType (const char *datatype) const
 
const voidgetConstPointerToType (const char *datatype) const
 
voidgetPointerToType (const char *datatype)
 
int getNumSubData () const
 Get the number of sub-data items attached to this data. More...
 
const char * getSubDataName (int index) const
 Get the name of the sub-data at a particular index location. More...
 
int getSubDataIndex (const SIM_Data *subdata) const
 
bool buildSubDataPath (const SIM_Data *subdata, UT_String &pathto) const
 
const SIM_QuerygetQueryObject () const
 
long getGuideParmVersion () const
 
void addGuideDep (DEP_MicroNode &src) const
 
virtual bool getGuideGeometryList (const SIM_RootData &root, const char *datapath, const SIM_Time &t, UT_Array< GU_ConstDetailHandle > &detailArray, UT_Array< UT_DMatrix4 > &xformArray) const
 
GU_ConstDetailHandle getGuideGeometry (const SIM_RootData &root, const char *datapath, UT_DMatrix4 &xform, const SIM_Time &t) const
 
void buildGuideOptions (SIM_Options &options, const SIM_Time &time) const
 
SIM_DatagetSubData (int index)
 
const SIM_DatagetConstSubData (int index) const
 
SIM_DatagetNamedSubData (const char *dataname)
 
const SIM_DatagetConstNamedSubData (const char *dataname) const
 
void filterSubData (SIM_DataArray &ncdp, UT_StringArray *names, const SIM_DataFilter &ncfilter, const char *startfrom, const SIM_DataFilter &recursefilter)
 
void filterConstSubData (SIM_ConstDataArray &dp, UT_StringArray *names, const SIM_DataFilter &filter, const char *startfrom, const SIM_DataFilter &recurseFilter) const
 
SIM_DatagetNthSubData (UT_String *name, const SIM_DataFilter &filter, int n, const char *startfrom, const SIM_DataFilter &recurseFilter)
 
const SIM_DatagetNthConstSubData (UT_String *name, const SIM_DataFilter &filter, int n, const char *startfrom, const SIM_DataFilter &recurseFilter) const
 
void forEachSubData (SIM_EachDataCallback &cb, const SIM_DataFilter &filter, const char *startfrom, const SIM_DataFilter &recurseFilter)
 
void forEachConstSubData (SIM_EachDataCallback &cb, const SIM_DataFilter &filter, const char *startfrom, const SIM_DataFilter &recurseFilter) const
 
SIM_DatacreateNamedSubData (const char *dataname, const char *datatype, int creationflags, UT_String *newdatanameptr=NULL)
 
SIM_DatagetOrCreateAlternateRepresentation (const char *dataname, const char *datatype) const
 
void interpolateSubData (const SIM_Data &source1, const SIM_Data &source2, fpreal interp, const SIM_DataFilter &interpdata, const SIM_DataFilter &recurse)
 
void setNamedSubData (const char *dataname, const SIM_Data *data, int setflags)
 
void createUniqueSubDataName (const SIM_Data *subdata, UT_String &dataname) const
 
void removeNamedSubData (const char *dataname)
 Remove some existing sub-data by name. More...
 
void removeSubData (int index)
 Remove some existing sub-data by index. More...
 
void moveNamedSubData (const char *oldname, const char *newname)
 
const UT_GuidgetUniqueId () const
 
long getReferenceCount () const
 
int getCreatorId () const
 Get the ID of the node that created this data. More...
 
OP_NodegetCreatorNode () const
 Use the creator ID to look up the OP_Node that created this data. More...
 
OP_NodegetOwnerNetwork () const
 Look up the owner node of our engine to get the DOP Network pointer. More...
 
const SIM_EnginegetEngine () const
 Get the engine that created us (from our data factory). More...
 
int getCreatorIndex () const
 Get the output index of the creator node that generated this data. More...
 
const SIM_TimegetCreationTime () const
 Get the creation time for this data. More...
 
bool getIsSelected () const
 Get the selected flag for this data. More...
 
void setIsSelected (bool selected) const
 
bool getSelectionRepresentsObject () const
 
void copyCreationInfoFrom (const SIM_Data *source)
 
OP_NodegetNodePathsRelativeTo () const
 
OP_NodegetOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return an OBJ_Node. More...
 
OBJ_NodegetOBJNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return an OBJ_Node. More...
 
SOP_NodegetSOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a SOP_Node. More...
 
POP_NodegetPOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a POP_Node. More...
 
DOP_NodegetDOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a DOP_Node. More...
 
COP2_NodegetCOP2Node (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a COP2_Node. More...
 
CHOP_NodegetCHOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a CHOP_Node. More...
 
void addOPInterest (OP_Node *node) const
 Adds an interest in the specified node to our engine's owner node. More...
 
void addError (const SIM_RootData *root, int errorcode, const char *errorparm, UT_ErrorSeverity severity) const
 Adds an error to our SIM_Engine. More...
 
- Public Member Functions inherited from SIM_OptionsUser
 SIM_OptionsUser (SIM_Data *owner)
 
virtual ~SIM_OptionsUser ()
 
void optionChanged (const char *name)
 
const SIM_OptionsgetOptions () const
 

Protected Member Functions

 SIM_PositionSimple (const SIM_DataFactory *factory)
 
virtual ~SIM_PositionSimple ()
 
virtual void optionChangedSubclass (const char *name)
 
virtual void getTransformSubclass (UT_DMatrix4 &xform) const
 Gets a transform matrix from our position and rotation data. More...
 
virtual void getInverseTransformSubclass (UT_DMatrix4 &xform) const
 
virtual void getOrientationSubclass (UT_Quaternion &q) const
 Gets a rotation matrix from our position data. More...
 
virtual void getPositionSubclass (UT_Vector3 &t) const
 Gets a translation vector from our position data. More...
 
virtual void getPivotSubclass (UT_Vector3 &p) const
 Gets pivot info from our position data. More...
 
virtual UT_Vector3 selfToWorldSubclass (const UT_Vector3 &p) const
 
virtual UT_Vector3 worldToSelfSubclass (const UT_Vector3 &p) const
 
virtual UT_Vector3 selfToWorldVectorSubclass (const UT_Vector3 &p) const
 
virtual UT_Vector3 worldToSelfVectorSubclass (const UT_Vector3 &p) const
 
virtual void interpolateSubclass (const SIM_Data *source1, const SIM_Data *source2, fpreal interp)
 
- Protected Member Functions inherited from SIM_Position
 SIM_Position (const SIM_DataFactory *factory)
 
virtual ~SIM_Position ()
 
- Protected Member Functions inherited from SIM_Data
 SIM_Data (const SIM_DataFactory *factory)
 
virtual ~SIM_Data ()
 
void handleModification (int code=-1)
 
void setNeedsToRecalculateMemorySize () const
 
void deleteQueryObjectIfNotBuilding () const
 Deletes the query object for this data, if there is one. More...
 
void deleteGuideObjectIfNotBuilding () const
 Delete the guide geometry for this data, if it exists. More...
 
void initAlternateRepresentation () const
 
void setNeedsInitialization (bool needsinit) const
 Flags an alternate representation subdata as requiring initialization. More...
 
bool getNeedsInitialization () const
 Tests whether an alternate representation requires initialization. More...
 
bool saveOptionPacket (std::ostream &os, const char *name, const SIM_Options *opts) const
 
bool loadOptionPacket (UT_IStream &is, const char *name, SIM_Options *opts) const
 
bool getIsDoingSimplifiedSaveLoad () const
 
void initializeFromParmDefaults ()
 
void setSelectionRepresentsObject (bool representsobject)
 
virtual void setNeedsInitializationSubclass (bool needsinit) const
 
virtual void initializeSubclass ()
 
virtual void makeEqualSubclass (const SIM_Data *source)
 
virtual void saveSubclass (std::ostream &os) const
 
virtual void saveIOSubclass (std::ostream &os, SIM_DataThreadedIO *io) const
 
virtual bool loadSubclass (UT_IStream &is)
 
virtual bool loadIOSubclass (UT_IStream &is, SIM_DataThreadedIO *io)
 
virtual SIM_QuerycreateQueryObjectSubclass () const
 
virtual long getGuideParmVersionSubclass () const
 
virtual SIM_GuidecreateGuideObjectSubclass () const
 
virtual void buildGuideGeometrySubclass (const SIM_RootData &root, const SIM_Options &options, const GU_DetailHandle &gdh, UT_DMatrix4 *xform, const SIM_Time &t) const
 
virtual void setParametersSubclass (const SIM_Options &parms)
 
virtual void setNamedSubDataSubclass (const char *dataname, const SIM_Data *data)
 
virtual void removeNamedSubDataSubclass (const char *dataname)
 
virtual int64 getMemorySizeSubclass () const
 
virtual void handleModificationSubclass (int code)
 
virtual bool getIsAlternateRepresentationSubclass () const
 
virtual void initAlternateRepresentationSubclass (const SIM_Data &)
 
virtual voidgetCastToType (const char *datatype) const
 
virtual const UT_StringgetDataTypeSubclass () const
 
const SIM_DatagetAlternateRepresentationOf () const
 
- Protected Member Functions inherited from SIM_OptionsUser
SIM_OptionsgetOptions ()
 

Additional Inherited Members

- Static Public Member Functions inherited from SIM_Data
static bool getDataTypeFromFile (const char *filename, UT_String &datatype)
 
static bool getDataTypeFromStream (UT_IStream &is, UT_String &datatype)
 
static const voidcastConstPointerToType (const SIM_Data *data, const char *datatype)
 
static voidcastPointerToType (SIM_Data *data, const char *datatype)
 
- Static Protected Member Functions inherited from SIM_Data
static const PRM_TemplategetEmptyTemplateList ()
 
static const SIM_DopDescriptiongetEmptyDopDescription ()
 A DOP description that says not to create an automatic DOP. More...
 
static void getDataTypeSuperclasses (UT_StringArray &)
 

Detailed Description

This is the simplest implementation for standard positional data. Positional data is not exactly the same as a transform in that it does not permit scales, and the rotation is always applied before the translation.

Definition at line 19 of file SIM_PositionSimple.h.

Constructor & Destructor Documentation

SIM_PositionSimple::SIM_PositionSimple ( const SIM_DataFactory factory)
explicitprotected
virtual SIM_PositionSimple::~SIM_PositionSimple ( )
protectedvirtual

Member Function Documentation

virtual void SIM_PositionSimple::getInverseTransformSubclass ( UT_DMatrix4 xform) const
protectedvirtual

Gets the inverse transform matrix from our position and rotation. Because we build our transform matrices just in time, this is faster than getTransform() & invert().

Reimplemented from SIM_Position.

virtual void SIM_PositionSimple::getOrientationSubclass ( UT_Quaternion q) const
protectedvirtual

Gets a rotation matrix from our position data.

Reimplemented from SIM_Position.

virtual void SIM_PositionSimple::getPivotSubclass ( UT_Vector3 p) const
protectedvirtual

Gets pivot info from our position data.

Reimplemented from SIM_Position.

virtual void SIM_PositionSimple::getPositionSubclass ( UT_Vector3 t) const
protectedvirtual

Gets a translation vector from our position data.

Reimplemented from SIM_Position.

SIM_PositionSimple::GETSET_DATA_FUNCS_Q ( SIM_NAME_ORIENTATION  ,
Orientation   
)

Control the orientation attribute of the position.

SIM_PositionSimple::GETSET_DATA_FUNCS_V3 ( SIM_NAME_POSITION  ,
Position   
)

Control the translation attribute of the position.

TODO: These accessors are shadowing the SIM_Position versions. This is a bad thing as getPivot() will not invoke getPivotSubclass and anyone trying to chase the call graph will see an apparent infinite loop. We need to rename these to RawPosition, I think.

SIM_PositionSimple::GETSET_DATA_FUNCS_V3 ( SIM_NAME_PIVOT  ,
Pivot   
)

Control the pivot point which the orientation is applied to.

virtual void SIM_PositionSimple::getTransformSubclass ( UT_DMatrix4 xform) const
protectedvirtual

Gets a transform matrix from our position and rotation data.

Reimplemented from SIM_Position.

virtual void SIM_PositionSimple::interpolateSubclass ( const SIM_Data source1,
const SIM_Data source2,
fpreal  interp 
)
protectedvirtual

Interpolation of positions can't be done in a componentwise fashion. If pivot is changing over time it is important that we adjust the rotation/translation to account for it.

Reimplemented from SIM_Data.

virtual void SIM_PositionSimple::optionChangedSubclass ( const char *  name)
protectedvirtual

Override this function so that we can understand an option called rotation. Although this attribute isn't supported directly, it can be reinterpreted into the orientation option.

Reimplemented from SIM_OptionsUser.

Reimplemented in RBD_State.

virtual UT_Vector3 SIM_PositionSimple::selfToWorldSubclass ( const UT_Vector3 p) const
protectedvirtual

Transforms a point into worldspace from object space. This is the same as multiplying by getTransform()

Reimplemented from SIM_Position.

virtual UT_Vector3 SIM_PositionSimple::selfToWorldVectorSubclass ( const UT_Vector3 p) const
protectedvirtual

Transforms a vector into worldspace from object space. This is the same as multiplying by getTransform()

Reimplemented from SIM_Position.

virtual UT_Vector3 SIM_PositionSimple::worldToSelfSubclass ( const UT_Vector3 p) const
protectedvirtual

Transforms a point into object space from world space. This is the same as multiplying by getInverseTransform()

Reimplemented from SIM_Position.

virtual UT_Vector3 SIM_PositionSimple::worldToSelfVectorSubclass ( const UT_Vector3 p) const
protectedvirtual

Transforms a vector into object space from world space. This is the same as multiplying by getInverseTransform()

Reimplemented from SIM_Position.


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