UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::FPropertyDefinition Struct Reference

#include <MovieScenePropertyRegistry.h>

Public Member Functions

 FPropertyDefinition ()=default
 
 FPropertyDefinition (uint16 InVariableSizeCompositeOffset, FComponentTypeID InPropertyType, FComponentTypeID InInitialValueType)
 
 FPropertyDefinition (FPropertyDefinition &&)=default
 
 FPropertyDefinition (const FPropertyDefinition &)=delete
 
template<typename T >
TComponentTypeID< T > GetMetaDataComponent (int32 Index) const
 
MOVIESCENE_API void SetupInitialValueProcessor () const
 

Public Attributes

ICustomPropertyRegistrationCustomPropertyRegistration = nullptr
 
const IPropertyTraitsTraitsInstance = nullptr
 
TSubclassOf< UMovieSceneTrackDefaultTrackType
 
TStatId StatID
 
uint32 DoubleCompositeMask = 0
 
uint16 VariableSizeCompositeOffset = INDEX_NONE
 
uint16 CompositeSize = 0
 
FComponentTypeID PropertyType
 
FComponentTypeID InitialValueType
 
TArrayView< const FComponentTypeIDMetaDataTypes
 
UClassBlenderSystemClass
 
TInlineValue< IPropertyComponentHandler, 32 > Handler
 

Detailed Description

Structure defining a type of property that can be animated by sequencer

Constructor & Destructor Documentation

◆ FPropertyDefinition() [1/4]

UE::MovieScene::FPropertyDefinition::FPropertyDefinition ( )
default

◆ FPropertyDefinition() [2/4]

UE::MovieScene::FPropertyDefinition::FPropertyDefinition ( uint16  InVariableSizeCompositeOffset,
FComponentTypeID  InPropertyType,
FComponentTypeID  InInitialValueType 
)
inline

◆ FPropertyDefinition() [3/4]

UE::MovieScene::FPropertyDefinition::FPropertyDefinition ( FPropertyDefinition &&  )
default

◆ FPropertyDefinition() [4/4]

UE::MovieScene::FPropertyDefinition::FPropertyDefinition ( const FPropertyDefinition )
delete

Member Function Documentation

◆ GetMetaDataComponent()

template<typename T >
TComponentTypeID< T > UE::MovieScene::FPropertyDefinition::GetMetaDataComponent ( int32  Index) const
inline

Return a typed component ID for the meta data at the specified index. Care should obviously be taken here to ensure that the meta data type being used matches the TPropertyComponents traits that constructed this property definition.

◆ SetupInitialValueProcessor()

void UE::MovieScene::FPropertyDefinition::SetupInitialValueProcessor ( ) const

Sets up an initial value processor for this property type

Member Data Documentation

◆ BlenderSystemClass

UClass* UE::MovieScene::FPropertyDefinition::BlenderSystemClass

The blender system to use by default (if specified here) to blend composites of this property (it can be overriden per-entity with a blender system component)

◆ CompositeSize

uint16 UE::MovieScene::FPropertyDefinition::CompositeSize = 0

The number of channels that this property comprises

◆ CustomPropertyRegistration

ICustomPropertyRegistration* UE::MovieScene::FPropertyDefinition::CustomPropertyRegistration = nullptr

Pointer to a custom getter/setter registry for short circuiting the UObject VM. Must outlive this definitions lifetime (usually these are static or singletons)

◆ DefaultTrackType

TSubclassOf<UMovieSceneTrack> UE::MovieScene::FPropertyDefinition::DefaultTrackType

A default track type to use for this property

◆ DoubleCompositeMask

uint32 UE::MovieScene::FPropertyDefinition::DoubleCompositeMask = 0

A mask of which composite indices pertain to doubles

◆ Handler

TInlineValue<IPropertyComponentHandler, 32> UE::MovieScene::FPropertyDefinition::Handler

Implementation of type specific property actions such as applying properties from entities or recomposing values

◆ InitialValueType

FComponentTypeID UE::MovieScene::FPropertyDefinition::InitialValueType

The component type for this property's inital value (used for relative and/or additive blending)

◆ MetaDataTypes

TArrayView<const FComponentTypeID> UE::MovieScene::FPropertyDefinition::MetaDataTypes

MetaData types

◆ PropertyType

FComponentTypeID UE::MovieScene::FPropertyDefinition::PropertyType

The component type or tag of the property itself

◆ StatID

TStatId UE::MovieScene::FPropertyDefinition::StatID

Stat ID for this property type

◆ TraitsInstance

const IPropertyTraits* UE::MovieScene::FPropertyDefinition::TraitsInstance = nullptr

Pointer to the traits instance

◆ VariableSizeCompositeOffset

uint16 UE::MovieScene::FPropertyDefinition::VariableSizeCompositeOffset = INDEX_NONE

The number of channels that this property comprises


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