Navigation
API > API/Plugins > API/Plugins/ControlRig
| Name | FSampleTrackBase |
| Type | class |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Tracks/SampleTrackBase.h |
| Include Path | #include "Tracks/SampleTrackBase.h" |
Syntax
class FSampleTrackBase : public TSharedFromThis< FSampleTrackBase >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FSampleTrackBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSampleTrackBase
(
const FName& InName |
Tracks/SampleTrackBase.h | ||
| Tracks/SampleTrackBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSampleTrackBase() |
Tracks/SampleTrackBase.h |
Structs
| Name | Remarks |
|---|---|
| CIsStruct | |
| CIsStructArray | |
| TIsInstancedStruct | |
| TIsInstancedStructArray | |
| TIsInstancedStructArrayCompliant | |
| TIsInstancedStructCompliant |
Enums
Public
| Name | Remarks |
|---|---|
| EMode | |
| ETrackType |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddAtlas
(
bool bForce, |
Analyses the values stored and introduces the atlas index array, an indirection to save memory. | Tracks/SampleTrackBase.h | |
void AddSampleFromProperty
(
const FProperty* InProperty, |
Helper to store a sample based on a given property | Tracks/SampleTrackBase.h | |
bool ConvertToComplete
(
bool bForce |
Analyses the memory footprint of a sample track (just complete values vs time indices + values) and converts the track back to a complete representation for memory efficiency | Tracks/SampleTrackBase.h | |
bool ConvertToSampled
(
bool bForce, |
Adds all of the values back onto the track using a sampled representation | Tracks/SampleTrackBase.h | |
virtual void Empty() |
Tracks/SampleTrackBase.h | ||
| All names this track is using / this track represents | Tracks/SampleTrackBase.h | ||
virtual FString GetChildTrackNameSuffix
(
int32 InChildTrackIndex |
Returns the name for a given child track | Tracks/SampleTrackBase.h | |
virtual TArray< FSampleTrackBase::ETrackType > GetChildTrackTypes() |
Returns the required track types for the child tracks | Tracks/SampleTrackBase.h | |
EMode GetMode() |
The mode in which the track is storing its data | Tracks/SampleTrackBase.h | |
const FName & GetName() |
The first name of this track | Tracks/SampleTrackBase.h | |
int32 GetReferencedTrackIndex() |
Returns the index the track this track is referencing | Tracks/SampleTrackBase.h | |
void GetSampleForProperty
(
int32 InTimeIndex, |
Helper to retrieve a sample based on a given property | Tracks/SampleTrackBase.h | |
bool GetSampleIndexForTimeIndex
(
int32 InTimeIndex, |
Returns the sample index within the track given a time index | Tracks/SampleTrackBase.h | |
const UScriptStruct * GetScriptStruct() |
The script struct the track is using if it is storing values of FInstancedStruct | Tracks/SampleTrackBase.h | |
int32 GetTrackIndex() |
The index of the track within the container | Tracks/SampleTrackBase.h | |
virtual ETrackType GetTrackType() |
The type of track | Tracks/SampleTrackBase.h | |
virtual bool IsComposed() |
Returns true if this track is composed out of other tracks | Tracks/SampleTrackBase.h | |
virtual bool IsIdentical
(
const FSampleTrackBase* InOther, |
Returns true if this track is identical to another one | Tracks/SampleTrackBase.h | |
bool IsReferenced() |
Returns true if this track is referencing another track | Tracks/SampleTrackBase.h | |
bool IsValid() |
Tracks/SampleTrackBase.h | ||
virtual bool LocalizeValues() |
Localizes values if this track is referenced | Tracks/SampleTrackBase.h | |
int32 NumSamples() |
The number of samples stored within this track | Tracks/SampleTrackBase.h | |
int32 NumStoredValues() |
The number of stored values - which can be less than NumSamples if there is an atlas present | Tracks/SampleTrackBase.h | |
int32 NumTimes() |
The number of global time indices within the container | Tracks/SampleTrackBase.h | |
bool RemoveAtlas() |
Removes an existing Atlas indirection by flattening out all unique values into a larger, non-unique Value array | Tracks/SampleTrackBase.h | |
virtual void Reserve
(
int32 InSampleCount, |
Tracks/SampleTrackBase.h | ||
virtual void Reset() |
Tracks/SampleTrackBase.h | ||
virtual void Serialize
(
FArchive& InArchive |
Tracks/SampleTrackBase.h | ||
virtual void Shrink() |
Tracks/SampleTrackBase.h | ||
bool StoresValueForTimeIndex
(
int32 InTimeIndex |
Returns true if the track stores a value specifically at a given time index | Tracks/SampleTrackBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddTimeIndex
(
bool bOnlyIncreaseUpperBound |
Tracks/SampleTrackBase.h | ||
int32 AppendValuesFromTrack
(
const FSampleTrackBase* InOtherTrack |
Tracks/SampleTrackBase.h | ||
virtual const TArray< int32 > & GetChildTracks() |
Tracks/SampleTrackBase.h | ||
| Tracks/SampleTrackBase.h | |||
const FSampleTrackBase * GetReferencedTrack () |
Tracks/SampleTrackBase.h | ||
virtual int32 RemoveObsoleteTimes
(
int32 InNumTimesToRemove, |
Removes samples from the track which don't present any value anywhere. | Tracks/SampleTrackBase.h | |
virtual void SetChildTracks
(
const TArray< int32 >& InChildTrackIndices |
Tracks/SampleTrackBase.h | ||
virtual void UpdateArrayViews() |
Tracks/SampleTrackBase.h | ||
virtual void UpdateChildTracks() |
Tracks/SampleTrackBase.h | ||
void UpdateTimeAndAtlasArrayViews() |
Tracks/SampleTrackBase.h | ||
bool UsesAtlas
(
int32 InAtlasIndex |
Tracks/SampleTrackBase.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Tracks/SampleTrackBase.h | |||
static bool Equals
(
const TArray< FRigElementKey >& InA, |
Tracks/SampleTrackBase.h | ||
static bool Equals
(
const TArray< FLinearColor >& InA, |
Tracks/SampleTrackBase.h | ||
| Tracks/SampleTrackBase.h | |||
| Tracks/SampleTrackBase.h | |||
| Tracks/SampleTrackBase.h | |||
| Tracks/SampleTrackBase.h | |||
| Tracks/SampleTrackBase.h | |||
| Tracks/SampleTrackBase.h | |||
static bool Equals
(
const FInstancedStruct& InA, |
Tracks/SampleTrackBase.h | ||
| Tracks/SampleTrackBase.h | |||
| Tracks/SampleTrackBase.h | |||
static bool Equals
(
const TArray< FRigComponentKey >& InA, |
Tracks/SampleTrackBase.h | ||
static bool Equals
(
const T& InA, |
Tracks/SampleTrackBase.h | ||
static bool Equals
(
const float& InA, |
Tracks/SampleTrackBase.h | ||
static bool Equals
(
const FVector3f& InA, |
Tracks/SampleTrackBase.h | ||
static bool Equals
(
const FQuat4f& InA, |
Tracks/SampleTrackBase.h | ||
| Tracks/SampleTrackBase.h | |||
static bool Equals
(
const TArray< FInstancedStruct >& InA, |
Tracks/SampleTrackBase.h | ||
static bool Equals
(
const FLinearColor& InA, |
Tracks/SampleTrackBase.h | ||
static bool Equals
(
const FTransform3f& InA, |
Tracks/SampleTrackBase.h | ||
static uint32 GetSingleValueHash
(
const FInstancedStruct& InValue |
Tracks/SampleTrackBase.h | ||
static uint32 GetSingleValueHash
(
const T& InValue |
Tracks/SampleTrackBase.h | ||
static uint32 GetValueHash
(
const TArray< T >& InValue |
Tracks/SampleTrackBase.h | ||
static uint32 GetValueHash
(
const T& InValue |
Tracks/SampleTrackBase.h |