FRemoteControlEntity

Base class for exposed objects, properties, functions etc...

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

RemoteControl

Header

/Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlEntity.h

Include

#include "RemoteControlEntity.h"

Syntax

USTRUCT(BlueprintType)
struct FRemoteControlEntity

Remarks

Base class for exposed objects, properties, functions etc...

Variables

Name Description

Protected variable UProperty

TArray< TWeakOb...

 

Bindings

The bound objects that are exposed or that hold the exposed entity.

Protected variable UProperty Category BlueprintReadOnly visibleanywhere

FGuid

 

Id

Unique identifier for this entity

Protected variable UProperty Category BlueprintReadOnly visibleanywhere

FName

 

Label

This exposed entity's alias.

Protected variable

FOnEntityModifi...

 

OnEntityModifiedDelegate

Protected variable UProperty Category BlueprintReadOnly

TWeakObjectPtr<...

 

Owner

The preset that owns this entity.

Protected variable UProperty

TMap< FName, FS...

 

UserMetadata

User specified metadata for this entity.

Constructors

Name Description

Public function

FRemoteControlEntity()

Protected function

FRemoteControlEntity

(
    URemoteControlPreset* InPreset,
    FName InLabel,
    const TArray< URemoteControlBinding...
)

Destructors

Name Description

Public function Virtual

~FRemoteControlEntity()

Functions

Name Description

Public function Virtual

void

 

BindObject

(
    UObject* InObjectToBind
)

Change the object this exposed entity is currently pointing to.

Public function Virtual Const

bool

 

CanBindObject

(
    const UObject* InObjectToBind
)

Return whether this entity supports binding to a given object.

Public function Const

const TArray...

 

GetBindings()

Get the unresolved bindings of this exposed entity.

Public function Const

TArray< UObj...

 

GetBoundObjects()

Get all resolved bindings under this entity.

Public function Const

FGuid

 

GetId()

Get the id of this entity.

Public function Const

FName

 

GetLabel()

Get the label of this entity.

Public function Const

const TMap< ...

 

GetMetadata()

Get the entity's metadata.

Public function

URemoteContr...

 

GetOwner()

Get the preset that owns this entity.

Public function Const

const UScrip...

 

GetStruct()

Get the type of this remote control entity.

Public function Virtual Const

UClass *

 

GetSupportedBindingClass()

Get the class of the object that can hold this field.

Public function Virtual Const

uint32

 

GetUnderlyingEntityIdentifier()

Get an identifier for the underlying entity.

Public function Virtual Const

bool

 

IsBound()

Returns whether this entity can be resolved using its bound objects.

Public function

void

 

RemoveMetadataEntry

(
    FName Key
)

Remove a metadata entry.

Public function

FName

 

Rename

(
    FName NewLabel
)

Change this entity's label.

Public function

void

 

SetMetadataValue

(
    FName Key,
    FString Value
)

Find or add a value in the entity's metadata map.

Operators

Name Description

Public function Const

bool

 

operator==

(
    const FRemoteControlEntity& InEnti...
)

Public function Const

bool

 

operator==

(
    FGuid InEntityId
)

Typedefs

Name

Description

FOnEntityModified

Delegate called when the label of this entity changes or if one of its binding is updated.