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

Parameters for creating a rotation constraint on a rigid actor's pivot frame. More...

#include <mochi_structs.h>

Inheritance diagram for superdex::RigidPivotRotationConstraintParams:
superdex::ConstraintParams superdex::prefab::RigidPivotRotationConstraintPrefab

Public Attributes

ActorHandle actor {}
 Actor handle identifying the rigid actor.
Real3 localRotation {}
 Pivot frame in rigid actor's local coordinates, as a rotation vector [rad].
Real3 targetRotation {}
 Target rotation in world coordinates, as a rotation vector [rad].
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

Parameters for creating a rotation constraint on a rigid actor's pivot frame.

Couples a frame on a rigid actor (expressed in the actor's local coordinates and referred to as "pivot") to a specific target rotation in world coordinates.

See also
Scene::CreateRigidPivotRotationConstraint, ConstraintType::RigidPivotRotation

Definition at line 371 of file mochi_structs.h.

Member Data Documentation

◆ actor

ActorHandle superdex::RigidPivotRotationConstraintParams::actor {}

Actor handle identifying the rigid actor.

Definition at line 376 of file mochi_structs.h.

◆ localRotation

Real3 superdex::RigidPivotRotationConstraintParams::localRotation {}

Pivot frame in rigid actor's local coordinates, as a rotation vector [rad].

Definition at line 374 of file mochi_structs.h.

◆ targetRotation

Real3 superdex::RigidPivotRotationConstraintParams::targetRotation {}

Target rotation in world coordinates, as a rotation vector [rad].

Definition at line 372 of file mochi_structs.h.


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