1. Epic GamesDeveloper
  3. URemoteControlPreset

URemoteControlPreset

Holds exposed functions and properties.

Unreal Engine C++ API Reference > Plugins > RemoteControl

Inheritance Hierarchy

References

   
Module RemoteControl
Header /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlPreset.h
Include #include "RemoteControlPreset.h"

Syntax

UCLASS (BlueprintType, EditInlineNew)  
class URemoteControlPreset : public UObject

Remarks

Holds exposed functions and properties.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere TArray< TObjectPtr< URemoteControlBinding > > Bindings This preset's list of objects that are exposed or that have exposed fields.
Public variable UProperty FRemoteControlPresetLayout Layout The visual layout for this preset.
Public variable UProperty TMap< FString, FString > Metadata This preset's metadata.
Public variable TWeakObjectPtr< const UWorld > SelectedWorld Current selected world used only in the editor to let you switch world
Public variable UProperty TArray< TObjectPtr< UObject > > UserData This preset's user data

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function URCVirtualPropertyInContainer *

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

 Adds a Virtual Property (Controller) to the Remote Control Preset
Public function Const void Cache this preset's controllers labels.
Public function void Cache this preset's layout data.
Public function URCVirtualPropertyInContainer * Duplicates a given Virtual Property from the Remote Control preset
Public function TSharedPtr< FRemoteControlEntity >

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

 Expose an entity in the registry.
Public function TWeakPtr< FRemoteControlActor > Expose an actor on this preset.
Public function TWeakPtr< FRemoteControlFunction > Expose a function on this preset.
Public function TWeakPtr< FRemoteControlProperty > Expose a property on this preset.
Public function Const TSharedPtr< FRemoteControlProperty >

FindExposedProperty ( UObject* InOuterObject,
const FRCFieldPathInfo& InFieldPath
)

 Gets a given object's property exposed property guid in this preset
Public function URemoteControlBinding *

FindOrAddBinding ( const TSoftObjectPtr< UObject >& Object
)

 Try to get a binding and creates a new one if it doesn't exist.
Public function Const FName

GenerateUniqueLabel ( const FName InDesiredName
)

 Generate label from Registry
Public function Const URCVirtualPropertyBase *

GetController ( const FGuid& InId
)

 Fetches a controller by unique Id.
Public function Const URCVirtualPropertyBase *

GetController ( const FName InPropertyName
)

 PropertyWrapperFunctions
Public function Const URCVirtualPropertyBase *

GetControllerByDisplayName ( const FName InDisplayName
)

 Fetches a virtual property by specified name.
Public function Const URCVirtualPropertyBase *

GetControllerByFieldId ( const FName InFieldId,
const EPropertyBagPropertyType InType
)

 Fetches the first Controller matching the specified Field Id and ValueType
Public function Const URCVirtualPropertyBase *

GetControllerByFieldId ( const FName InFieldId
)

 Fetches the first found Controller matching the specified Field Id
Public function TSharedPtr< FStructOnScope > 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
Public function Const TArray< URCVirtualPropertyBase * > Fetches all controller
Public function Const TArray< URCVirtualPropertyBase * >

GetControllersByFieldId ( const FName InFieldId
)

 Fetches an array of all Controllers with the specified Field Id.
Public function Const TArray< EPropertyBagPropertyType >

GetControllersTypesByFieldId ( const FName InFieldId
)

 Fetches an array of all Controllers Types with the specified Field Id.
Public function Const const TArray< FName > &  
Public function Const UWorld *  
Public function Const FName

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

 Get entity name from given Desired or UObject + Field Path
Public function TArray< TWeakPtr< FRemoteControlEntity > >  
Public function TArray< TWeakPtr< ExposableEntityType > > Get the exposed entities of a certain type.
Public function Const TArray< TWeakPtr< const ExposableEntityType > > Get the exposed entities of a certain type.
Public function Const TWeakPtr< const ExposableEntityType >

GetExposedEntity ( const FGuid& ExposedEntityId
)

 Get a copy of an exposed entity on the preset.
Public function TWeakPtr< ExposableEntityType >

GetExposedEntity ( const FGuid& ExposedEntityId
)

 Get a pointer to an exposed entity on the preset.
Public function Const FGuid Get the ID of an exposed entity using its label.
Public function Const const UScriptStruct *

GetExposedEntityType ( const FGuid& ExposedEntityId
)

 Get the type of an exposed entity by querying with its id.
Public function Const const TSet< TObjectPtr< UScriptStruct > > & Get all types of exposed entities currently exposed.
Public function Const TOptional< FRemoteControlField >

GetField ( FGuid FieldId
)

 Get a field ptr using it's id.
Public function Const TOptional< FRemoteControlFunction >

GetFunction ( FName FunctionLabel
)

 Get an exposed function using its label.
Public function Const TOptional< FRemoteControlFunction >

GetFunction ( FGuid FunctionId
)

 Get an exposed function using its id.
Public function Const ERCModifyOperationFlags Returns how this preset modifies properties when changed by protocols
Public function Const int32 Returns the number of Virtual Properties contained in this Remote Control preset
Public function Const const FGuid & Get this preset's unique ID.
Public function Const FName Returns the FName that represents this asset or hosted preset.
Public function Const TOptional< FRemoteControlProperty >

GetProperty ( FGuid PropertyId
)

 Get an exposed property using its id.
Public function Const TOptional< FRemoteControlProperty >

GetProperty ( FName PropertyLabel
)

 Get an exposed property using its label.
Public function Const TObjectPtr< URemoteControlPropertyIdRegistry > Get the PropertyIdRegistry.
Public function Const URCSignatureRegistry * Returns the preset's signature registry
Public function Const UWorld *

GetWorld ( bool bAllowPIE
)

  
Public function Static UWorld *

GetWorld ( const URemoteControlPreset* Preset,
bool bAllowPIE
)

  
Public function Const const bool Returns true when Exposed Entities is populated.
Public function bool Checks whether the Controller Container (which holds all Virtual Properties) is currently valid
Public function Const bool Returns true if the preset is hosted within another asset.
Public function Const bool

IsExposed ( const FGuid& ExposedEntityId
)

 Returns whether an entity is exposed on the preset.
Public function void  
Public function FOnActorPropertyModified &  
Public function FOnControllerAdded &  
Public function FOnControllerIdsRenewed &  
Public function FOnControllerModified &  
Public function FOnControllerRemoved &  
Public function FOnControllerRenamed &  
Public function FOnPresetEntitiesUpdatedEvent & Delegate called when the exposed entity wrapper itself is updated (ie. binding change, rename)
Public function FOnPresetEntityEvent &  
Public function FOnEntityRebind &  
Public function FOnPresetEntityEvent &  
Public function FOnPresetExposedPropertiesModified & Delegate called with the list of exposed property that were modified in the last frame.
Public function FOnPresetFieldRenamed &  
Public function FOnPresetMetadataModified &  
Public function void

OnModifyController ( const FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a virtual property is modified.
Public function void Called when a virtual property's value is being scrubbed by the user in the UI.
Public function FOnPresetLayoutModified &  
Public function FOnPresetPropertyExposed &  
Public function FOnPropertyIdsRenewed &  
Public function FOnPresetPropertyUnexposed &  
Public function Const FOnVirtualPropertyContainerModified &  
Public function Const void Calls to the PropertyIdRegistry PerformChainReaction to update the value(s) of the property(ies) that are bound to a PropertyIdAction.
Public function void

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

 Given a RC Entity, rebind all entities with the same owner to a new actor.
Public function void Attempt to rebind all currently unbound properties.
Public function bool

RemoveController ( const FName& InPropertyName
)

 Removes a given Virtual Property (by Name) from the Remote Control preset
Public function FName

RenameExposedEntity ( const FGuid& ExposedEntityId,
FName NewLabel
)

 Change the label of an entity.
Public function void

RenameField ( FName OldFieldLabel,
FName NewFieldLabel
)

 Rename a field.
Public function void Renews all controller guids. Necessary when duplicating.
Public function void Renews all exposed entity guids. Necessary when duplicating.
Public function void Removes all virtual properties held by this Remote Control preset
Public function TArray< UObject * >

ResolvedBoundObjects ( FName FieldLabel
)

 Resolves exposed property/function bounded objects
Public function Const PRAGMA_ENABLE_DEPRECATION_WARNINGSPRAGMA_DISABLE_DEPRECATION_WARNINGSTOptional< FExposedFunction >

ResolveExposedFunction ( FName FunctionLabel
)

 Resolve a remote controlled function to its UFunction and owner objects.
Public function Const PRAGMA_DISABLE_DEPRECATION_WARNINGSTOptional< FExposedProperty >

ResolveExposedProperty ( FName PropertyLabel
)

 Resolve a remote controlled property to its FProperty and owner objects.
Public function void Sets the Controller Container (holds all Virtual Properties)
Public function Const FName

SetControllerDisplayName ( FGuid InControllerGuid,
const FName& InNewName
)

 Rename the given controller with the new name if the name is unique
Public function void

SetDetailsTabIdentifierOverrides ( const TArray< FName >& NewOverrides
)

  
Public function void Sets how this preset modifies properties when changed by protocols
Public function PRAGMA_ENABLE_DEPRECATION_WARNINGS void

Unexpose ( FName EntityLabel
)

 Unexpose an entity from the preset.
Public function void

Unexpose ( const FGuid& EntityId
)

 Unexpose an entity from the preset.
Public function Const void

UpdateIdentifiedField ( const TSharedRef< FRemoteControlField >& InFieldToIdentify
)

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

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
FGuidToGuidMap  
FOnActorPropertyModified  
FOnControllerAdded  
FOnControllerIdsRenewed  
FOnControllerModified  
FOnControllerRemoved  
FOnControllerRenamed  
FOnEntityRebind  
FOnPostInitPropertiesRemoteControlPreset Callback for post init properties of remote control preset, called by URemoteControlPreset::PostInitProperties function
FOnPostLoadRemoteControlPreset Callback for post remote control preset load, called by URemoteControlPreset::PostLoad function
FOnPresetEntitiesUpdatedEvent  
FOnPresetEntityEvent  
FOnPresetExposedPropertiesModified  
FOnPresetFieldRenamed  
FOnPresetLayoutModified  
FOnPresetMetadataModified  
FOnPresetPropertyExposed  
FOnPresetPropertyUnexposed  
FOnPropertyIdsRenewed  

Constants

Name Description
OnPostInitPropertiesRemoteControlPreset  
OnPostLoadRemoteControlPreset  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page