VRS::Constraint Class Reference
#include <vrs/sg/constraint.h>
Inheritance diagram for VRS::Constraint:
Public Member Functions | |
| Constraint () | |
| virtual | ~Constraint () |
| Destructor. | |
| virtual bool | check (const Vector &oldPoint, const Vector &desiredPoint, Stack< Vector > *alternativesStack=NULL)=0 |
| virtual void | setEnabledState (bool enabled) |
| Enables / Disables the constraint. | |
| virtual bool | isEnabled () const |
| Returns true if the constraint is enabled. | |
| VRS_TYPEINFO (Constraint, SharedObj) | |
| VRS_SERIALIZABLE_ABSTRACT_CLASS (Constraint) | |
Detailed Description
Abstract base class for constraints. A constraint evaluates wheater a movement from one point to another point is valid.Constructor & Destructor Documentation
| VRS::Constraint::Constraint | ( | ) |
Constructor for constraints.
| virtual VRS::Constraint::~Constraint | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual bool VRS::Constraint::check | ( | const Vector & | oldPoint, | |
| const Vector & | desiredPoint, | |||
| Stack< Vector > * | alternativesStack = NULL | |||
| ) | [pure virtual] |
Evaluates whether a movement from oldPoint to desiredPoint is valid. Returns true if the movement was validated by this constraint. Returns false if the movement was refused. If an alternatives stack was passed, alternative destination points are computed and pushed onto the stack. Derived classes must implement the checking algorithm in this method.
Implemented in VRS::ConstraintMaxDistance, and VRS::ConstraintMinHeight.
| virtual void VRS::Constraint::setEnabledState | ( | bool | enabled | ) | [virtual] |
Enables / Disables the constraint.
| virtual bool VRS::Constraint::isEnabled | ( | ) | const [virtual] |
Returns true if the constraint is enabled.
| VRS::Constraint::VRS_TYPEINFO | ( | Constraint | , | |
| SharedObj | ||||
| ) |
| VRS::Constraint::VRS_SERIALIZABLE_ABSTRACT_CLASS | ( | Constraint | ) |
The documentation for this class was generated from the following file: