SIM_Constraint Class Reference

#include <SIM_Constraint.h>

Inheritance diagram for SIM_Constraint:

SIM_RelationshipData SIM_Data

List of all members.

Public Member Functions

void initConstraint (const SIM_Relationship *relationship)
SIM_ConRelgetConRel ()
const SIM_ConAnchorgetAnchor (int index) const

Protected Member Functions

 SIM_Constraint (const SIM_DataFactory *factory)
virtual ~SIM_Constraint ()
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

Friends

class SIM_ConstraintIterator


Detailed Description

The intention of this class is to act as a flexible container for constraint data. The individual components of the container (the relationship, the anchors, etc.) can each be switched at need, without affecting the other components.

Definition at line 28 of file SIM_Constraint.h.


Constructor & Destructor Documentation

SIM_Constraint::SIM_Constraint ( const SIM_DataFactory factory  )  [explicit, protected]

virtual SIM_Constraint::~SIM_Constraint (  )  [protected, virtual]


Member Function Documentation

virtual void SIM_Constraint::buildGuideGeometrySubclass ( const SIM_RootData root,
const SIM_Options options,
const GU_DetailHandle gdh,
UT_DMatrix4 xform,
const SIM_Time t 
) const [protected, virtual]

Override this function to create custom guide geometry for this class. This method should add geometry to the gdp (if supplied), not alter anything that is already there. The xform will always default to an identity matrix. The gdp pointer or the xform pointer may be null, in which case the other should still be calculated.

Reimplemented from SIM_Data.

virtual SIM_Guide* SIM_Constraint::createGuideObjectSubclass (  )  const [protected, virtual]

Override this to create a custom SIM_Guide subclass. The SIM_Guide class controls how requests for guide geometry are translated into actual geometry creation.

Reimplemented from SIM_Data.

const SIM_ConAnchor* SIM_Constraint::getAnchor ( int  index  )  const

SIM_ConRel* SIM_Constraint::getConRel (  ) 

virtual long SIM_Constraint::getGuideParmVersionSubclass (  )  const [protected, virtual]

Override this if the guide geometry for this data depends on parameters on nodes other than our creator node. Otherwise the guide geometry won't refresh when changing those parameters.

Reimplemented from SIM_Data.

void SIM_Constraint::initConstraint ( const SIM_Relationship relationship  ) 


Friends And Related Function Documentation

friend class SIM_ConstraintIterator [friend]

Definition at line 54 of file SIM_Constraint.h.


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

Generated on Fri May 25 00:10:39 2012 for HDK by  doxygen 1.5.9