1. Epic GamesDeveloper
  3. UPoseableMeshComponent

UPoseableMeshComponent

[UPoseableMeshComponent](API\Runtime\Engine\UPoseableMeshComponent) that allows bone transforms to be driven by blueprint.

API > API/Runtime > API/Runtime/Engine

UPoseableMeshComponent that allows bone transforms to be driven by blueprint.

   
Name UPoseableMeshComponent
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Components/PoseableMeshComponent.h
Include Path #include "Components/PoseableMeshComponent.h"

Syntax

UCLASS (ClassGroup=Rendering, HideCategories=(Object, Physics), Config=Engine, EditInlineNew,  
       Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UPoseableMeshComponent : public USkinnedMeshComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPoseableMeshComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/PoseableMeshComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BoneSpaceTransforms TArray< FTransform > Temporary array of local-space (ie relative to parent bone) rotation/translation/scale for each bone. Components/PoseableMeshComponent.h  
RequiredBones FBoneContainer   Components/PoseableMeshComponent.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bNeedsRefreshTransform bool This is marked if transform has to be updated Components/PoseableMeshComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CopyPoseFromSkeletalComponent ( USkeletalMeshComponent* InComponentToCopy
)

   Components/PoseableMeshComponent.h
  • BlueprintCallable
  • Category="Components|PoseableMesh"
Take the BoneSpaceTransforms array (translation vector, rotation quaternion and scale vector) and update the array of component-space bone transformation matrices (SpaceBases). Components/PoseableMeshComponent.h  

FVector GetBoneLocationByName ( FName BoneName,
EBoneSpaces::Type BoneSpace
)

   Components/PoseableMeshComponent.h
  • BlueprintCallable
  • Category="Components|PoseableMesh"

FRotator GetBoneRotationByName ( FName BoneName,
EBoneSpaces::Type BoneSpace
)

   Components/PoseableMeshComponent.h
  • BlueprintCallable
  • Category="Components|PoseableMesh"

FVector GetBoneScaleByName ( FName BoneName,
EBoneSpaces::Type BoneSpace
)

   Components/PoseableMeshComponent.h
  • BlueprintCallable
  • Category="Components|PoseableMesh"

const TArray< FTransform > & GetBoneSpaceTransforms()

 We need this for template function in the cpp skeletalmeshcomponent hides this property, so now creating extra getter for poseablemeshcomponent although it's fine for poseablemeshcomponent to have this as external note that their signature is different, but the template would workf ine Components/PoseableMeshComponent.h  

FTransform GetBoneTransformByName ( FName BoneName,
EBoneSpaces::Type BoneSpace
)

   Components/PoseableMeshComponent.h
  • BlueprintCallable
  • Category="Components|PoseableMesh"

bool IsRunningParallelEvaluation()

   Components/PoseableMeshComponent.h  

void MarkRefreshTransformDirty()

   Components/PoseableMeshComponent.h  

void ResetBoneTransformByName ( FName BoneName
)

   Components/PoseableMeshComponent.h
  • BlueprintCallable
  • Category="Components|PoseableMesh"

void SetBoneLocationByName ( FName BoneName,
FVector InLocation,
EBoneSpaces::Type BoneSpace
)

   Components/PoseableMeshComponent.h
  • BlueprintCallable
  • Category="Components|PoseableMesh"

void SetBoneRotationByName ( FName BoneName,
FRotator InRotation,
EBoneSpaces::Type BoneSpace
)

   Components/PoseableMeshComponent.h
  • BlueprintCallable
  • Category="Components|PoseableMesh"

void SetBoneScaleByName ( FName BoneName,
FVector InScale3D,
EBoneSpaces::Type BoneSpace
)

   Components/PoseableMeshComponent.h
  • BlueprintCallable
  • Category="Components|PoseableMesh"

void SetBoneTransformByName ( FName BoneName,
const FTransform& InTransform,
EBoneSpaces::Type BoneSpace
)

   Components/PoseableMeshComponent.h
  • BlueprintCallable
  • Category="Components|PoseableMesh"

Overridden from USkinnedMeshComponent

Name Remarks Include Path Unreal Specifiers

virtual bool AllocateTransformData()

 Allocate Transform Data array including SpaceBases, BoneVisibilityStates Components/PoseableMeshComponent.h  

virtual void RefreshBoneTransforms ( FActorComponentTickFunction* TickFunction
)

 Update functions Refresh Bone Transforms Each class will need to implement this function Ideally this function should be atomic (not relying on Tick or any other update.) Components/PoseableMeshComponent.h  

virtual bool ShouldUpdateTransform ( bool bLODHasChanged
) const

 Should update transform in Tick Components/PoseableMeshComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page