UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FAimConstraintDescription Struct Reference

#include <Constraint.h>

+ Inheritance diagram for FAimConstraintDescription:

Public Member Functions

 FAimConstraintDescription ()
 
virtual ANIMATIONCORE_API void AccumulateConstraintTransform (const FTransform &TargetTransform, const FTransform &CurrentTransform, const FTransform &CurrentParentTransform, float Weight, FMultiTransformBlendHelper &BlendHelperInLocalSpace) const override
 
virtual bool DoesAffectRotation () const override
 
virtual FString GetDisplayString () const override
 
virtual void Serialize (FArchive &Ar) override
 
- Public Member Functions inherited from FConstraintDescriptionEx
virtual ~FConstraintDescriptionEx ()
 
virtual bool DoesAffectTranslation () const
 
virtual bool DoesAffectScale () const
 
virtual bool DoesAffectTransform () const
 
virtual FString return TEXT ("None")
 

Public Attributes

FAxis LookAt_Axis
 
FAxis LookUp_Axis
 
bool bUseLookUp
 
FVector LookUpTarget
 
- Public Attributes inherited from FConstraintDescriptionEx
FFilterOptionPerAxis AxesFilterOption
 

Detailed Description

A description of how to apply aim constraint

Constructor & Destructor Documentation

◆ FAimConstraintDescription()

FAimConstraintDescription::FAimConstraintDescription ( )
inline

Member Function Documentation

◆ AccumulateConstraintTransform()

void FAimConstraintDescription::AccumulateConstraintTransform ( const FTransform &  TargetTransform,
const FTransform &  CurrentTransform,
const FTransform &  CurrentParentTransform,
float  Weight,
FMultiTransformBlendHelper &  BlendHelperInLocalSpace 
) const
overridevirtual

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 from FConstraintDescriptionEx.

◆ DoesAffectRotation()

virtual bool FAimConstraintDescription::DoesAffectRotation ( ) const
inlineoverridevirtual

Functions that describes what they modify

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

Reimplemented from FConstraintDescriptionEx.

◆ GetDisplayString()

virtual FString FAimConstraintDescription::GetDisplayString ( ) const
inlineoverridevirtual

Reimplemented from FConstraintDescriptionEx.

◆ Serialize()

virtual void FAimConstraintDescription::Serialize ( FArchive &  Ar)
inlineoverridevirtual

Serializer

Reimplemented from FConstraintDescriptionEx.

Member Data Documentation

◆ bUseLookUp

bool FAimConstraintDescription::bUseLookUp

◆ LookAt_Axis

FAxis FAimConstraintDescription::LookAt_Axis

◆ LookUp_Axis

FAxis FAimConstraintDescription::LookUp_Axis

◆ LookUpTarget

FVector FAimConstraintDescription::LookUpTarget
The documentation for this struct was generated from the following files: