Navigation
API > API/Runtime > API/Runtime/MovieScene
Variadic template representing a contiguous range of entities with a specific set of 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 TEntityRange
| Name | TEntityRange |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntityRange.h |
| Include Path | #include "EntitySystem/MovieSceneEntityRange.h" |
Syntax
template<typename... T>
struct TEntityRange : public UE::MovieScene::TEntityRangeImpl< TMakeIntegerSequence< int, sizeof...>, T... >
Inheritance Hierarchy
- TEntityRangeImpl → TEntityRange
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TEntityRange () |
Default constructor - empty range | EntitySystem/MovieSceneEntityRange.h | |
TEntityRange
(
int32 InNum |
Constructor that initializes the size, but no component ptrs. | EntitySystem/MovieSceneEntityRange.h | |
TEntityRange
(
int32 InNum, |
Constructor that initializes the size and components for this range | EntitySystem/MovieSceneEntityRange.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PtrType | TEntityPtr< T... > | EntitySystem/MovieSceneEntityRange.h | |
| Super | TEntityRangeImpl< TMakeIntegerSequence< int, sizeof...(T)>, T... > | EntitySystem/MovieSceneEntityRange.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TEntityPtr< T... > begin() |
EntitySystem/MovieSceneEntityRange.h | ||
TEntityPtr< T... > end() |
EntitySystem/MovieSceneEntityRange.h | ||
auto GetAll() |
Get all the components for the templated index as a TArrayView. | EntitySystem/MovieSceneEntityRange.h | |
auto & GetComponent
(
int32 EntityIndex |
Get the component from the templated component array index, using its index within this range. | EntitySystem/MovieSceneEntityRange.h | |
auto *& GetComponentArrayReference () |
Return a reference to the component array pointer at the specified index. | EntitySystem/MovieSceneEntityRange.h | |
auto * GetComponentOptional
(
int32 EntityIndex |
Get a pointer to an entity's component from its templated component array index, using the entity's index within this range. | EntitySystem/MovieSceneEntityRange.h | |
auto * GetRawUnchecked() |
Retrieve the raw pointer to the (possibly nullptr) component array at the templated index. | EntitySystem/MovieSceneEntityRange.h | |
int32 Num() |
Access the size of this range | EntitySystem/MovieSceneEntityRange.h | |
void SetComponent
(
int32 EntityIndex, |
Assign the value of an entity's component from its templated component array index, using the entity's index within this range. | EntitySystem/MovieSceneEntityRange.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TEntityPtr< T... > operator[]
(
int32 Index |
Access a specific entity within this range | EntitySystem/MovieSceneEntityRange.h |