URemoteControlPreset

Holds targets that contain exposed functions and properties.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

URemoteControlPreset

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 targets that contain exposed functions and properties.

Variables

Name Description

Public variable UProperty Category, EditAnywhere

TArray< URemote...

 

Bindings

This preset's list of objects that are exposed or that have exposed fields.

Public variable UProperty

FRemoteControlP...

 

Layout

The visual layout for this preset.

Public variable UProperty

TMap< FString, ...

 

Metadata

This preset's metadata.

Constructors

Name Description

Public function

URemoteControlPreset()

Functions

Name Description

Public function

void

 

CacheLayoutData()

Cache this preset's layout data.

Public function

TSharedPtr< ...

 

Expose

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

Expose an entity in the registry.

Public function

TWeakPtr< FR...

 

ExposeActor

(
    AActor* Actor,
    FRemoteControlPresetExposeArgs Args
)

Expose an actor on this preset.

Public function

TWeakPtr< FR...

 

ExposeFunction

(
    UObject* Object,
    UFunction* Function,
    FRemoteControlPresetExposeArgs Args
)

Expose a function on this preset.

Public function

TWeakPtr< FR...

 

ExposeProperty

(
    UObject* Object,
    FRCFieldPathInfo FieldPath,
    FRemoteControlPresetExposeArgs Args
)

Expose a property on this preset.

Public function

URemoteContr...

 

FindOrAddBinding

(
    const TSoftObjectPtr< UObject >& O...
)

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

FName

 

GetEntityName

(
    const FName InDesiredName,
    UObject* InObject,
    const FRCFieldPathInfo& InFieldPat...
)

Get entity name from given Desired or UObject + Field Path

Public function

TArray< TWea...

 

GetExposedEntities

(
    UScriptStruct* EntityType
)

Public function

TArray< TWea...

 

GetExposedEntities()

Get the exposed entities of a certain type.

Public function Const

TArray< TWea...

 

GetExposedEntities()

Get the exposed entities of a certain type.

Public function Const

TWeakPtr< co...

 

GetExposedEntity

(
    const FGuid& ExposedEntityId
)

Get a copy of an exposed entity on the preset.

Public function

TWeakPtr< Ex...

 

GetExposedEntity

(
    const FGuid& ExposedEntityId
)

Get a pointer to an exposed entity on the preset.

Public function Const

FGuid

 

GetExposedEntityId

(
    FName Label
)

Get the ID of an exposed entity using its label.

Public function Const

const UScrip...

 

GetExposedEntityType

(
    const FGuid& ExposedEntityId
)

Get the type of an exposed entity by querying with its id.

Public function Const

const TSet< ...

 

GetExposedEntityTypes()

Get all types of exposed entities currently exposed.

Public function Const

const FGuid ...

 

GetPresetId()

Get this preset's unique ID.

Public function Const

bool

 

IsExposed

(
    const FGuid& ExposedEntityId
)

Returns whether an entity is exposed on the preset.

Public function

FOnActorProp...

 

OnActorPropertyModified()

Public function

FOnPresetEnt...

 

OnEntitiesUpdated()

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

Public function

FOnPresetEnt...

 

OnEntityExposed()

Public function

FOnPresetEnt...

 

OnEntityUnexposed()

Public function

FOnPresetExp...

 

OnExposedPropertiesModified()

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

Public function

FOnPresetFie...

 

OnFieldRenamed()

Public function

FOnPresetMet...

 

OnMetadataModified()

Public function

FOnPresetLay...

 

OnPresetLayoutModified()

Public function

void

 

RebindAllEntitiesUnderSameActor

(
    const FGuid& EntityId,
    AActor* NewActor
)

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

Public function

void

 

RebindUnboundEntities()

Attempt to rebind all currently unbound properties.

Public function

FName

 

RenameExposedEntity

(
    const FGuid& ExposedEntityId,
    FName NewLabel
)

Change the label of an entity.

Public function

void

 

Unexpose

(
    FName EntityLabel
)

Unexpose an entity from the preset.

Public function

void

 

Unexpose

(
    const FGuid& EntityId
)

Unexpose an entity from the preset.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

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& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Typedefs

Constants

Deprecated Functions

Name Description

Public function

FRemoteContr...

 

CreateAndGetTarget

(
    const TArray< UObject* >& Tar...
)

Targets are deprecated in favor of exposing directly on the preset. You do not need to create a target beforehand.

Public function

FName

 

CreateTarget

(
    const TArray< UObject* >& Tar...
)

Targets are deprecated in favor of exposing directly on the preset. You do not need to create a target beforehand.

Public function

void

 

DeleteTarget

(
    FName TargetName
)

Targets are deprecated, you do not need to delete them anymore.

Public function Const

TOptional< F...

 

GetField

(
    FGuid FieldId
)

Use GetExposedEntity instead.

Public function Const

FGuid

 

GetFieldId

(
    FName FieldLabel
)

Use URemoteControlPreset::GetExposedEntityId instead.

Public function Const

TOptional< F...

 

GetFunction

(
    FName FunctionLabel
)

Use GetExposedEntity instead.

Public function Const

TOptional< F...

 

GetFunction

(
    FGuid FunctionId
)

Use GetExposedEntity instead.

Public function Const

FName

 

GetOwnerAlias

(
    FGuid FieldId
)

FRemoteControlTarget is deprecated, access the entity's bindings by accessing FRemoteControlEntity::Bindings.

Public function Const

TOptional< F...

 

GetProperty

(
    FName PropertyLabel
)

Use GetExposedEntity instead.

Public function Const

TOptional< F...

 

GetProperty

(
    FGuid PropertyId
)

Use GetExposedEntity instead.

Public function Const

const TMap< ...

 

GetRemoteControlTargets()

FRemoteControlTarget is deprecated, use URemoteControlPreset::Bindings instead.

Public function

TMap< FName,...

 

GetRemoteControlTargets()

FRemoteControlTarget is deprecated, use URemoteControlPreset::Bindings instead.

Public function

void

 

NotifyExposedPropertyChanged

(
    FName PropertyLabel
)

This function is deprecated.

Public function

FOnPresetPro...

 

OnPropertyExposed()

This delegate is deprecated, use OnEntityExposed instead.

Public function

FOnPresetPro...

 

OnPropertyUnexposed()

This delegate is deprecated, use OnEntityUnexposed instead.

Public function

void

 

RenameField

(
    FName OldFieldLabel,
    FName NewFieldLabel
)

Use RenameExposedEntity instead.

Public function

void

 

RenameTarget

(
    FName TargetName,
    FName NewTargetName
)

Targets are deprecated in favor of bindings, you can now change the name of the binding directly.

Public function

TArray< UObj...

 

ResolvedBoundObjects

(
    FName FieldLabel
)

ResolvedBoundObjects is deprecated, you can now resolve bound objects using FRemoteControlEntity.

Public function Const

TOptional< F...

 

ResolveExposedFunction

(
    FName FunctionLabel
)

Use FRemoteControlFunction::ResolveFieldOwners instead.

Public function Const

TOptional< F...

 

ResolveExposedProperty

(
    FName PropertyLabel
)

Use FRemoteControlProperty::GetProperty and FRemoteControlProperty::ResolveFieldOwners instead.