UE::TransformConstraintUtil Namespace Reference

Namespaces
namespace	Private

Classes
struct	FConstraintsInteractionCache

Functions
UTransformableComponentHandle *	CreateHandleForSceneComponent (USceneComponent *InSceneComponent, const FName &InSocketName)
void	GetParentConstraints (UWorld *InWorld, const AActor *InChild, TArray< TWeakObjectPtr< UTickableConstraint > > &OutConstraints)
UTickableTransformConstraint *	CreateFromType (UWorld *InWorld, const ETransformConstraintType InType, const bool bUseDefault)
UTickableTransformConstraint *	CreateAndAddFromObjects (UWorld *InWorld, UObject *InParent, const FName &InParentSocketName, UObject *InChild, const FName &InChildSocketName, const ETransformConstraintType InType, const bool bMaintainOffset, const bool bUseDefault, const TFunction< void()> &InValidDependencyFunction)
bool	AddConstraint (UWorld *InWorld, UTransformableHandle *InParentHandle, UTransformableHandle *InChildHandle, UTickableTransformConstraint *InNewConstraint, const bool bMaintainOffset, const bool bUseDefault)
void	UpdateTransformBasedOnConstraint (FTransform &InOutCurrentTransform, const USceneComponent *InSceneComponent)
FTransform	ComputeRelativeTransform (const FTransform &InChildLocal, const FTransform &InChildWorld, const FTransform &InSpaceWorld, const UTickableTransformConstraint *InConstraint)
TOptional< FTransform >	GetRelativeTransform (UWorld *InWorld, const uint32 InHandleHash)
TOptional< FTransform >	GetConstraintsRelativeTransform (const TArray< TWeakObjectPtr< UTickableConstraint > > &InConstraints, const FTransform &InChildLocal, const FTransform &InChildWorld)
int32	GetLastActiveConstraintIndex (const TArray< TWeakObjectPtr< UTickableConstraint > > &InConstraints)
void	GetChildrenConstraints (UWorld *World, const UTickableTransformConstraint *InConstraint, TArray< TWeakObjectPtr< UTickableConstraint > > &OutConstraints, const bool bIncludeTarget)
UTickableTransformConstraint *	GetConfig (const UClass *InConstraintClass)

Function Documentation

AddConstraint()

CONSTRAINTS_API bool UE::TransformConstraintUtil::AddConstraint	(	UWorld *	InWorld,
		UTransformableHandle *	InParentHandle,
		UTransformableHandle *	InChildHandle,
		UTickableTransformConstraint *	Constraint,
		const bool	bMaintainOffset = true,
		const bool	bUseDefault = false
	)

Registers a new transform constraint within the constraints manager.

ComputeRelativeTransform()

CONSTRAINTS_API FTransform UE::TransformConstraintUtil::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.

CreateAndAddFromObjects()

CONSTRAINTS_API UTickableTransformConstraint * UE::TransformConstraintUtil::CreateAndAddFromObjects	(	UWorld *	InWorld,
		UObject *	InParent,
		const FName &	InParentSocketName,
		UObject *	InChild,
		const FName &	InChildSocketName,
		const ETransformConstraintType	InType,
		const bool	bMaintainOffset = true,
		const bool	bUseDefault = false,
		const TFunction< void()> &	InValidDependencyFunction = nullptr
	)

Creates respective handles and creates a new InType transform constraint.

CreateFromType()

CONSTRAINTS_API UTickableTransformConstraint * UE::TransformConstraintUtil::CreateFromType	(	UWorld *	InWorld,
		const ETransformConstraintType	InType,
		const bool	bUseDefault = false
	)

Creates a new transform constraint based on the InType.

CreateHandleForSceneComponent()

CONSTRAINTS_API UTransformableComponentHandle * UE::TransformConstraintUtil::CreateHandleForSceneComponent	(	USceneComponent *	InSceneComponent,
		const FName &	InSocketName
	)

Create a handle for the scene component.

GetChildrenConstraints()

CONSTRAINTS_API void UE::TransformConstraintUtil::GetChildrenConstraints	(	UWorld *	World,
		const UTickableTransformConstraint *	InConstraint,
		TArray< TWeakObjectPtr< UTickableConstraint > > &	OutConstraints,
		const bool	bIncludeTarget = false
	)

Fills a constraint array that InConstraint->ChildHandle is the parent of. If bIncludeTarget is true, we also get the other constraints that act on the same target.

GetConfig()

CONSTRAINTS_API UTickableTransformConstraint * UE::TransformConstraintUtil::GetConfig

(

const UClass *

InConstraintClass

)

Returns the configuration constraint instance for a specific constraint class if it exists

GetConstraintsRelativeTransform()

CONSTRAINTS_API TOptional< FTransform > UE::TransformConstraintUtil::GetConstraintsRelativeTransform	(	const TArray< TWeakObjectPtr< UTickableConstraint > > &	InConstraints,
		const FTransform &	InChildLocal,
		const FTransform &	InChildWorld
	)

GetLastActiveConstraintIndex()

CONSTRAINTS_API int32 UE::TransformConstraintUtil::GetLastActiveConstraintIndex

(

const TArray< TWeakObjectPtr< UTickableConstraint > > &

InConstraints

)

Get the last active constraint that has dynamic offset.

GetParentConstraints()

CONSTRAINTS_API void UE::TransformConstraintUtil::GetParentConstraints	(	UWorld *	World,
		const AActor *	InChild,
		TArray< TWeakObjectPtr< UTickableConstraint > > &	OutConstraints
	)

Fills a sorted constraint array that InChild actor is the child of.

GetRelativeTransform()

CONSTRAINTS_API TOptional< FTransform > UE::TransformConstraintUtil::GetRelativeTransform	(	UWorld *	InWorld,
		const uint32	InHandleHash
	)

Computes the current constraint space local transform.

UpdateTransformBasedOnConstraint()

CONSTRAINTS_API void UE::TransformConstraintUtil::UpdateTransformBasedOnConstraint	(	FTransform &	InOutCurrentTransform,
		const USceneComponent *	InSceneComponent
	)

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