Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FCSPose

Light Theme

Dark Theme

FCSPose

Choose your operating system:

Windows

macOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/BonePose.h
Include	#include "BonePose.h"

Syntax

template<class PoseType>
struct FCSPose

Variables

		Name	Description
	TCustomBoneInde...	BoneMask	Cached bone mask array to avoid reallocations.
	TArray< FCompac...	BonesToConvert	Cached conversion array for this pose, to save on allocations each frame.
	TCustomBoneInde...	ComponentSpaceFlags	Flags to track each bones current state (0 means local pose, 1 means component space pose)
	PoseType	Pose

Functions

		Name	Description
	void	CalculateComponentSpaceTransform ( BoneIndexType BoneIndex )	Calculate the component space transform for the supplied bone.
	void	ConvertBoneToLocalSpace ( BoneIndexType BoneIndex )	Convert Bone to Local Space.
	void	ConvertComponentPosesToLocalPoses ( const FCSPose< PoseType >& InPose, PoseType& OutPose )	This function convert component space to local space to OutPose
	void	ConvertComponentPosesToLocalPoses ( FCSPose< PoseType >&& InPose, PoseType& OutPose )	This function convert component space to local space to OutPose
	void	ConvertComponentPosesToLocalPosesSafe ( FCSPose< PoseType >& InPose, PoseType& OutPose )	This function convert component space to local space to OutPose
	void	CopyAndAssignBoneContainer ( FBoneContainer& NewBoneContainer )
	void	CopyPose ( const OtherPoseType& SrcPose )	Copy Pose.
	void	Empty()
	const TCusto...	GetComponentSpaceFlags()
	const FTrans...	GetComponentSpaceTransform ( BoneIndexType BoneIndex )	Get Transform for supplied bone in component space.
	FTransform	GetLocalSpaceTransform ( BoneIndexType BoneIndex )	Get transform for supplied bone in local space.
	const PoseTy...	GetPose()
	void	InitPose ( const PoseType& SrcPose )	Init Pose.
	void	InitPose ( const FBoneContainer* InBoneCo... )	Init Pose.
	void	InitPose ( PoseType&& SrcPose )
	void	LocalBlendCSBoneTransforms ( const TArray< struct FBoneTransform..., float Alpha )	Blends Component Space transforms to MeshPose in Local Space.
	void	SafeSetCSBoneTransforms ( const TArray< struct FBoneTransform... )	Set a bunch of Component Space Bone Transforms.
	void	SetComponentSpaceTransform ( BoneIndexType BoneIndex, const FTransform& NewTransform )	Set the transform for the supplied bone.

Typedefs

Name	Description
BoneIndexType	Set up our index type based on the type of pose we are manipulating.