UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAnimPhysConstraintSetup Struct Reference

#include <AnimNode_AnimDynamics.h>

Public Member Functions

 FAnimPhysConstraintSetup ()
 

Public Attributes

AnimPhysLinearConstraintType LinearXLimitType
 
AnimPhysLinearConstraintType LinearYLimitType
 
AnimPhysLinearConstraintType LinearZLimitType
 
bool bLinearFullyLocked
 
FVector LinearAxesMin
 
FVector LinearAxesMax
 
AnimPhysAngularConstraintType AngularConstraintType
 
AnimPhysTwistAxis TwistAxis
 
AnimPhysTwistAxis AngularTargetAxis
 
float ConeAngle
 
FVector AngularLimitsMin
 
FVector AngularLimitsMax
 
FVector AngularTarget
 

Detailed Description

Constraint setup struct, holds data required to build a physics constraint

Constructor & Destructor Documentation

◆ FAnimPhysConstraintSetup()

FAnimPhysConstraintSetup::FAnimPhysConstraintSetup ( )
inline

Member Data Documentation

◆ AngularConstraintType

AnimPhysAngularConstraintType FAnimPhysConstraintSetup::AngularConstraintType

Method to use when constraining angular motion

◆ AngularLimitsMax

FVector FAnimPhysConstraintSetup::AngularLimitsMax

◆ AngularLimitsMin

FVector FAnimPhysConstraintSetup::AngularLimitsMin

◆ AngularTarget

FVector FAnimPhysConstraintSetup::AngularTarget

The axis to align the angular spring constraint to in the animation pose. This typically points down the bone - so values of (1.0, 0.0, 0.0) are common, but you can pick other values to align the spring to a different direction. Note: This is affected by the Angular Spring Constant.

◆ AngularTargetAxis

AnimPhysTwistAxis FAnimPhysConstraintSetup::AngularTargetAxis

The axis in the simulation pose to align to the Angular Target. This is typically the axis pointing along the bone. Note: This is affected by the Angular Spring Constant.

◆ bLinearFullyLocked

bool FAnimPhysConstraintSetup::bLinearFullyLocked

If all axes are locked we can use 3 linear limits instead of the 6 needed for limited axes

◆ ConeAngle

float FAnimPhysConstraintSetup::ConeAngle

Angle to use when constraining using a cone

◆ LinearAxesMax

FVector FAnimPhysConstraintSetup::LinearAxesMax

Maximum linear movement per-axis (Set zero here and in the min limit to lock)

◆ LinearAxesMin

FVector FAnimPhysConstraintSetup::LinearAxesMin

Minimum linear movement per-axis (Set zero here and in the max limit to lock)

◆ LinearXLimitType

AnimPhysLinearConstraintType FAnimPhysConstraintSetup::LinearXLimitType

Whether to limit the linear X axis

◆ LinearYLimitType

AnimPhysLinearConstraintType FAnimPhysConstraintSetup::LinearYLimitType

Whether to limit the linear Y axis

◆ LinearZLimitType

AnimPhysLinearConstraintType FAnimPhysConstraintSetup::LinearZLimitType

Whether to limit the linear Z axis

◆ TwistAxis

AnimPhysTwistAxis FAnimPhysConstraintSetup::TwistAxis

Axis to consider for twist when constraining angular motion (forward axis)


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