1. Epic GamesDeveloper
  3. FSampleTrackBase

FSampleTrackBase

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

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,
float InTolerance
)

 Analyses the values stored and introduces the atlas index array, an indirection to save memory. Tracks/SampleTrackBase.h  

void AddSampleFromProperty ( const FProperty* InProperty,
const uint8* InMemory
)

 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,
float InTolerance
)

 Adds all of the values back onto the track using a sampled representation Tracks/SampleTrackBase.h  

virtual void Empty()

   Tracks/SampleTrackBase.h  

const TArray< FName > & GetAllNames()

 All names this track is using / this track represents Tracks/SampleTrackBase.h  

virtual FString GetChildTrackNameSuffix ( int32 InChildTrackIndex
) const

 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,
FSampleTrackIndex& InOutSampleTrackIndex,
const FProperty* InProperty,
uint8* OutMemory
) const

 Helper to retrieve a sample based on a given property Tracks/SampleTrackBase.h  

bool GetSampleIndexForTimeIndex ( int32 InTimeIndex,
FSampleTrackIndex& InOutIndex
) const

 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,
float InTolerance
)

 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,
int32 InValueCount
)

   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
) const

 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  
  Tracks/SampleTrackBase.h  

virtual int32 RemoveObsoleteTimes ( int32 InNumTimesToRemove,
const TArray< bool >& InRemoveTimeIndexArray,
const TArray< int32 >& InOldTimeIndexToNewTimeIndex
)

 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
) const

   Tracks/SampleTrackBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool ArrayEquals ( const TArray< T >& A,
const TArray< T >& B,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< FRigElementKey >& InA,
const TArray< FRigElementKey >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< FLinearColor >& InA,
const TArray< FLinearColor >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< FTransform3f >& InA,
const TArray< FTransform3f >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< FQuat4f >& InA,
const TArray< FQuat4f >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< FVector3f >& InA,
const TArray< FVector3f >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< FString >& InA,
const TArray< FString >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< FName >& InA,
const TArray< FName >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< float >& InA,
const TArray< float >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const FInstancedStruct& InA,
const FInstancedStruct& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< int32 >& InA,
const TArray< int32 >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< bool >& InA,
const TArray< bool >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< FRigComponentKey >& InA,
const TArray< FRigComponentKey >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const T& InA,
const T& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const float& InA,
const float& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const FVector3f& InA,
const FVector3f& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const FQuat4f& InA,
const FQuat4f& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< uint32 >& InA,
const TArray< uint32 >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const TArray< FInstancedStruct >& InA,
const TArray< FInstancedStruct >& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const FLinearColor& InA,
const FLinearColor& InB,
float InTolerance
)

   Tracks/SampleTrackBase.h  

static bool Equals ( const FTransform3f& InA,
const FTransform3f& InB,
float InTolerance
)

   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  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page