1. Epic GamesDeveloper
  3. FTransformConstraintUtils

FTransformConstraintUtils

TransformConstraintUtils

API > API/Runtime > API/Runtime/Constraints

References

   
Module Constraints
Header /Engine/Source/Runtime/Experimental/Animation/Constraints/Public/TransformConstraint.h
Include #include "TransformConstraint.h"

Syntax

struct FTransformConstraintUtils

Remarks

TransformConstraintUtils

Functions

  Type Name Description
Public function Static bool

AddConstraint ( UWorld* InWorld,
UTransformableHandle* InParentHandle,
UTransformableHandle* InChildHandle,
UTickableTransformConstraint* Constraint,
const bool bMaintainOffset,
const bool bUseDefault
)

 Registers a new transform constraint within the constraints manager.
Public function Static bool

BuildDependencies ( UWorld* InWorld,
UTickableTransformConstraint* Constraint
)

 Ensure default dependencies between constraints.
Public function Static FTransform

ComputeRelativeTransform ( const FTransform& InChildLocal,
const FTransform& InChildWorld,
const FTransform& InSpaceWorld,
const UTickableTransformConstraint* InConstraint
)

 Computes the relative transform between both transform based on the constraint's InType.
Public function Static UTickableTransformConstraint *

CreateAndAddFromObjects ( UWorld* InWorld,
UObject* InParent,
const FName& InParentSocketName,
UObject* InChild,
const FName& InChildSocketName,
const ETransformConstraintType InType,
const bool bMaintainOffset,
const bool bUseDefault
)

 Creates respective handles and creates a new InType transform constraint.
Public function Static UTickableTransformConstraint *

CreateFromType ( UWorld* InWorld,
const ETransformConstraintType InType,
const bool bUseDefault
)

 Creates a new transform constraint based on the InType.
Public function Static UTransformableComponentHandle *

CreateHandleForSceneComponent ( USceneComponent* InSceneComponent,
const FName& InSocketName
)

 Create a handle for the scene component.
Public function Static void

GetChildrenConstraints ( UWorld* World,
const UTickableTransformConstraint* InConstraint,
TArray< TWeakObjectPtr< UTickableConstraint > >& OutConstraints,
const bool bIncludeTarget
)

 Fills a constraint array that InConstraint->ChildHandle is the parent of.
Public function Static TOptional< FTransform >

GetConstraintsRelativeTransform ( const TArray< TWeakObjectPtr< UTickableConstraint > >& InConstraints,
const FTransform& InChildLocal,
const FTransform& InChildWorld
)

  
Public function Static int32

GetLastActiveConstraintIndex ( const TArray< TWeakObjectPtr< UTickableConstraint > >& InConstraints
)

 Get the last active constraint that has dynamic offset.
Public function Static void

GetParentConstraints ( UWorld* World,
const AActor* InChild,
TArray< TWeakObjectPtr< UTickableConstraint > >& OutConstraints
)

 Fills a sorted constraint array that InChild actor is the child of.
Public function Static TOptional< FTransform >

GetRelativeTransform ( UWorld* InWorld,
const uint32 InHandleHash
)

 Computes the current constraint space local transform.
Public function Static void

UpdateTransformBasedOnConstraint ( FTransform& CurrentTransform,
USceneComponent* SceneComponent
)

 Adjust the transform on a scene component so it's effected by the constraint

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page