1. Epic GamesDeveloper
  3. FCameraVariableTable

FCameraVariableTable

The camera variable table is a container for a collection of arbitrary values of various types.

API > API/Plugins > API/Plugins/GameplayCameras

The camera variable table is a container for a collection of arbitrary values of various types. Only certain basic types are supported (most primitive types).

This table serves both as an implementation of the usual "blackboard" design, where gameplay systems can push any appropriate values into the camera system, and as a place for camera node evaluators to stash various things.

The main function of the variable table is that it is blended along with the camera rig it belongs to. Any matching values between to blended tables with be themselves blended, except for values flagged as "private".

Internally, the variable table is allocated as one continuous block of memory, plus a map of metadata keyed by variable ID. A variable ID can be anything, but will generally be the hash of the variable name.

   
Name FCameraVariableTable
Type class
Header File /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraVariableTable.h
Include Path #include "Core/CameraVariableTable.h"

Syntax

class FCameraVariableTable

Constructors

Name Remarks Include Path Unreal Specifiers
  Core/CameraVariableTable.h  
  Core/CameraVariableTable.h  
  Core/CameraVariableTable.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FCameraVariableTable()

   Core/CameraVariableTable.h  

Structs

Name Remarks
FEntry  

Constants

Name Type Remarks Include Path
bCachedBlendableStructs bool   Core/CameraVariableTable.h
CachedBlendableStructs TArray< FBlendableStructInfo >   Core/CameraVariableTable.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Capacity uint32   Core/CameraVariableTable.h  
Entries TArray< FEntry >   Core/CameraVariableTable.h  
EntryLookup TMap< FCameraVariableID, int32 >   Core/CameraVariableTable.h  
Memory uint8 *   Core/CameraVariableTable.h  
Used uint32   Core/CameraVariableTable.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddVariable ( const FCameraVariableDefinition& VariableDefinition
)

 Adds a variable to the table. Core/CameraVariableTable.h  

void AutoResetValues()

   Core/CameraVariableTable.h  

void ClearAllWrittenThisFrameFlags()

   Core/CameraVariableTable.h  

bool ContainsValue ( FCameraVariableID VariableID
) const

   Core/CameraVariableTable.h  

const ValueType * FindValue ( FCameraVariableID VariableID
) const

   Core/CameraVariableTable.h  

const ValueType & GetValue ( FCameraVariableID VariableID
) const

   Core/CameraVariableTable.h  

const uint8 * GetValue ( FCameraVariableID VariableID,
ECameraVariableType ExpectedVariableType,
const UScriptStruct* ExpectedBlendableStructType,
bool bOnlyIfWritten
) const

   Core/CameraVariableTable.h  

ValueType GetValue ( FCameraVariableID VariableID,
typename TCallTraits< ValueType >::ParamType DefaultValue
) const

   Core/CameraVariableTable.h  

VariableAssetType::ValueType GetValue ( const VariableAssetType* VariableAsset
) const

   Core/CameraVariableTable.h  

void Initialize ( const FCameraVariableTableAllocationInfo& AllocationInfo
)

 Initializes the variable table so that it fits the provided allocation info. Core/CameraVariableTable.h  

bool IsValueWritten ( FCameraVariableID VariableID
) const

   Core/CameraVariableTable.h  

bool IsValueWrittenThisFrame ( FCameraVariableID VariableID
) const

   Core/CameraVariableTable.h  

void Lerp ( const FCameraVariableTable& ToTable,
ECameraVariableTableFilter Filter,
float Factor
)

   Core/CameraVariableTable.h  

void Lerp ( const FCameraVariableTable& ToTable,
ECameraVariableTableFilter Filter,
float Factor,
const FCameraVariableTableFlags& InMask,
bool bInvertMask,
FCameraVariableTableFlags& OutMask
)

   Core/CameraVariableTable.h  

void LerpAll ( const FCameraVariableTable& ToTable,
float Factor,
bool bIncludePrivateValues
)

   Core/CameraVariableTable.h  

void Override ( const FCameraVariableTable& OtherTable,
ECameraVariableTableFilter Filter
)

   Core/CameraVariableTable.h  

void Override ( const FCameraVariableTable& OtherTable,
ECameraVariableTableFilter Filter,
const FCameraVariableTableFlags& InMask,
bool bInvertMask,
FCameraVariableTableFlags& OutMask
)

   Core/CameraVariableTable.h  

void OverrideAll ( const FCameraVariableTable& OtherTable,
bool bIncludePrivateValues
)

   Core/CameraVariableTable.h  

void Serialize ( FArchive& Ar
)

   Core/CameraVariableTable.h  

void SetValue ( const VariableAssetType* VariableAsset,
typename TCallTraits< typename VariableAssetType::ValueType >::ParamType Value,
bool bCreateIfMissing
)

   Core/CameraVariableTable.h  

void SetValue ( FCameraVariableID VariableID,
typename TCallTraits< ValueType >::ParamType Value
)

   Core/CameraVariableTable.h  

void SetValue ( const FCameraVariableDefinition& VariableDefinition,
typename TCallTraits< ValueType >::ParamType Value,
bool bCreateIfMissing
)

   Core/CameraVariableTable.h  

void SetValue ( FCameraVariableID VariableID,
ECameraVariableType ExpectedVariableType,
const UScriptStruct* ExpectedBlendableStructType,
const uint8* InRawValuePtr,
bool bMarkAsWrittenThisFrame
)

   Core/CameraVariableTable.h  

uint8 * TryGetMutableValue ( FCameraVariableID VariableID,
ECameraVariableType ExpectedVariableType,
const UScriptStruct* ExpectedBlendableStructType,
bool bOnlyIfWritten
)

   Core/CameraVariableTable.h  

bool TryGetValue ( FCameraVariableID VariableID,
ValueType& OutValue
) const

   Core/CameraVariableTable.h  

bool TryGetValue ( const VariableAssetType* VariableAsset,
typename VariableAssetType::ValueType& OutValue
) const

   Core/CameraVariableTable.h  

const uint8 * TryGetValue ( FCameraVariableID VariableID,
ECameraVariableType ExpectedVariableType,
const UScriptStruct* ExpectedBlendableStructType,
bool bOnlyIfWritten
) const

   Core/CameraVariableTable.h  

bool TryGetVariableDefinition ( FCameraVariableID VariableID,
FCameraVariableDefinition& OutVariableDefinition
) const

   Core/CameraVariableTable.h  

bool TrySetValue ( FCameraVariableID VariableID,
typename TCallTraits< ValueType >::ParamType Value
)

   Core/CameraVariableTable.h  

bool TrySetValue ( FCameraVariableID VariableID,
ECameraVariableType ExpectedVariableType,
const UScriptStruct* ExpectedBlendableStructType,
const uint8* InRawValuePtr,
bool bMarkAsWrittenThisFrame
)

   Core/CameraVariableTable.h  

void UnsetAllValues()

   Core/CameraVariableTable.h  

void UnsetValue ( FCameraVariableID VariableID
)

   Core/CameraVariableTable.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CacheBlendableStructs()

   Core/CameraVariableTable.h  

static bool CheckVariableType ( ECameraVariableType InType
)

   Core/CameraVariableTable.h  

static FBlendableStructTypeErasedInterpolator GetBlendableStructInterpolator ( const UScriptStruct* StructType
)

   Core/CameraVariableTable.h  

static bool GetVariableTypeAllocationInfo ( ECameraVariableType VariableType,
const UScriptStruct* StructType,
uint32& OutSizeOf,
uint32& OutAlignOf
)

   Core/CameraVariableTable.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Core/CameraVariableTable.h  
  Core/CameraVariableTable.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page