FTransformConstraintDescription Struct Reference

#include <Constraint.h>

Inheritance diagram for FTransformConstraintDescription:

Public Member Functions
	FTransformConstraintDescription (const ETransformConstraintType InType=ETransformConstraintType::Translation)
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 bool	DoesAffectTranslation () const override
virtual bool	DoesAffectScale () const override
virtual bool	DoesAffectTransform () const override
virtual FString	GetDisplayString () const override
virtual void	Serialize (FArchive &Ar) override
Public Member Functions inherited from FConstraintDescriptionEx
virtual	~FConstraintDescriptionEx ()
virtual FString return	TEXT ("None")

Public Attributes
ETransformConstraintType	TransformType
Public Attributes inherited from FConstraintDescriptionEx
FFilterOptionPerAxis	AxesFilterOption

Detailed Description

A description of how to apply a simple transform constraint

Constructor & Destructor Documentation

FTransformConstraintDescription()

FTransformConstraintDescription::FTransformConstraintDescription ( const ETransformConstraintType  InType = ETransformConstraintType::Translation )

inline

Member Function Documentation

AccumulateConstraintTransform()

void FTransformConstraintDescription::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

Target	Transform: Current Target Transform in global space
Current	Transform: Current Source Transform in global space
Current	Parent 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 FTransformConstraintDescription::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.

DoesAffectScale()

virtual bool FTransformConstraintDescription::DoesAffectScale ( ) const

inlineoverridevirtual

Reimplemented from FConstraintDescriptionEx.

DoesAffectTransform()

virtual bool FTransformConstraintDescription::DoesAffectTransform ( ) const

inlineoverridevirtual

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

DoesAffectTranslation()

virtual bool FTransformConstraintDescription::DoesAffectTranslation ( ) const

inlineoverridevirtual

Reimplemented from FConstraintDescriptionEx.

GetDisplayString()

virtual FString FTransformConstraintDescription::GetDisplayString ( ) const

inlineoverridevirtual

Reimplemented from FConstraintDescriptionEx.

Serialize()

virtual void FTransformConstraintDescription::Serialize ( FArchive &  Ar )

inlineoverridevirtual

Serializer

Reimplemented from FConstraintDescriptionEx.

Member Data Documentation

TransformType

ETransformConstraintType FTransformConstraintDescription::TransformType

---

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

• Engine/Source/Runtime/AnimationCore/Public/Constraint.h
• Engine/Source/Runtime/AnimationCore/Private/Constraint.cpp