1. Epic GamesDeveloper
  3. FAvaPlayableRemoteControlValues

FAvaPlayableRemoteControlValues

Container for the remote control values of a playable.

API > API/Plugins > API/Plugins/AvalancheMedia

Container for the remote control values of a playable.

   
Name FAvaPlayableRemoteControlValues
Type struct
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/Playable/AvaPlayableRemoteControlValues.h
Include Path #include "Playable/AvaPlayableRemoteControlValues.h"

Syntax

USTRUCT ()  
struct FAvaPlayableRemoteControlValues

Constructors

Name Remarks Include Path Unreal Specifiers

FAvaPlayableRemoteControlValues()

   Playable/AvaPlayableRemoteControlValues.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ControllerValues TMap< FGuid, FAvaPlayableRemoteControlValue > Controller values. Playable/AvaPlayableRemoteControlValues.h  
EntityValues TMap< FGuid, FAvaPlayableRemoteControlValue > Value as a binary array of the Remote Control Entity. Playable/AvaPlayableRemoteControlValues.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyControllerValuesToRemoteControlPreset ( URemoteControlPreset* InRemoteControlPreset,
bool bInForceDisableBehaviors
) const

 Apply the controller values to the given remote control preset. Playable/AvaPlayableRemoteControlValues.h  

void ApplyEntityValuesToRemoteControlPreset ( URemoteControlPreset* InRemoteControlPreset,
const TSet< FGuid >& InSkipEntities
) const

 Apply the entity values to the given remote control preset. Playable/AvaPlayableRemoteControlValues.h  

void CopyFrom ( const URemoteControlPreset* InRemoteControlPreset,
bool bInIsDefault
)

 Copies the values (properties and controllers) from the given RemoteControlPreset. Playable/AvaPlayableRemoteControlValues.h  

const FAvaPlayableRemoteControlValue * GetControllerValue ( const FGuid& InId
) const

   Playable/AvaPlayableRemoteControlValues.h  

const FAvaPlayableRemoteControlValue * GetEntityValue ( const FGuid& InId
) const

   Playable/AvaPlayableRemoteControlValues.h  

bool HasControllerValue ( const FGuid& InId
) const

   Playable/AvaPlayableRemoteControlValues.h  

bool HasEntityValue ( const FGuid& InId
) const

   Playable/AvaPlayableRemoteControlValues.h  

bool HasIdCollisions ( const FAvaPlayableRemoteControlValues& InOtherValues
) const

 Return true if there are key collisions with the other set of values. Playable/AvaPlayableRemoteControlValues.h  

bool HasSameControllerValues ( const FAvaPlayableRemoteControlValues& InOther
) const

 Compares the remote control ControllerValues with another instance Playable/AvaPlayableRemoteControlValues.h  

bool HasSameEntityValues ( const FAvaPlayableRemoteControlValues& InOther
) const

 Compares the remote control EntityValues with another instance Playable/AvaPlayableRemoteControlValues.h  

bool Merge ( const FAvaPlayableRemoteControlValues& InOtherValues
)

 Merge the other values with current ones, combining the keys. Playable/AvaPlayableRemoteControlValues.h  

EAvaPlayableRemoteControlChanges PruneRemoteControlValues ( const FAvaPlayableRemoteControlValues& InReferenceValues
)

 Removes the extra values compared to the given reference values. Playable/AvaPlayableRemoteControlValues.h  

EAvaPlayableRemoteControlChanges ResetRemoteControlControllerValue ( const FGuid& InId,
const FAvaPlayableRemoteControlValue& InReferenceValue,
bool bInIsDefaults
)

 Reset the controller value to the reference. Playable/AvaPlayableRemoteControlValues.h  

EAvaPlayableRemoteControlChanges ResetRemoteControlEntityValue ( const FGuid& InId,
const FAvaPlayableRemoteControlValue& InReferenceValue,
bool bInIsDefaults
)

 Reset the entity value to the reference. Playable/AvaPlayableRemoteControlValues.h  

EAvaPlayableRemoteControlChanges ResetRemoteControlValues ( const FAvaPlayableRemoteControlValues& InReferenceValues,
bool bInIsDefaults
)

 Reset the values to the reference. Playable/AvaPlayableRemoteControlValues.h  

void SetControllerValue ( const FGuid& InId,
const FAvaPlayableRemoteControlValue& InValue
)

   Playable/AvaPlayableRemoteControlValues.h  

bool SetControllerValue ( const FGuid& InId,
const URemoteControlPreset* InRemoteControlPreset,
bool bInIsDefault
)

   Playable/AvaPlayableRemoteControlValues.h  

void SetEntityValue ( const FGuid& InId,
const FAvaPlayableRemoteControlValue& InValue
)

   Playable/AvaPlayableRemoteControlValues.h  

bool SetEntityValue ( const FGuid& InId,
const URemoteControlPreset* InRemoteControlPreset,
bool bInIsDefault
)

 Set the entity value from the given preset. Playable/AvaPlayableRemoteControlValues.h  
Update the property/controller values (i.e. add missing, remove extras) from the given reference values. Playable/AvaPlayableRemoteControlValues.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CollectReferencedAssetPaths ( const TMap< FGuid, FAvaPlayableRemoteControlValue >& InValues,
TSet< FSoftObjectPath >& OutReferencedPaths
)

 Collect the referenced asset paths from the given values. Playable/AvaPlayableRemoteControlValues.h  

static const FAvaPlayableRemoteControlValues & GetDefaultEmpty()

   Playable/AvaPlayableRemoteControlValues.h  

static bool HasIdCollisions ( const TMap< FGuid, FAvaPlayableRemoteControlValue >& InValues,
const TMap< FGuid, FAvaPlayableRemoteControlValue >& InOtherValues
)

 Returns true if the given maps have id collisions. Playable/AvaPlayableRemoteControlValues.h  

static bool IsRuntimeEventController ( const URCVirtualPropertyBase* InController
)

 Utility function to determine if a controller is considered an "event" controller, i.e. it doesn't carry a value to be used to set or restore state, but rather is runtime event based. Playable/AvaPlayableRemoteControlValues.h  

static bool ShouldIgnoreController ( const URCVirtualPropertyBase* InController
)

 Utility function to determine if a controller should be ignored by the playable management layer. Playable/AvaPlayableRemoteControlValues.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page