UE::MovieScene::TEntityPtr< T > Struct Template Reference

#include <MovieSceneEntityRange.h>

Public Member Functions
	TEntityPtr (int32 InEntityIndex, const TEntityRange< T... > *InOwner)
TEntityPtr &	operator++ ()
TEntityPtr &	operator-- ()
TEntityPtr &	operator* ()
	operator bool () const
template<int ComponentTypeIndex>
auto &	Get () const
template<int ComponentTypeIndex>
auto *	GetOptional () const
template<int ComponentTypeIndex, typename ValueType >
void	Set (ValueType &&InValue) const

Friends
bool	operator!= (const TEntityPtr &A, const TEntityPtr &B)

Detailed Description

template<typename... T>
struct UE::MovieScene::TEntityPtr< T >

Variadic template representing a single entity with a range of entities with the same a set of typed components.

The template parameters define each component type by index, whose constness should match the read/write semantics of the accessor. For example, an entity with a float, int and bool component, accessed read-only should be represented by a TEntityPtr<const float, const int const bool>. If one wished to write to all the float components, we would require a TEntityPtr<float, const int, const bool> etc

Constructor & Destructor Documentation

TEntityPtr()

template<typename... T>

UE::MovieScene::TEntityPtr< T >::TEntityPtr ( int32  InEntityIndex, const TEntityRange< T... > *  InOwner  )

inline

Construct this range from a range and index

Member Function Documentation

Get()

template<typename... T>

template<int ComponentTypeIndex>

auto & UE::MovieScene::TEntityPtr< T >::Get ( ) const

inline

Retrieve the component at the specified Index within this TEntityPtr's parameters. Not to be used for Read/WriteOptional variants.

Note

The const qualifier of the component will match the access mode for the component (const for read, non-const for write)

Returns

A reference to the component value

GetOptional()

template<typename... T>

template<int ComponentTypeIndex>

auto * UE::MovieScene::TEntityPtr< T >::GetOptional ( ) const

inline

Optionally retrieve the component at the specified ComponentTypeIndex within this TEntityPtr's parameters.

Note

The const qualifier of the component will match the access mode for the component (const for read, non-const for write)

Returns

A pointer to the component value, or nullptr if this entity does not have such a component.

operator bool()

template<typename... T>

UE::MovieScene::TEntityPtr< T >::operator bool ( ) const

inlineexplicit

Test whether this pointer is valid

operator*()

template<typename... T>

TEntityPtr & UE::MovieScene::TEntityPtr< T >::operator* ( )

inline

Dereference this pointer

operator++()

template<typename... T>

TEntityPtr & UE::MovieScene::TEntityPtr< T >::operator++ ( )

inline

Increment this pointer

operator--()

template<typename... T>

TEntityPtr & UE::MovieScene::TEntityPtr< T >::operator-- ( )

inline

Increment this pointer

Set()

template<typename... T>

template<int ComponentTypeIndex, typename ValueType >

void UE::MovieScene::TEntityPtr< T >::Set ( ValueType &&  InValue ) const

inline

Set the value of the component at the specified index withinin this entity

Parameters

InValue

The value to assign to the component

Friends And Related Symbol Documentation

operator!=

template<typename... T>

bool operator!= ( const TEntityPtr< T > &  A, const TEntityPtr< T > &  B  )

friend

Compare this pointer with another for equality

---

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

• Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntityRange.h