UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Friends | List of all members
UE::MovieScene::FPropertyRegistry Class Reference

#include <MovieScenePropertyRegistry.h>

Public Member Functions

 FPropertyRegistry ()=default
 
 FPropertyRegistry (FPropertyRegistry &&)=delete
 
 FPropertyRegistry (const FPropertyRegistry &)=delete
 
template<typename PropertyTraits >
TCompositePropertyDefinitionBuilder< PropertyTraits > DefineCompositeProperty (TPropertyComponents< PropertyTraits > &InOutPropertyComponents, const TCHAR *InStatName)
 
template<typename PropertyTraits >
TPropertyDefinitionBuilder< PropertyTraits > DefineProperty (TPropertyComponents< PropertyTraits > &InOutPropertyComponents, const TCHAR *InStatName)
 
const FPropertyDefinition & GetDefinition (FCompositePropertyTypeID PropertyID) const
 
TArrayView< const FPropertyDefinition > GetProperties () const
 
MOVIESCENE_API const FPropertyDefinition * FindPropertyDefinition (FComponentTypeID ComponentTypeID) const
 
TArrayView< const FPropertyCompositeDefinition > GetComposites (const FPropertyDefinition &Property) const
 
TArrayView< const FPropertyCompositeDefinition > GetComposites (FCompositePropertyTypeID PropertyID) const
 

Static Public Member Functions

static MOVIESCENE_API TOptional< FResolvedFastProperty > ResolveFastProperty (UObject *Object, const FMovieScenePropertyBinding &PropertyBinding, FCustomAccessorView CustomAccessors)
 
static MOVIESCENE_API TOptional< FResolvedProperty > ResolveProperty (UObject *Object, const FMovieScenePropertyBinding &PropertyBinding, FCustomAccessorView CustomAccessors)
 

Friends

template<typename PropertyTraits >
struct TPropertyDefinitionBuilder
 
template<typename PropertyTraits , typename... Composites>
struct TCompositePropertyDefinitionBuilder
 

Detailed Description

Central registry of all property types animatable by sequencer. Once registered, properties cannot be de-registered. This vastly simplifies the lifetime and ID management of the class

Constructor & Destructor Documentation

◆ FPropertyRegistry() [1/3]

UE::MovieScene::FPropertyRegistry::FPropertyRegistry ( )
default

◆ FPropertyRegistry() [2/3]

UE::MovieScene::FPropertyRegistry::FPropertyRegistry ( FPropertyRegistry &&  )
delete

◆ FPropertyRegistry() [3/3]

UE::MovieScene::FPropertyRegistry::FPropertyRegistry ( const FPropertyRegistry &  )
delete

Member Function Documentation

◆ DefineCompositeProperty()

template<typename PropertyTraits >
TCompositePropertyDefinitionBuilder< PropertyTraits > UE::MovieScene::FPropertyRegistry::DefineCompositeProperty ( TPropertyComponents< PropertyTraits > &  InOutPropertyComponents,
const TCHAR *  InStatName 
)
inline

Define a new animatable composite property type from its components.

Parameters
InOutPropertyComponentsThe property's components that are used for animating this property. TPropertyComponents::CompositeID is written to.
Returns
A builder class that should be used to define the composites that contribute to this property

◆ DefineProperty()

template<typename PropertyTraits >
TPropertyDefinitionBuilder< PropertyTraits > UE::MovieScene::FPropertyRegistry::DefineProperty ( TPropertyComponents< PropertyTraits > &  InOutPropertyComponents,
const TCHAR *  InStatName 
)
inline

Define a new animatable property type from its components.

Parameters
InOutPropertyComponentsThe property's components that are used for animating this property. TPropertyComponents::CompositeID is written to.
Returns
A builder class that should be used to define the composites that contribute to this property

◆ FindPropertyDefinition()

const FPropertyDefinition * UE::MovieScene::FPropertyRegistry::FindPropertyDefinition ( FComponentTypeID  ComponentTypeID) const

Access all the properties currently registered

◆ GetComposites() [1/2]

TArrayView< const FPropertyCompositeDefinition > UE::MovieScene::FPropertyRegistry::GetComposites ( const FPropertyDefinition &  Property) const
inline

Retrieve a generic representation of all the composites that contribute to a given property

◆ GetComposites() [2/2]

TArrayView< const FPropertyCompositeDefinition > UE::MovieScene::FPropertyRegistry::GetComposites ( FCompositePropertyTypeID  PropertyID) const
inline

Retrieve a generic representation of all the composites that contribute to a given property

◆ GetDefinition()

const FPropertyDefinition & UE::MovieScene::FPropertyRegistry::GetDefinition ( FCompositePropertyTypeID  PropertyID) const
inline

Retrieve a property definition from its ID

◆ GetProperties()

TArrayView< const FPropertyDefinition > UE::MovieScene::FPropertyRegistry::GetProperties ( ) const
inline

Access all the properties currently registered

◆ ResolveFastProperty()

TOptional< FResolvedFastProperty > UE::MovieScene::FPropertyRegistry::ResolveFastProperty ( UObject *  Object,
const FMovieScenePropertyBinding &  PropertyBinding,
FCustomAccessorView  CustomAccessors 
)
static

Resolve a property to either a fast ptr offset, or a custom property accessor based on the specified array

Parameters
ObjectThe object to resolve the property for
PropertyBindingThe property binding to resolve
CustomAccessorsA view to an array of custom accessors (as retrieved from ICustomPropertyRegistration::GetAccessors)
Returns
An optional variant specifying the resolved property if it resolved successfully

◆ ResolveProperty()

TOptional< FResolvedProperty > UE::MovieScene::FPropertyRegistry::ResolveProperty ( UObject *  Object,
const FMovieScenePropertyBinding &  PropertyBinding,
FCustomAccessorView  CustomAccessors 
)
static

Resolve a property to either a fast ptr offset, or a custom property accessor based on the specified array falling back to a slow instance binding if possible

Parameters
ObjectThe object to resolve the property for
PropertyBindingThe property binding to resolve
CustomAccessorsA view to an array of custom accessors (as retrieved from ICustomPropertyRegistration::GetAccessors)
Returns
An optional variant specifying the resolved property if it resolved successfully

Friends And Related Symbol Documentation

◆ TCompositePropertyDefinitionBuilder

template<typename PropertyTraits , typename... Composites>
friend struct TCompositePropertyDefinitionBuilder
friend

◆ TPropertyDefinitionBuilder

template<typename PropertyTraits >
friend struct TPropertyDefinitionBuilder
friend
The documentation for this class was generated from the following files: