FRigUnit_SpawnDynamicsConstraint

Spawns a new dynamics constraint component.

API > API/Plugins > API/Plugins/ControlRigDynamics

Spawns a new dynamics constraint component. Note: This node only runs as part of the construction event.

   
Name FRigUnit_SpawnDynamicsConstraint
Type struct
Header File /Engine/Plugins/Experimental/ControlRigDynamics/Source/ControlRigDynamics/Public/RigDynamicsConstraintExecution.h
Include Path #include "RigDynamicsConstraintExecution.h"

Syntax

USTRUCT (  
        Meta=(DisplayName="Spawn Dynamics Constraint", Keywords="Add,Construction,Create,New,Rod,Distance", Varying))  
struct FRigUnit_SpawnDynamicsConstraint : public FRigUnit_DynamicsBaseMutable

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAccelerationMode bool For soft constraints: When true, Strength is a mass-independent natural frequency. RigDynamicsConstraintExecution.h
  • Meta=(Input, EditCondition="ConstraintType != ERigParticleSimulationConstraintType::Hard")
ChildComponentKey FRigComponentKey The child particle for the constraint. RigDynamicsConstraintExecution.h
  • Meta=(Input)
ConstraintComponentName FName The name to give the new constraint component. RigDynamicsConstraintExecution.h
  • Meta=(Input)
ConstraintType ERigParticleSimulationConstraintType If the constraint is marked as "hard", then the system will try as hard as possible to enforce it. RigDynamicsConstraintExecution.h
  • Meta=(Input)
DampingRatio float DampingRatio for the constraint. RigDynamicsConstraintExecution.h
  • Meta=(Input, ClampMin="0.0", EditCondition="ConstraintType != ERigParticleSimulationConstraintType::Hard")
DynamicsConstraintComponentKey FRigComponentKey The Dynamics Constraint component key that was created. RigDynamicsConstraintExecution.h
  • Meta=(Output, DisplayName="Constraint Component Key")
DynamicsSolverComponentKey FRigComponentKey Optional solver - if set, it will be added to this solver component. RigDynamicsConstraintExecution.h
  • Meta=(Input, DisplayName="Solver Component Key")
ExtraDamping float Additional damping for the constraint. RigDynamicsConstraintExecution.h
  • Meta=(Input, ClampMin="0.0", EditCondition="ConstraintType != ERigParticleSimulationConstraintType::Hard", Units="Hertz")
ExtraLength float This will be added on to the target length after the automatic/multiplication. RigDynamicsConstraintExecution.h
  • Meta=(Input)
LengthMultiplier float The target length will be calculated automatically, multiplied by this. RigDynamicsConstraintExecution.h
  • Meta=(Input, ClampMin="0.0")
Owner FRigElementKey The owner of the newly created component (must be set/valid) RigDynamicsConstraintExecution.h
  • Meta=(Input, BoneName)
ParentComponentKey FRigComponentKey The parent particle for the constraint. RigDynamicsConstraintExecution.h
  • Meta=(Input)
Strength float The strength which we drive towards the target length. RigDynamicsConstraintExecution.h
  • Meta=(Input, ClampMin="0.0", EditCondition="ConstraintType != ERigParticleSimulationConstraintType::Hard", Units="Hertz")

Functions

Public

Name Remarks Include Path Unreal Specifiers

RIGVM_METHOD()

   RigDynamicsConstraintExecution.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page