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

#include <SIM_ConRel.h>

+ Inheritance diagram for SIM_ConRel:

Classes

class  ConRelData
 

Public Member Functions

SIM_ConRelgetSubConRel ()
 
const SIM_ConRelgetConstSubConRel () const
 
void makeStateTransition (const SIM_Time &time)
 
void setStateForce (fpreal force)
 Functions to get and set state information. More...
 
fpreal getStateForce () const
 
void setStateDistance (fpreal distance)
 
fpreal getStateDistance () const
 
void setStateErrorCode (SIM_ConRelError errorcode)
 A constraint is invalid if its parameters cannot be resolved. More...
 
SIM_ConRelError getStateErrorCode () const
 
void buildConRelGuideGeometry (const GU_DetailHandle &gdh, const SIM_Time &time, const SIM_Relationship &rel, const SIM_ConAnchor &anchor1, const SIM_ConAnchor &anchor2) const
 
virtual void buildConRelGuide (const GU_DetailHandle &gdh, const SIM_Options &options, const UT_Vector3 &anchor_pos_1, const UT_Vector3 &anchor_pos_2, const UT_Quaternion &anchor_rot_1, const UT_Quaternion &anchor_rot_2, const ConRelData &c_data) 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...
 

Protected Member Functions

 SIM_ConRel (const SIM_DataFactory *factory)
 
virtual ~SIM_ConRel ()
 
virtual void initializeSubclass ()
 
virtual void makeEqualSubclass (const SIM_Data *source)
 
virtual void saveSubclass (std::ostream &os) const
 
virtual bool loadSubclass (UT_IStream &is)
 
virtual SIM_QuerycreateQueryObjectSubclass () const
 
virtual SIM_ConRelgetSubConRelSubclass ()
 
virtual const SIM_ConRelgetConstSubConRelSubclass () const
 
virtual void makeStateTransitionSubclass (const SIM_Time &time)
 
virtual void setStateForceSubclass (fpreal force)
 
virtual fpreal getStateForceSubclass () const
 
virtual void setStateDistanceSubclass (fpreal distance)
 
virtual fpreal getStateDistanceSubclass () const
 
virtual void buildConRelGuideGeometrySubclass (const GU_DetailHandle &gdh, const SIM_Time &time, const SIM_Relationship &rel, const SIM_ConAnchor &anchor1, const SIM_ConAnchor &anchor2) const
 
- 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 saveIOSubclass (std::ostream &os, SIM_DataThreadedIO *io) const
 
virtual bool loadIOSubclass (UT_IStream &is, SIM_DataThreadedIO *io)
 
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 void interpolateSubclass (const SIM_Data *source1, const SIM_Data *source2, fpreal interp)
 
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
 

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

Definition of the relationship between the anchors in a constraint - i.e., how a constraint affects its anchors.

Also contains state information - the force applied to enforce the constraint, and the distance separating the anchors. This can be very useful for switching relationships in response to the constraint's performance.

Definition at line 35 of file SIM_ConRel.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual void SIM_ConRel::buildConRelGuide ( const GU_DetailHandle gdh,
const SIM_Options options,
const UT_Vector3 anchor_pos_1,
const UT_Vector3 anchor_pos_2,
const UT_Quaternion anchor_rot_1,
const UT_Quaternion anchor_rot_2,
const ConRelData c_data 
) const
virtual
void SIM_ConRel::buildConRelGuideGeometry ( const GU_DetailHandle gdh,
const SIM_Time time,
const SIM_Relationship rel,
const SIM_ConAnchor anchor1,
const SIM_ConAnchor anchor2 
) const

Build guide geometry for the conrel, and also get the anchors to build their own guide geometry.

virtual void SIM_ConRel::buildConRelGuideGeometrySubclass ( const GU_DetailHandle gdh,
const SIM_Time time,
const SIM_Relationship rel,
const SIM_ConAnchor anchor1,
const SIM_ConAnchor anchor2 
) const
protectedvirtual
virtual SIM_Query* SIM_ConRel::createQueryObjectSubclass ( ) const
protectedvirtual

Override this method to create a custom SIM_Query for this class. By creating a custom SIM_Query, it is possible to customize the expression function interface to the data.

Reimplemented from SIM_Data.

const SIM_ConRel* SIM_ConRel::getConstSubConRel ( ) const

Be careful using the const version. It should really only be used when SIM_Constraint is generating guide geometry.

virtual const SIM_ConRel* SIM_ConRel::getConstSubConRelSubclass ( ) const
protectedvirtual

Reimplemented in SIM_ConRelTwoState.

fpreal SIM_ConRel::getStateDistance ( ) const
virtual fpreal SIM_ConRel::getStateDistanceSubclass ( ) const
protectedvirtual
SIM_ConRelError SIM_ConRel::getStateErrorCode ( ) const
fpreal SIM_ConRel::getStateForce ( ) const
virtual fpreal SIM_ConRel::getStateForceSubclass ( ) const
protectedvirtual
SIM_ConRel* SIM_ConRel::getSubConRel ( )
virtual SIM_ConRel* SIM_ConRel::getSubConRelSubclass ( )
protectedvirtual

Reimplemented in SIM_ConRelTwoState.

virtual void SIM_ConRel::initializeSubclass ( )
protectedvirtual

Override this method to set this data to its default empty state. Remember to call the base class implementation. The default implementation clears all subdata, and if the data is a subclass of SIM_OptionsUser, calls initializeFromParmDefaults().

Reimplemented from SIM_Data.

virtual bool SIM_ConRel::loadSubclass ( UT_IStream is)
protectedvirtual

Override this method to read in subclass-specific data. Remember to call the base class implementation.

Reimplemented from SIM_Data.

virtual void SIM_ConRel::makeEqualSubclass ( const SIM_Data source)
protectedvirtual

Override this method to set subclass data equal to the source data. The source parameter at this level is guaranteed to be non-null. Remember to call the base class implementation.

Reimplemented from SIM_Data.

void SIM_ConRel::makeStateTransition ( const SIM_Time time)
virtual void SIM_ConRel::makeStateTransitionSubclass ( const SIM_Time time)
protectedvirtual

Reimplemented in SIM_ConRelTwoState.

virtual void SIM_ConRel::saveSubclass ( std::ostream &  os) const
protectedvirtual

Override this method to write out subclass-specific data. Remember to call the base class implementation.

Reimplemented from SIM_Data.

void SIM_ConRel::setStateDistance ( fpreal  distance)
virtual void SIM_ConRel::setStateDistanceSubclass ( fpreal  distance)
protectedvirtual
void SIM_ConRel::setStateErrorCode ( SIM_ConRelError  errorcode)

A constraint is invalid if its parameters cannot be resolved.

void SIM_ConRel::setStateForce ( fpreal  force)

Functions to get and set state information.

virtual void SIM_ConRel::setStateForceSubclass ( fpreal  force)
protectedvirtual

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