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

#include <Constraint.h>

+ Inheritance diagram for FConstraintDescriptionEx:

Public Member Functions

virtual ~FConstraintDescriptionEx ()
 
virtual void AccumulateConstraintTransform (const FTransform &TargetTransform, const FTransform &CurrentTransform, const FTransform &CurrentParentTransform, float Weight, FMultiTransformBlendHelper &BlendHelperInLocalSpace) const PURE_VIRTUAL(AccumulateConstraintTransform
 
virtual void virtual bool DoesAffectRotation () const
 
virtual bool DoesAffectTranslation () const
 
virtual bool DoesAffectScale () const
 
virtual bool DoesAffectTransform () const
 
virtual FString GetDisplayString () const PURE_VIRTUAL(GetDisplayString
 
virtual FString return TEXT ("None")
 
virtual void Serialize (FArchive &Ar)
 

Public Attributes

FFilterOptionPerAxis AxesFilterOption
 

Friends

FArchiveoperator<< (FArchive &Ar, FConstraintDescriptionEx &D)
 

Detailed Description

A description of how to apply a simple transform constraint

Constructor & Destructor Documentation

◆ ~FConstraintDescriptionEx()

virtual FConstraintDescriptionEx::~FConstraintDescriptionEx ( )
inlinevirtual

Member Function Documentation

◆ AccumulateConstraintTransform()

virtual void FConstraintDescriptionEx::AccumulateConstraintTransform ( const FTransform TargetTransform,
const FTransform CurrentTransform,
const FTransform CurrentParentTransform,
float  Weight,
FMultiTransformBlendHelper BlendHelperInLocalSpace 
) const
virtual

Apply Constraint : Apply Constraint transform to BlendHelperInLocalSpace in local space

Parameters
TargetTransform: Current Target Transform in global space
CurrentTransform: Current Source Transform in global space
CurrentParent Transform: Current Source Parent Transform in global space
Weight: Current Weight
BlendHelperInLocalSpace: Blend Helper, this accumulates all constraints transform and later on blend to final transform
Returns
BlendHelperInLocalSpace will contains constraint's local transform result, it is local because that's how you want to compose multiple to one transform at the end

Reimplemented in FTransformConstraintDescription, and FAimConstraintDescription.

◆ DoesAffectRotation()

virtual void virtual bool FConstraintDescriptionEx::DoesAffectRotation ( ) const
inlinevirtual

Functions that describes what they modify

Since same component will be blended by weight correctly, this has to split to each component

Reimplemented in FTransformConstraintDescription, and FAimConstraintDescription.

◆ DoesAffectScale()

virtual bool FConstraintDescriptionEx::DoesAffectScale ( ) const
inlinevirtual

◆ DoesAffectTransform()

virtual bool FConstraintDescriptionEx::DoesAffectTransform ( ) const
inlinevirtual

Functions that describes what they modify - this means, whole Transform, so combined transform, not individual component This will override any individual component if returning true

Reimplemented in FTransformConstraintDescription.

◆ DoesAffectTranslation()

virtual bool FConstraintDescriptionEx::DoesAffectTranslation ( ) const
inlinevirtual

◆ GetDisplayString()

virtual FString FConstraintDescriptionEx::GetDisplayString ( ) const
virtual

◆ Serialize()

virtual void FConstraintDescriptionEx::Serialize ( FArchive Ar)
inlinevirtual

◆ TEXT()

virtual FString return FConstraintDescriptionEx::TEXT ( "None"  )

Friends And Related Symbol Documentation

◆ operator<<

FArchive & operator<< ( FArchive Ar,
FConstraintDescriptionEx D 
)
friend

Member Data Documentation

◆ AxesFilterOption

FFilterOptionPerAxis FConstraintDescriptionEx::AxesFilterOption

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