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

Prefab parameters for a RigidPrismaticJointConstraintParams. More...

#include <mochi_prefab.h>

Inheritance diagram for superdex::prefab::RigidPrismaticJointConstraintPrefab:
superdex::RigidPrismaticJointConstraintParams 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::RigidPrismaticJointConstraintParams
ActorHandle actorA {}
 Actor handle identifying rigid actor A.
ActorHandle actorB {}
 Actor handle identifying rigid actor B.
Real3 freeAxis {}
 Axis of free translation, specified in the world frame at constraint creation time.
std::optional< realmax {}
 Maximum translation [m] relative to rest position.
std::optional< realmin {}
 Minimum translation [m] relative to rest position.
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 RigidPrismaticJointConstraintParams.

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 181 of file mochi_prefab.h.

Member Data Documentation

◆ actorNameA

DynamicString superdex::prefab::RigidPrismaticJointConstraintPrefab::actorNameA {}

Name or hierarchy path identifying rigid actor A.

Definition at line 182 of file mochi_prefab.h.

◆ actorNameB

DynamicString superdex::prefab::RigidPrismaticJointConstraintPrefab::actorNameB {}

Name or hierarchy path identifying rigid actor B.

Definition at line 183 of file mochi_prefab.h.


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