Easy3D 2.6.1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
LocalConstraint Class Reference

An AxisPlaneConstraint defined in the Frame local coordinate system. More...

#include <easy3d/renderer/constraint.h>

Inheritance diagram for LocalConstraint:
AxisPlaneConstraint Constraint

Public Member Functions

 ~LocalConstraint () override=default
 
void constrainTranslation (vec3 &translation, Frame *const frame) override
 
void constrainRotation (quat &rotation, Frame *const frame) override
 
- Public Member Functions inherited from AxisPlaneConstraint
 AxisPlaneConstraint ()
 
 ~AxisPlaneConstraint () override=default
 
void setTranslationConstraint (Type type, const vec3 &direction)
 
void setTranslationConstraintType (Type type)
 
void setTranslationConstraintDirection (const vec3 &direction)
 
Type translationConstraintType () const
 
vec3 translationConstraintDirection () const
 
void setRotationConstraint (Type type, const vec3 &direction)
 
void setRotationConstraintType (Type type)
 
void setRotationConstraintDirection (const vec3 &direction)
 
Type rotationConstraintType () const
 
vec3 rotationConstraintDirection () const
 
- Public Member Functions inherited from Constraint
virtual ~Constraint ()=default
 

Additional Inherited Members

- Public Types inherited from AxisPlaneConstraint
enum  Type { FREE , AXIS , PLANE , FORBIDDEN }
 

Detailed Description

An AxisPlaneConstraint defined in the Frame local coordinate system.

The translationConstraintDirection() and rotationConstraintDirection() are expressed in the Frame local coordinate system (see Frame::referenceFrame()).

See the constrainedFrame example for an illustration.

Constructor & Destructor Documentation

◆ ~LocalConstraint()

~LocalConstraint ( )
overridedefault

Virtual destructor. Empty.

Member Function Documentation

◆ constrainRotation()

void constrainRotation ( quat & rotation,
Frame *const frame )
overridevirtual

When rotationConstraintType() is AxisPlaneConstraint::AXIS, constrain rotation to be a rotation around an axis whose direction is defined in the Frame local coordinate system by rotationConstraintDirection().

Reimplemented from AxisPlaneConstraint.

◆ constrainTranslation()

void constrainTranslation ( vec3 & translation,
Frame *const frame )
overridevirtual

Depending on translationConstraintType(), constrain translation to be along an axis or limited to a plane defined in the Frame local coordinate system by translationConstraintDirection().

Reimplemented from AxisPlaneConstraint.

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