1. Epic GamesDeveloper
  3. UPCapPropComponent

UPCapPropComponent

A component for use in Motion Capture props.

API > API/Plugins > API/Plugins/PerformanceCaptureWorkflowRuntim-

A component for use in Motion Capture props. Accepts data as either a LiveLink Transform Role or an Animation Role. If the Live Link data is in the Animation role, this component will take the root bone transform and apply that transform to the owning actor's root component. Can be applied to Static Meshes, Skeletal Meshes and Blueprint constructions. Transform data can be offset in the component's local space. If this component is driving a Skeletal Mesh component and is receiving Live Link Animation data the full bone hierarchy will be applied.

   
Name UPCapPropComponent
Type class
Header File /Engine/Plugins/VirtualProduction/PerformanceCaptureWorkflow/Source/PerformanceCaptureWorkflowRuntime/Public/PCapPropComponent.h
Include Path #include "PCapPropComponent.h"

Syntax

UCLASS (Blueprintable, ClassGroup=("Performance Capture"),  
       Meta=(BlueprintSpawnableComponent, DisplayName="Prop Component"))  
class UPCapPropComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPCapPropComponent()

 Constructor. PCapPropComponent.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UPCapPropComponent()

 Destructor. PCapPropComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowOnlyIKBones bool False = All bone chains' start and end bones will be considered for dynamic attachment . PCapPropComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Performance Capture|Dynamic Constraint"
  • Meta=(EditCondition="bUseDynamicConstraint", EditConditionHides)
bEvaluateLiveLink bool Should LiveLink Subject data be evaluated. PCapPropComponent.h
  • EditAnywhere
  • Category="Performance Capture"
bIsControlledBySequencer bool Overrides all LiveLink data and the offset transform. Must be manually set on possessable bindings. PCapPropComponent.h
  • BlueprintReadOnly
  • EditInstanceOnly
  • Interp
  • Category="Performance Capture"
bUseDynamicConstraint bool Enable/Disable use of the Dynamic Constraint offset vector. PCapPropComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Performance Capture|Dynamic Constraint"
ControlledComponent FComponentReference Scene Component driven by the LiveLink data. Defaults to Root component of the owning actor. PCapPropComponent.h
  • EditInstanceOnly
  • Category="Performance Capture"
  • Meta=(UseComponentPicker, AllowedClasses="/Script/Engine.SceneComponent")
DynamicAttachmentCharacters TArray< TSoftObjectPtr< ACaptureCharacter > > List of Capture Characters to consider in calculating a dynamic constraint. PCapPropComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Performance Capture|Dynamic Constraint"
  • Meta=(EditCondition="bUseDynamicConstraint", EditConditionHides)
DynamicConstraintAttachBones TArray< FName > A list of bones of to test against for dynamic constraint. PCapPropComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Performance Capture|Dynamic Constraint"
  • Meta=(GetOptions="GetAttachBones", EditCondition="bUseDynamicConstraint", EditConditionHides)
OffsetTransform FTransform Offset the incoming LiveLink Transform data in the local space of the controlled component. PCapPropComponent.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Performance Capture"
SpawningDataAsset FName The package name of the spawning data asset, if there is one. PCapPropComponent.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Category="Performance Capture"
SubjectName FLiveLinkSubjectName LiveLink Subject Name. Must have either Animation Role Type. PCapPropComponent.h
  • EditAnywhere
  • Category="Performance Capture"

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsDirty bool   PCapPropComponent.h  
bIsSpawnableCache TOptional< bool >   PCapPropComponent.h  
CachedLiveLinkTransform FTransform   PCapPropComponent.h  
DynamicConstraintOffset FVector   PCapPropComponent.h  
FinalTransform FTransform   PCapPropComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FVector CalculateDynamicOffset()

 Blueprint implementable event to enable calculation of a location offset before applying it to the controlled component's transform. PCapPropComponent.h
  • BlueprintNativeEvent
  • Category="Performance Capture|Dynamic Constraint"

TArray< FName > GetAttachBones()

 Return a list of bones from the given list of DynamicAttachmentCharacters. PCapPropComponent.h  

USceneComponent * GetControlledComponent()

 Returns the component controlled by this component. Can return null. PCapPropComponent.h
  • BlueprintPure
  • Category="Performance Capture"

bool GetEvaluateLiveLinkData()

 Get the LiveLink Evaluation State. Subject must have the Animation Role Type. PCapPropComponent.h
  • BlueprintPure
  • Category="Performance Capture|Prop"

FLiveLinkSubjectName GetLiveLinkSubject()

 Get the LiveLink Subject Name. PCapPropComponent.h
  • BlueprintCallable
  • Category="Performance Capture|Prop"

void InitiateAnimation()

   PCapPropComponent.h  

void ResetAnimInstance()

   PCapPropComponent.h  

void SetControlledComponent ( USceneComponent* InComponent
)

 Sets the component controlled by this component. PCapPropComponent.h
  • BlueprintCallable
  • Category="Performance Capture"

void SetEvaluateLiveLinkData ( bool bEvaluateLinkLink
)

 Set the LiveLink data to update the Skeletal Mesh pose. PCapPropComponent.h
  • BlueprintCallable
  • Category="Performance Capture|Prop"

void SetLiveLinkSubject ( FLiveLinkSubjectName Subject
)

 Set the Live Link subject used by this prop component. PCapPropComponent.h
  • BlueprintCallable
  • Category="Performance Capture|Prop"

void SetOffsetTransform ( FTransform NewOffset
)

 Update the local space offset to this prop's Live Link pose. PCapPropComponent.h
  • BlueprintCallable
  • Category="Performance Capture|Prop"

virtual void TickComponent ( float DeltaTime,
ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Called every frame. PCapPropComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void DestroyComponent ( bool bPromoteChildren
)

   PCapPropComponent.h  

virtual void OnRegister()

   PCapPropComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   PCapPropComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page