SuperDex Physics C++ API
Loading...
Searching...
No Matches
superdex::prefab::JointRotationRangeConstraintPrefab Struct Reference

Prefab parameters for a JointRotationRangeConstraintParams. More...

#include <mochi_prefab.h>

Inheritance diagram for superdex::prefab::JointRotationRangeConstraintPrefab:
superdex::JointRotationRangeConstraintParams superdex::ConstraintParams

Public Attributes

DynamicString actorNameA {}
 Name or hierarchy path identifying rigid actor A.
DynamicString actorNameB {}
 Name or hierarchy path identifying rigid actor B.
Public Attributes inherited from superdex::JointRotationRangeConstraintParams
ActorHandle actorA {}
 Actor handle identifying rigid actor A.
ActorHandle actorB {}
 Actor handle identifying rigid actor B.
Real2 angleRangeX = kMinus2PiPlus2Pi
 Allowed range [min, max] [rad] for the X component of the relative rotation vector (axis-angle), expressed in the joint reference frame.
Real2 angleRangeY = kMinus2PiPlus2Pi
 Allowed range [min, max] [rad] for the Y component of the relative rotation vector (axis-angle), expressed in the joint reference frame.
Real2 angleRangeZ = kMinus2PiPlus2Pi
 Allowed range [min, max] [rad] for the Z component of the relative rotation vector (axis-angle), expressed in the joint reference frame.
bool rangeAroundRest = true
 When true, angle limits are relative to the actors' relative rotation at constraint creation time.
Real3 refFrameRotVec {}
 Joint reference frame specified as a rotation vector [rad] with respect to world frame.
Public Attributes inherited from superdex::ConstraintParams
real damping = 0_r
 Constraint damping coefficient.
real saturation = -1_r
 Saturation distance [m] or angle [rad].
real stiffness = 1e6_r
 Constraint stiffness coefficient.

Additional Inherited Members

Public Member Functions inherited from superdex::ConstraintParams
bool operator== (ConstraintParams const &) const =default

Detailed Description

Prefab parameters for a JointRotationRangeConstraintParams.

Note
Actor name fields use the same naming convention as PoseControllerPrefab. "myActor" refers to an actor in this prefab. "myPrefab/myActor" refers to an actor in a nested prefab.
A referenced actor name must identify exactly one existing actor. Actor names need not be unique, but referencing a name shared by more than one actor, or a name that matches no actor, is invalid and rejected at AddToScene.

Definition at line 197 of file mochi_prefab.h.

Member Data Documentation

◆ actorNameA

DynamicString superdex::prefab::JointRotationRangeConstraintPrefab::actorNameA {}

Name or hierarchy path identifying rigid actor A.

Definition at line 198 of file mochi_prefab.h.

◆ actorNameB

DynamicString superdex::prefab::JointRotationRangeConstraintPrefab::actorNameB {}

Name or hierarchy path identifying rigid actor B.

Definition at line 199 of file mochi_prefab.h.


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