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

Parameters for creating a constraint coupling a node in a deformable actor to a node in another deformable actor. More...

#include <mochi_structs.h>

Inheritance diagram for superdex::DeformableNodeToDeformableNodeConstraintParams:
superdex::ConstraintParams superdex::prefab::DeformableNodeToDeformableNodeConstraintPrefab

Public Attributes

ActorHandle actorA {}
 Actor handle identifying deformable actor A.
ActorHandle actorB {}
 Actor handle identifying deformable actor B.
bool findClosest = false
 Whether to automatically select a boundary node on each actor.
int nodeIndexA = -1
 Node index in deformable actor A's reference simulation mesh, as returned by Actor::GetMesh.
int nodeIndexB = -1
 Node index in deformable actor B's reference simulation mesh, as returned by Actor::GetMesh.
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 constraint coupling a node in a deformable actor to a node in another deformable actor.

See also
Scene::CreateDeformableNodeToDeformableNodeConstraint, ConstraintType::DeformableNodeToDeformableNode

Definition at line 303 of file mochi_structs.h.

Member Data Documentation

◆ actorA

ActorHandle superdex::DeformableNodeToDeformableNodeConstraintParams::actorA {}

Actor handle identifying deformable actor A.

Definition at line 308 of file mochi_structs.h.

◆ actorB

ActorHandle superdex::DeformableNodeToDeformableNodeConstraintParams::actorB {}

Actor handle identifying deformable actor B.

Definition at line 310 of file mochi_structs.h.

◆ findClosest

bool superdex::DeformableNodeToDeformableNodeConstraintParams::findClosest = false

Whether to automatically select a boundary node on each actor.

Note
When true, selection is based on proximity to the world-space midpoint of the actors' root-frame origins and occurs at constraint creation using their undeformed reference simulation meshes. nodeIndexA and nodeIndexB are ignored.
When true, both actors must be soft actors (shell and rod actors are not supported).

Definition at line 312 of file mochi_structs.h.

◆ nodeIndexA

int superdex::DeformableNodeToDeformableNodeConstraintParams::nodeIndexA = -1

Node index in deformable actor A's reference simulation mesh, as returned by Actor::GetMesh.

Ignored if findClosest is true; otherwise it must identify a node in that mesh.

Definition at line 304 of file mochi_structs.h.

◆ nodeIndexB

int superdex::DeformableNodeToDeformableNodeConstraintParams::nodeIndexB = -1

Node index in deformable actor B's reference simulation mesh, as returned by Actor::GetMesh.

Ignored if findClosest is true; otherwise it must identify a node in that mesh.

Definition at line 306 of file mochi_structs.h.


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