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 > API/Plugins/GameplayCameras/Core

References

   
Module GameplayCameras
Header /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraVariableTable.h
Include #include "Core/CameraVariableTable.h"

Syntax

class FCameraVariableTable

Remarks

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.

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddVariable ( const FCameraVariableDefinition& VariableDefinition
)

 Adds a variable to the table.
Public function void  
Public function Const bool  
Public function Const const ValueType *

FindValue ( FCameraVariableID VariableID
)

  
Public function Const ValueType

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

  
Public function Const VariableAssetType::ValueType

GetValue ( const VariableAssetType* VariableAsset
)

  
Public function Const const ValueType &

GetValue ( FCameraVariableID VariableID
)

  
Public function void Initializes the variable table so that it fits the provided allocation info.
Public function Const bool  
Public function Const bool  
Public function void

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

  
Public function void

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

  
Public function void

LerpAll ( const FCameraVariableTable& ToTable,
float Factor
)

  
Public function void  
Public function void

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

  
Public function void

OverrideAll ( const FCameraVariableTable& OtherTable
)

  
Public function void

Serialize ( FArchive& Ar
)

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function Const bool

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

  
Public function Const bool

TryGetValue ( FCameraVariableID VariableID,
ValueType& OutValue
)

  
Public function Const bool  
Public function bool

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

  
Public function bool

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

  
Public function void  
Public function void

UnsetValue ( FCameraVariableID VariableID
)

  

Operators

  Type Name Description
Public function FCameraVariableTable &  
Public function FCameraVariableTable &  

Enums

  Type Name Description
Private enum EEntryFlags    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page