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

Parameters for creating a position constraint on a rigid actor's pivot point. More...

#include <mochi_structs.h>

Inheritance diagram for superdex::RigidPivotPositionConstraintParams:
superdex::ConstraintParams superdex::prefab::RigidPivotPositionConstraintPrefab

Public Attributes

ActorHandle actor {}
 Actor handle identifying the rigid actor.
Real3 localPosition {}
 Pivot point in rigid actor's local frame [m].
Real3 targetPosition {}
 Target position in world frame [m].
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 position constraint on a rigid actor's pivot point.

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

See also
Scene::CreateRigidPivotPositionConstraint, ConstraintType::RigidPivotPosition

Definition at line 355 of file mochi_structs.h.

Member Data Documentation

◆ actor

ActorHandle superdex::RigidPivotPositionConstraintParams::actor {}

Actor handle identifying the rigid actor.

Definition at line 360 of file mochi_structs.h.

◆ localPosition

Real3 superdex::RigidPivotPositionConstraintParams::localPosition {}

Pivot point in rigid actor's local frame [m].

Definition at line 358 of file mochi_structs.h.

◆ targetPosition

Real3 superdex::RigidPivotPositionConstraintParams::targetPosition {}

Target position in world frame [m].

Definition at line 356 of file mochi_structs.h.


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