1. Epic GamesDeveloper
  3. URemoteControlPreset

URemoteControlPreset

Holds exposed functions and properties.

API > API/Plugins > API/Plugins/RemoteControl

Holds exposed functions and properties.

   
Name URemoteControlPreset
Type class
Header File /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlPreset.h
Include Path #include "RemoteControlPreset.h"

Syntax

UCLASS (BlueprintType, EditInlineNew)  
class URemoteControlPreset : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

URemoteControlPreset()

   RemoteControlPreset.h  

Structs

Name Remarks
FExposeInfo Holds information about an exposed field.
FPreMaterialModifiedCache A struct representing a material object modified that is housed by a container (eg. array, set, map).
FPreObjectsModifiedCache  
FRCPropertyWatcher Property watcher that triggers a delegate when the watched property is modified.

Typedefs

Name Type Remarks Include Path
FGuidToGuidMap TMap< FGuid, FGuid >   RemoteControlPreset.h
FOnActorPropertyModified TMulticastDelegate_FourParams< void, URemoteControlPreset *, FRemoteControlActor &, UObject *, FProperty * >   RemoteControlPreset.h
FOnControllerAdded TMulticastDelegate_ThreeParams< void, URemoteControlPreset *, const FName, const FGuid & >   RemoteControlPreset.h
FOnControllerIdsRenewed TMulticastDelegate_TwoParams< void, URemoteControlPreset *, const FGuidToGuidMap & >   RemoteControlPreset.h
FOnControllerModified TMulticastDelegate_TwoParams< void, URemoteControlPreset *, const TSet< FGuid > & >   RemoteControlPreset.h
FOnControllerRemoved TMulticastDelegate_TwoParams< void, URemoteControlPreset *, const FGuid & >   RemoteControlPreset.h
FOnControllerRenamed TMulticastDelegate_ThreeParams< void, URemoteControlPreset *, const FName, const FName >   RemoteControlPreset.h
FOnEntityRebind TMulticastDelegate_OneParam< void, const FGuid & >   RemoteControlPreset.h
FOnPostInitPropertiesRemoteControlPreset TMulticastDelegate_OneParam< void, URemoteControlPreset * > Callback for post init properties of remote control preset, called by URemoteControlPreset::PostInitProperties function RemoteControlPreset.h
FOnPostLoadRemoteControlPreset TMulticastDelegate_OneParam< void, URemoteControlPreset * > Callback for post remote control preset load, called by URemoteControlPreset::PostLoad function RemoteControlPreset.h
FOnPresetEntitiesUpdatedEvent TMulticastDelegate_TwoParams< void, URemoteControlPreset *, const TSet< FGuid > & >   RemoteControlPreset.h
FOnPresetEntityEvent TMulticastDelegate_TwoParams< void, URemoteControlPreset *, const FGuid & >   RemoteControlPreset.h
FOnPresetExposedPropertiesModified TMulticastDelegate_TwoParams< void, URemoteControlPreset *, const TSet< FGuid > & >   RemoteControlPreset.h
FOnPresetFieldRenamed TMulticastDelegate_ThreeParams< void, URemoteControlPreset *, FName, FName >   RemoteControlPreset.h
FOnPresetLayoutModified TMulticastDelegate_OneParam< void, URemoteControlPreset * >   RemoteControlPreset.h
FOnPresetMetadataModified TMulticastDelegate_OneParam< void, URemoteControlPreset * >   RemoteControlPreset.h
FOnPresetPropertyExposed TMulticastDelegate_TwoParams< void, URemoteControlPreset *, FName >   RemoteControlPreset.h
FOnPresetPropertyUnexposed TMulticastDelegate_TwoParams< void, URemoteControlPreset *, FName >   RemoteControlPreset.h
FOnPropertyIdsRenewed TMulticastDelegate_TwoParams< void, URemoteControlPreset *, const FGuidToGuidMap & >   RemoteControlPreset.h

Constants

Name Type Remarks Include Path
OnPostInitPropertiesRemoteControlPreset FOnPostInitPropertiesRemoteControlPreset   RemoteControlPreset.h
OnPostLoadRemoteControlPreset FOnPostLoadRemoteControlPreset   RemoteControlPreset.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Bindings TArray< TObjectPtr< URemoteControlBinding > > This preset's list of objects that are exposed or that have exposed fields. RemoteControlPreset.h
  • EditAnywhere
  • Category="Remote Control Preset"
Layout FRemoteControlPresetLayout The visual layout for this preset. RemoteControlPreset.h  
Metadata TMap< FString, FString > This preset's metadata. RemoteControlPreset.h  
NewControllerCategory FString Transient value for the default category for new properties. RemoteControlPreset.h  
SelectedWorld TWeakObjectPtr< const UWorld > Current selected world used only in the editor to let you switch world RemoteControlPreset.h  
UserData TArray< TObjectPtr< UObject > > This preset's user data RemoteControlPreset.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
BlueprintsWithRegisteredDelegates TSet< TWeakObjectPtr< UBlueprint > > List of blueprints for which we have registered events. RemoteControlPreset.h  
bOngoingRemoteModification bool Whether there is an ongoing remote modification happening. RemoteControlPreset.h  
BoundEntityIds TMap< FGuid, int32 > Transient list of the currently bound entity ids and the number of times they are bound. RemoteControlPreset.h  
bReentryGuard bool Used for OnObjectPropertyChanged to avoid being called by itself. RemoteControlPreset.h  
ControllerContainer TObjectPtr< URCVirtualPropertyContainerBase > Holds virtual controllers properties, behaviours and actions RemoteControlPreset.h
  • Instanced
DetailsTabIdentifierOverrides TArray< FName >   RemoteControlPreset.h  
FieldCache TMap< FGuid, FRCCachedFieldData > The cache for information about an exposed field. RemoteControlPreset.h
  • Transient
FRemoteControlEntity friend   RemoteControlPreset.h  
FRemoteControlPresetLayout friend   RemoteControlPreset.h  
ModifyOperationFlagsForProtocols ERCModifyOperationFlags Defines how this preset modifies properties when changed by protocols RemoteControlPreset.h  
NameToGuidMap TMap< FName, FGuid > Map of Field Name to GUID. RemoteControlPreset.h
  • Transient
OnActorPropertyModifiedDelegate FOnActorPropertyModified Delegate triggered when an exposed actor's property is modified. RemoteControlPreset.h  
OnControllerAddedDelegate FOnControllerAdded Delegate triggered when a controller is added RemoteControlPreset.h  
OnControllerIdsRenewedDelegate FOnControllerIdsRenewed Delegate triggered when a Controller guids are renewed. RemoteControlPreset.h  
OnControllerModifiedDelegate FOnControllerModified Delegate triggered when a Controller has been changed RemoteControlPreset.h  
OnControllerRemovedDelegate FOnControllerRemoved Delegate triggered when a controller is removed RemoteControlPreset.h  
OnControllerRenamedDelegate FOnControllerRenamed Delegate triggered when a Controller is renamed RemoteControlPreset.h  
OnEntitiesUpdatedDelegate FOnPresetEntitiesUpdatedEvent Delegate triggered when entities are modified and may need to be re-resolved. RemoteControlPreset.h  
OnEntityExposedDelegate FOnPresetEntityEvent Delegate triggered when an entity is exposed. RemoteControlPreset.h  
OnEntityRebindDelegate FOnEntityRebind Delegate triggered when an Entity is rebound RemoteControlPreset.h  
OnEntityUnexposedDelegate FOnPresetEntityEvent Delegate triggered when an entity is unexposed from the preset. RemoteControlPreset.h  
OnMetadataModifiedDelegate FOnPresetMetadataModified Delegate triggered when the preset's metadata has been modified. RemoteControlPreset.h  
OnPresetFieldRenamed FOnPresetFieldRenamed Delegate triggered when a field has been renamed. RemoteControlPreset.h  
OnPresetLayoutModifiedDelegate FOnPresetLayoutModified Delegate triggered when the layout is modified. RemoteControlPreset.h  
OnPropertyChangedDelegate FOnPresetExposedPropertiesModified Delegate triggered when an exposed property value has changed. RemoteControlPreset.h  
OnPropertyExposedDelegate FOnPresetPropertyExposed Delegate triggered when a new property has been exposed. RemoteControlPreset.h  
OnPropertyIdsRenewedDelegate FOnPropertyIdsRenewed Delegate triggered when the property guids are renewed. RemoteControlPreset.h  
OnPropertyUnexposedDelegate FOnPresetPropertyUnexposed Delegate triggered when a property has been unexposed. RemoteControlPreset.h  
PerFrameBindingsToClean TSet< URemoteControlBinding * > List of bindings for which we need to remove stale object pointers. RemoteControlPreset.h  
PerFrameModifiedProperties TSet< FGuid > Cache properties that were modified during a frame. RemoteControlPreset.h  
PerFrameUpdatedEntities TSet< FGuid > Cache entities updated during a frame. RemoteControlPreset.h  
PreMaterialModifiedCache TMap< FGuid, FPreMaterialModifiedCache > Caches material modifications during a frame. RemoteControlPreset.h  
PreObjectsModifiedActorCache TMap< FGuid, FPreObjectsModifiedCache >   RemoteControlPreset.h  
PreObjectsModifiedCache TMap< FGuid, FPreObjectsModifiedCache > Caches object modifications during a frame. RemoteControlPreset.h  
PresetId FGuid Preset unique ID RemoteControlPreset.h
  • AssetRegistrySearchable
PropertyChangeWatchFrameCounter int32 Frame counter for delaying property change checks. RemoteControlPreset.h  
PropertyIdRegistry TObjectPtr< URemoteControlPropertyIdRegistry > Holds identities of exposed entities on the preset. RemoteControlPreset.h
  • Transient
PropertyWatchers TMap< FGuid, FRCPropertyWatcher > Map of property watchers that should trigger the RC property change delegate upon change. RemoteControlPreset.h  
RebindingManager TPimplPtr< FRemoteControlPresetRebindingManager > Holds manager that handles rebinding unbound entities upon load or map change. RemoteControlPreset.h  
Registry TObjectPtr< URemoteControlExposeRegistry > Holds exposed entities on the preset. RemoteControlPreset.h
  • Instanced
Signatures TObjectPtr< URCSignatureRegistry > Holds all signatures on the preset. RemoteControlPreset.h
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers

URCVirtualPropertyInContainer * AddController ( TSubclassOf< URCVirtualPropertyInContainer > InPropertyClass,
const EPropertyBagPropertyType InValueType,
UObject* InValueTypeObject,
const FName InPropertyName
)

 Adds a Virtual Property (Controller) to the Remote Control Preset RemoteControlPreset.h  

void CacheControllersLabels()

 Cache this preset's controllers labels. RemoteControlPreset.h  

void CacheLayoutData()

 Cache this preset's layout data. RemoteControlPreset.h  

URCVirtualPropertyInContainer * DuplicateController ( URCVirtualPropertyInContainer* InVirtualProperty
)

 Duplicates a given Virtual Property from the Remote Control preset RemoteControlPreset.h  

TSharedPtr< FRemoteControlEntity > Expose ( FRemoteControlEntity&& Entity,
UScriptStruct* EntityType,
const FGuid& GroupId
)

 Expose an entity in the registry. RemoteControlPreset.h  
Expose an actor on this preset. RemoteControlPreset.h  

TWeakPtr< FRemoteControlFunction > ExposeFunction ( UObject* Object,
UFunction* Function,
FRemoteControlPresetExposeArgs Args
)

 Expose a function on this preset. RemoteControlPreset.h  
Expose a property on this preset. RemoteControlPreset.h  

TSharedPtr< FRemoteControlProperty > FindExposedProperty ( UObject* InOuterObject,
const FRCFieldPathInfo& InFieldPath
) const

 Gets a given object's property exposed property guid in this preset RemoteControlPreset.h  

URemoteControlBinding * FindOrAddBinding ( const TSoftObjectPtr< UObject >& Object
)

 Try to get a binding and creates a new one if it doesn't exist. RemoteControlPreset.h  

FName GenerateUniqueLabel ( const FName InDesiredName
) const

 Generate label from Registry RemoteControlPreset.h  

URCVirtualPropertyBase * GetController ( const FName InPropertyName
) const

 PropertyWrapperFunctions RemoteControlPreset.h  

URCVirtualPropertyBase * GetController ( const FGuid& InId
) const

 Fetches a controller by unique Id. RemoteControlPreset.h  

URCVirtualPropertyBase * GetControllerByDisplayName ( const FName InDisplayName
) const

 Fetches a virtual property by specified name. RemoteControlPreset.h  
Fetches the first found Controller matching the specified Field Id RemoteControlPreset.h  
Fetches the first Controller matching the specified Field Id and ValueType RemoteControlPreset.h  

URCVirtualPropertyContainerBase * GetControllerContainer()

 Returns the Property Bag Struct of this Container RemoteControlPreset.h  

TSharedPtr< FStructOnScope > GetControllerContainerStructOnScope()

 Returns the Struct On Scope of the Controller Container (value ptr of the virtual properties)* Currently used by the UI class SRCControllerPanelList for user value entry via the RC Controllers panel RemoteControlPreset.h  

TArray< URCVirtualPropertyBase * > GetControllers()

 Fetches all controller RemoteControlPreset.h  

TArray< URCVirtualPropertyBase * > GetControllersByFieldId ( const FName InFieldId
) const

 Fetches an array of all Controllers with the specified Field Id. RemoteControlPreset.h  

TArray< EPropertyBagPropertyType > GetControllersTypesByFieldId ( const FName InFieldId
) const

 Fetches an array of all Controllers Types with the specified Field Id. RemoteControlPreset.h  

const TArray< FName > & GetDetailsTabIdentifierOverrides()

   RemoteControlPreset.h  

UWorld * GetEmbeddedWorld()

   RemoteControlPreset.h  

int32 GetEntityBoundCount ( const FGuid& InEntityGuid
) const

 Returns the number of behaviors an entity is bound to. RemoteControlPreset.h  

FName GetEntityName ( const FName InDesiredName,
UObject* InObject,
const FRCFieldPathInfo& InFieldPath
) const

 Get entity name from given Desired or UObject + Field Path RemoteControlPreset.h  

const TMap< FGuid, int32 > & GetEntityUsage()

 Returns a map of the number of times exposed entities are used by behaviors. RemoteControlPreset.h  
  RemoteControlPreset.h  

TArray< TWeakPtr< ExposableEntityType > > GetExposedEntities ()

 Get the exposed entities of a certain type. RemoteControlPreset.h  

TArray< TWeakPtr< const ExposableEntityType > > GetExposedEntities ()

 Get the exposed entities of a certain type. RemoteControlPreset.h  

TWeakPtr< ExposableEntityType > GetExposedEntity ( const FGuid& ExposedEntityId
)

 Get a pointer to an exposed entity on the preset. RemoteControlPreset.h  

TWeakPtr< const ExposableEntityType > GetExposedEntity ( const FGuid& ExposedEntityId
) const

 Get a copy of an exposed entity on the preset. RemoteControlPreset.h  

FGuid GetExposedEntityId ( FName Label
) const

 Get the ID of an exposed entity using its label. RemoteControlPreset.h  

const UScriptStruct * GetExposedEntityType ( const FGuid& ExposedEntityId
) const

 Get the type of an exposed entity by querying with its id. RemoteControlPreset.h  
Get all types of exposed entities currently exposed. RemoteControlPreset.h  

TOptional< FRemoteControlField > GetField ( FGuid FieldId
) const

 Get a field ptr using it's id. RemoteControlPreset.h  
Get an exposed function using its id. RemoteControlPreset.h  

TOptional< FRemoteControlFunction > GetFunction ( FName FunctionLabel
) const

 Get an exposed function using its label. RemoteControlPreset.h  

ERCModifyOperationFlags GetModifyOperationFlagsForProtocols()

 Returns how this preset modifies properties when changed by protocols RemoteControlPreset.h  

int32 GetNextControllerDisplayIndex()

 The display index to put it at the bottom of the list. RemoteControlPreset.h  

int32 GetNumControllers()

 Returns the number of Virtual Properties contained in this Remote Control preset RemoteControlPreset.h  

const FGuid & GetPresetId()

 Get this preset's unique ID. RemoteControlPreset.h  

FName GetPresetName()

 Returns the FName that represents this asset or hosted preset. RemoteControlPreset.h  

TOptional< FRemoteControlProperty > GetProperty ( FName PropertyLabel
) const

 Get an exposed property using its label. RemoteControlPreset.h  
Get an exposed property using its id. RemoteControlPreset.h  

TObjectPtr< URemoteControlPropertyIdRegistry > GetPropertyIdRegistry()

 Get the PropertyIdRegistry. RemoteControlPreset.h  

URCSignatureRegistry * GetSignatureRegistry()

 Returns the preset's signature registry RemoteControlPreset.h  

UWorld * GetWorld ( bool bAllowPIE
) const

   RemoteControlPreset.h  

bool HasController ( const URCVirtualPropertyBase* InController
) const

 Returns true if the preset contains this controller. RemoteControlPreset.h  

const bool HasEntities()

 Returns true when Exposed Entities is populated. RemoteControlPreset.h  

bool IsControllerContainerValid()

 Checks whether the Controller Container (which holds all Virtual Properties) is currently valid RemoteControlPreset.h  

bool IsEmbeddedPreset()

 Returns true if the preset is hosted within another asset. RemoteControlPreset.h  

bool IsEntityBound ( const FGuid& InEntityGuid
) const

 Returns true if an entity is bound to a controller/behavior. RemoteControlPreset.h  

bool IsExposed ( const FGuid& ExposedEntityId
) const

 Returns whether an entity is exposed on the preset. RemoteControlPreset.h  

void NotifyExposedPropertyChanged ( FName PropertyLabel
)

   RemoteControlPreset.h  

FOnActorPropertyModified & OnActorPropertyModified()

   RemoteControlPreset.h  

FOnControllerAdded & OnControllerAdded()

   RemoteControlPreset.h  

FOnControllerIdsRenewed & OnControllerIdsRenewed()

   RemoteControlPreset.h  

FOnControllerModified & OnControllerModified()

   RemoteControlPreset.h  

FOnControllerRemoved & OnControllerRemoved()

   RemoteControlPreset.h  

FOnControllerRenamed & OnControllerRenamed()

   RemoteControlPreset.h  

FOnPresetEntitiesUpdatedEvent & OnEntitiesUpdated()

 Delegate called when the exposed entity wrapper itself is updated (ie. binding change, rename) RemoteControlPreset.h  

FOnPresetEntityEvent & OnEntityExposed()

   RemoteControlPreset.h  

FOnEntityRebind & OnEntityRebind()

   RemoteControlPreset.h  

FOnPresetEntityEvent & OnEntityUnexposed()

   RemoteControlPreset.h  

FOnPresetExposedPropertiesModified & OnExposedPropertiesModified()

 Delegate called with the list of exposed property that were modified in the last frame. RemoteControlPreset.h  

FOnPresetFieldRenamed & OnFieldRenamed()

   RemoteControlPreset.h  

FOnPresetMetadataModified & OnMetadataModified()

   RemoteControlPreset.h  

void OnModifyController ( const FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a virtual property is modified. RemoteControlPreset.h  

void OnNotifyPreChangeVirtualProperty ( const FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a virtual property's value is being scrubbed by the user in the UI. RemoteControlPreset.h  

FOnPresetLayoutModified & OnPresetLayoutModified()

   RemoteControlPreset.h  

FOnPresetPropertyExposed & OnPropertyExposed()

   RemoteControlPreset.h  

FOnPropertyIdsRenewed & OnPropertyIdsRenewed()

   RemoteControlPreset.h  

FOnPresetPropertyUnexposed & OnPropertyUnexposed()

   RemoteControlPreset.h  

FOnVirtualPropertyContainerModified & OnVirtualPropertyContainerModified()

   RemoteControlPreset.h  

void PerformChainReaction ( const FRemoteControlPropertyIdArgs& InArgs
) const

 Calls to the PropertyIdRegistry PerformChainReaction to update the value(s) of the property(ies) that are bound to a PropertyIdAction. RemoteControlPreset.h  

void RebindAllEntitiesUnderSameActor ( const FGuid& EntityId,
AActor* NewActor,
bool bUseRebindingContext
)

 Given a RC Entity, rebind all entities with the same owner to a new actor. RemoteControlPreset.h  

void RebindUnboundEntities()

 Attempt to rebind all currently unbound properties. RemoteControlPreset.h  

bool RemoveController ( const FName& InPropertyName
)

 Removes a given Virtual Property (by Name) from the Remote Control preset RemoteControlPreset.h  

FName RenameExposedEntity ( const FGuid& ExposedEntityId,
FName NewLabel
)

 Change the label of an entity. RemoteControlPreset.h  

void RenameField ( FName OldFieldLabel,
FName NewFieldLabel
)

 Rename a field. RemoteControlPreset.h  

void RenewControllerIds()

 Renews all controller guids. Necessary when duplicating. RemoteControlPreset.h  

void RenewEntityIds()

 Renews all exposed entity guids. Necessary when duplicating. RemoteControlPreset.h  

void ResetControllers()

 Removes all virtual properties held by this Remote Control preset RemoteControlPreset.h  

TArray< UObject * > ResolvedBoundObjects ( FName FieldLabel
)

 Resolves exposed property/function bounded objects RemoteControlPreset.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSTOptional< FExposedFunction > ResolveExposedFunction ( FName FunctionLabel
) const

 Resolve a remote controlled function to its UFunction and owner objects. RemoteControlPreset.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSTOptional< FExposedProperty > ResolveExposedProperty ( FName PropertyLabel
) const

 Resolve a remote controlled property to its FProperty and owner objects. RemoteControlPreset.h  

void SetControllerContainer ( URCVirtualPropertyContainerBase* InControllerContainer
)

 Sets the Controller Container (holds all Virtual Properties) RemoteControlPreset.h  

FName SetControllerDisplayName ( FGuid InControllerGuid,
const FName& InNewName
) const

 Rename the given controller with the new name if the name is unique RemoteControlPreset.h  

void SetDetailsTabIdentifierOverrides ( const TArray< FName >& NewOverrides
)

   RemoteControlPreset.h  

void SetModifyOperationFlagsForProtocols ( ERCModifyOperationFlags InOperationFlags
)

 Sets how this preset modifies properties when changed by protocols RemoteControlPreset.h  

void Unexpose ( FName EntityLabel
)

 Unexpose an entity from the preset. RemoteControlPreset.h  

void Unexpose ( const FGuid& EntityId
)

 Unexpose an entity from the preset. RemoteControlPreset.h  

void UpdateEntityUsage()

 Updates the usage of entities by controllers. Specifically the number of controlling behaviors. RemoteControlPreset.h  

void UpdateIdentifiedField ( const TSharedRef< FRemoteControlField >& InFieldToIdentify
) const

 Calls to the PropertyIdRegistry UpdateIdentifiedField to updates a field from the set of identified fields. RemoteControlPreset.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   RemoteControlPreset.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   RemoteControlPreset.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   RemoteControlPreset.h  

virtual void PostInitProperties()

   RemoteControlPreset.h  

virtual void PostLoad()

   RemoteControlPreset.h  

virtual void Serialize ( FArchive& Ar
)

   RemoteControlPreset.h  

Static

Name Remarks Include Path Unreal Specifiers

static UWorld * GetWorld ( const URemoteControlPreset* Preset,
bool bAllowPIE
)

   RemoteControlPreset.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page