FAnimPhys::ConstrainAlongDirection

Constrain bodies along a provided axis

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/Animation/AnimPhysicsSolver.h

Include

#include "Animation/AnimPhysicsSolver.h"

Source

/Engine/Source/Runtime/Engine/Private/Animation/AnimPhysicsSolver.cpp

Syntax

static void ConstrainAlongDirection
(
    float DeltaTime,
    TArray< FAnimPhysLinearLimit > & LimitContainer,
    FAnimPhysRigidBody * FirstBody,
    const FVector & FirstPosition,
    FAnimPhysRigidBody * SecondBody,
    const FVector & SecondPosition,
    const FVector & AxisToConstrain,
    const FVector2D Limits,
    float MinimumForce,
    float MaximumForce
)

Remarks

Constrain bodies along a provided axis

Parameters

Parameter

Description

LimitContainer

Container to add limits to

FirstBody

First body in constraint (or nullptr for world)

FirstPosition

Local position on first body to apply constraint

SecondBody

Second body in constraint

SecondPosition

Local position on second body to apply constraint

AxisToConstrain

Axis to constrain between bodies

Limits

Limit on the provided axis so that Limits.X(min) < Final Position < Limits.Y(max)

MinimumForce

Minimum force that can be applied to satisfy the maximum limit (default -MAX_flt)

MaximumForce

Maximum force that can be applied to satisfy the minimum limit (default MAX_flt)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss