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

#include <SIM_Relationship.h>

+ Inheritance diagram for SIM_Relationship:

Public Member Functions

SIM_DatagetRelationshipTypeData ()
 Returns the single subdata that defines the relationship type. More...
 
const SIM_DatagetConstRelationshipTypeData () const
 Returns the single const subdata that defines the relationship type. More...
 
void setGroup (const SIM_ObjectArray &objects)
 Sets the object group equal to the set of supplied objects. More...
 
void setGroup (SIM_Object *object)
 Sets the object group to contain only the single specified object. More...
 
void addGroup (const SIM_ObjectArray &objects)
 Adds a number of objects to the object group. More...
 
void addGroup (SIM_Object *object)
 Adds a single object to the object group. More...
 
void removeGroup (const SIM_ObjectArray &objects)
 Removes a number of objects from the object group. More...
 
void removeGroup (SIM_Object *object)
 Removes a single object from the object group. More...
 
void clearGroup ()
 Removes all objects from the object group. More...
 
int getGroupEntries () const
 Gets the number of objects in the object group. More...
 
const SIM_ObjectgetGroupObject (int index) const
 Gets the object at position index within the object group. More...
 
bool getGroupHasObject (const SIM_Object *object) const
 Tests whether the supplied object is in the object group. More...
 
void setAffGroup (const SIM_ObjectArray &objects)
 Sets the affector group equal to the set of supplied objects. More...
 
void setAffGroup (SIM_Object *object)
 Sets the affector group to contain only the single specified object. More...
 
void addAffGroup (const SIM_ObjectArray &objects)
 Adds a number of objects to the affector group. More...
 
void addAffGroup (SIM_Object *object)
 Adds a single object to the affector group. More...
 
void removeAffGroup (const SIM_ObjectArray &objects)
 Removes a number of objects from the affector group. More...
 
void removeAffGroup (SIM_Object *object)
 Removes a single object from the affector group. More...
 
void clearAffGroup ()
 Removes all objects from the affector group. More...
 
int getAffGroupEntries () const
 Gets the number of objects in the affector group. More...
 
const SIM_ObjectgetAffGroupObject (int index) const
 Gets the object at position index within the affector group. More...
 
bool getAffGroupHasObject (const SIM_Object *object) const
 Tests whether the supplied object is in the affector group. More...
 
- Public Member Functions inherited from SIM_RootData
const UT_StringgetName () const
 
bool getMatchesString (const char *pattern) const
 
void getRootDataId (SIM_RootDataId &id) const
 Fills out the root data identifier by calling getRootDataIdSubclass(). More...
 
void appendFullDataPath (const SIM_Data *subdata, bool useobjectid, UT_String &datapath) 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_Relationship (const SIM_SimulationState *factory)
 
virtual ~SIM_Relationship ()
 
virtual void initializeSubclass ()
 Clears all attached objects. More...
 
virtual void makeEqualSubclass (const SIM_Data *source)
 
virtual void saveSubclass (std::ostream &os) const
 
virtual bool loadSubclass (UT_IStream &is)
 Loads a relationship from a stream. More...
 
virtual SIM_QuerycreateQueryObjectSubclass () const
 Creates a query object specific to SIM_Relationship. More...
 
virtual int64 getMemorySizeSubclass () const
 Returns the memory usage of our group data. More...
 
virtual bool getMatchesStringSubclass (const char *pattern) const
 Override the SIM_RootData function for matching us to a string. More...
 
virtual void getRootDataIdSubclass (SIM_RootDataId &id) const
 Override the SIM_RootData function for getting our identifier. More...
 
- Protected Member Functions inherited from SIM_RootData
 SIM_RootData (const SIM_DataFactory *factory)
 
virtual ~SIM_RootData ()
 
- 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 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
 

Friends

class SIM_SimulationState
 
class SIM_Object
 

Additional Inherited Members

- Static Public Member Functions inherited from SIM_RootData
static void forceValidRootDataName (UT_String &rootdataname)
 
- 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 &)
 
- Protected Attributes inherited from SIM_RootData
UT_String myName
 

Detailed Description

This class defines a relationship between two groups of objects. The first group of objects, called simply the "group", is the set of objects that are modified or controlled by the relationship. The second group of objects, the "affector group", is the set of objects that control the "group" objects. Note that these sets of objects can overlap in any way. It is also possible to have a relationship without any affector group. A DOP Object Group is an example of this kind of affector-less relationship. Mutual affector relationships occur when one or more objects are in both the object group and the affector group. This also implies a self-affecting relationship.

This data type is not meant to be subclassed, and does not contain any information about the nature or meaning of the relationship. That semantic information is held in the subdata of the SIM_Relationship. Only one subdata can be attached to this data at a time, and it must be a subclass of SIM_RelationshipData. Any other kind or number of subdata are ignored and invalidate the relationship.

Any data that refers to other data should be implemented as a SIM_Relationship. Doing so avoids problems of having to lookup objects based on name, enforces proper solve order (so affector objects are always solved before the group objects), and allows reverse lookups (what objects are in a relationship, and what relationships refer to a particular object).

Like SIM_Objects, SIM_Relationships are created and controlled by a SIM_SimulationState. They cannot be created and attached as subdata on existing data. Unlike SIM_Objects, SIM_Relationships do not have a unique integer identifier. Relationships must be given unique names.

Examples:
DOP/DOP_GroupAndApply.C.

Definition at line 48 of file SIM_Relationship.h.

Constructor & Destructor Documentation

SIM_Relationship::SIM_Relationship ( const SIM_SimulationState factory)
protected
virtual SIM_Relationship::~SIM_Relationship ( )
protectedvirtual

Member Function Documentation

void SIM_Relationship::addAffGroup ( const SIM_ObjectArray objects)

Adds a number of objects to the affector group.

void SIM_Relationship::addAffGroup ( SIM_Object object)

Adds a single object to the affector group.

void SIM_Relationship::addGroup ( const SIM_ObjectArray objects)

Adds a number of objects to the object group.

Examples:
DOP/DOP_GroupAndApply.C.
void SIM_Relationship::addGroup ( SIM_Object object)

Adds a single object to the object group.

void SIM_Relationship::clearAffGroup ( )

Removes all objects from the affector group.

void SIM_Relationship::clearGroup ( )

Removes all objects from the object group.

virtual SIM_Query* SIM_Relationship::createQueryObjectSubclass ( ) const
protectedvirtual

Creates a query object specific to SIM_Relationship.

Reimplemented from SIM_Data.

int SIM_Relationship::getAffGroupEntries ( ) const

Gets the number of objects in the affector group.

bool SIM_Relationship::getAffGroupHasObject ( const SIM_Object object) const

Tests whether the supplied object is in the affector group.

const SIM_Object* SIM_Relationship::getAffGroupObject ( int  index) const

Gets the object at position index within the affector group.

const SIM_Data* SIM_Relationship::getConstRelationshipTypeData ( ) const

Returns the single const subdata that defines the relationship type.

int SIM_Relationship::getGroupEntries ( ) const

Gets the number of objects in the object group.

bool SIM_Relationship::getGroupHasObject ( const SIM_Object object) const

Tests whether the supplied object is in the object group.

const SIM_Object* SIM_Relationship::getGroupObject ( int  index) const

Gets the object at position index within the object group.

virtual bool SIM_Relationship::getMatchesStringSubclass ( const char *  pattern) const
protectedvirtual

Override the SIM_RootData function for matching us to a string.

Implements SIM_RootData.

virtual int64 SIM_Relationship::getMemorySizeSubclass ( ) const
protectedvirtual

Returns the memory usage of our group data.

Reimplemented from SIM_Data.

SIM_Data* SIM_Relationship::getRelationshipTypeData ( )

Returns the single subdata that defines the relationship type.

virtual void SIM_Relationship::getRootDataIdSubclass ( SIM_RootDataId id) const
protectedvirtual

Override the SIM_RootData function for getting our identifier.

Implements SIM_RootData.

virtual void SIM_Relationship::initializeSubclass ( )
protectedvirtual

Clears all attached objects.

Reimplemented from SIM_Data.

virtual bool SIM_Relationship::loadSubclass ( UT_IStream is)
protectedvirtual

Loads a relationship from a stream.

Reimplemented from SIM_Data.

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

Makes the relationship groups equal, but doesn't set the relationship name, which must be kept unique.

Reimplemented from SIM_Data.

void SIM_Relationship::removeAffGroup ( const SIM_ObjectArray objects)

Removes a number of objects from the affector group.

void SIM_Relationship::removeAffGroup ( SIM_Object object)

Removes a single object from the affector group.

void SIM_Relationship::removeGroup ( const SIM_ObjectArray objects)

Removes a number of objects from the object group.

void SIM_Relationship::removeGroup ( SIM_Object object)

Removes a single object from the object group.

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

Saves a relationship to a stream. The object groups are saved to the stream as arrays of object id numbers.

Reimplemented from SIM_Data.

void SIM_Relationship::setAffGroup ( const SIM_ObjectArray objects)

Sets the affector group equal to the set of supplied objects.

void SIM_Relationship::setAffGroup ( SIM_Object object)

Sets the affector group to contain only the single specified object.

void SIM_Relationship::setGroup ( const SIM_ObjectArray objects)

Sets the object group equal to the set of supplied objects.

void SIM_Relationship::setGroup ( SIM_Object object)

Sets the object group to contain only the single specified object.

Friends And Related Function Documentation

friend class SIM_Object
friend

Definition at line 139 of file SIM_Relationship.h.

friend class SIM_SimulationState
friend

Definition at line 138 of file SIM_Relationship.h.


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