SIM_ConRel Class Reference
#include <SIM_ConRel.h>
Public Member Functions | |
| SIM_ConRel * | getSubConRel () |
| const SIM_ConRel * | getConstSubConRel () const |
| void | makeStateTransition (const SIM_Time &time) |
| void | setStateForce (fpreal force) |
| Functions to get and set state information. | |
| 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. | |
| 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 |
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 (ostream &os) const |
| virtual bool | loadSubclass (UT_IStream &is) |
| virtual SIM_Query * | createQueryObjectSubclass () const |
| virtual SIM_ConRel * | getSubConRelSubclass () |
| virtual const SIM_ConRel * | getConstSubConRelSubclass () 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 |
| virtual void | buildConRelGuideSpatial (const GU_DetailHandle &gdh, const SIM_Options &options, const UT_Vector3 &anchorPos1, const UT_Vector3 &anchorPos2) const |
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 39 of file SIM_ConRel.h.
Constructor & Destructor Documentation
| SIM_ConRel::SIM_ConRel | ( | const SIM_DataFactory * | factory | ) | [explicit, protected] |
| virtual SIM_ConRel::~SIM_ConRel | ( | ) | [protected, virtual] |
Member Function Documentation
| 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 [protected, virtual] |
| virtual void SIM_ConRel::buildConRelGuideSpatial | ( | const GU_DetailHandle & | gdh, | |
| const SIM_Options & | options, | |||
| const UT_Vector3 & | anchorPos1, | |||
| const UT_Vector3 & | anchorPos2 | |||
| ) | const [protected, virtual] |
Reimplemented in SIM_ConRelNone, and SIM_ConRelSpring.
| virtual SIM_Query* SIM_ConRel::createQueryObjectSubclass | ( | ) | const [protected, virtual] |
| 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 [protected, virtual] |
Reimplemented in SIM_ConRelTwoState.
| fpreal SIM_ConRel::getStateDistance | ( | ) | const |
| virtual fpreal SIM_ConRel::getStateDistanceSubclass | ( | ) | const [protected, virtual] |
Reimplemented in SIM_ConRelNone, SIM_ConRelSpring, and SIM_ConRelTwoState.
| SIM_ConRelError SIM_ConRel::getStateErrorCode | ( | ) | const |
| fpreal SIM_ConRel::getStateForce | ( | ) | const |
| virtual fpreal SIM_ConRel::getStateForceSubclass | ( | ) | const [protected, virtual] |
Reimplemented in SIM_ConRelHard, SIM_ConRelSpring, and SIM_ConRelTwoState.
| SIM_ConRel* SIM_ConRel::getSubConRel | ( | ) |
| virtual SIM_ConRel* SIM_ConRel::getSubConRelSubclass | ( | ) | [protected, virtual] |
Reimplemented in SIM_ConRelTwoState.
| virtual void SIM_ConRel::initializeSubclass | ( | ) | [protected, virtual] |
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 | ) | [protected, virtual] |
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 | ) | [protected, virtual] |
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 | ) | [protected, virtual] |
Reimplemented in SIM_ConRelTwoState.
| virtual void SIM_ConRel::saveSubclass | ( | ostream & | os | ) | const [protected, virtual] |
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 | ) | [protected, virtual] |
Reimplemented in SIM_ConRelNone, and SIM_ConRelSpring.
| 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 | ) | [protected, virtual] |
Reimplemented in SIM_ConRelHard, and SIM_ConRelSpring.
The documentation for this class was generated from the following file:
- SIM/SIM_ConRel.h
