1. Epic GamesDeveloper
  3. URCVirtualPropertyContainerBase

URCVirtualPropertyContainerBase

Container for more then one Virtual Property

API > API/Plugins > API/Plugins/RemoteControl

Inheritance Hierarchy

References

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

Syntax

UCLASS (BlueprintType)  
class URCVirtualPropertyContainerBase : public UObject

Remarks

Container for more then one Virtual Property

Variables

  Type Name Description
Protected variable UProperty FInstancedPropertyBag Bag Holds bag of properties.
Public variable FOnVirtualPropertyContainerModified OnVirtualPropertyContainerModifiedDelegate Delegate that notifies changes to the virtual property container
Public variable UProperty TWeakObjectPtr< URemoteControlPreset > PresetWeakPtr Pointer to Remote Control Preset
Public variable UProperty TSet< TObjectPtr< URCVirtualPropertyBase > > VirtualProperties Set of the virtual properties

Functions

  Type Name Description
Public function Virtual URCVirtualPropertyInContainer *

AddProperty ( const FName& InPropertyName,
TSubclassOf< URCVirtualPropertyInContainer > InPropertyClass,
const EPropertyBagPropertyType InValueType,
UObject* InValueTypeObject,
TArray< FPropertyBagPropertyDescMetaData > MetaData
)

 Add property to this container.
Public function void Cache this preset's controllers labels.
Public function TSharedPtr< FStructOnScope > Creates new Struct on Scope for this Property Bag UStruct and Memory
Public function Virtual URCVirtualPropertyInContainer *

DuplicateProperty ( const FName& InPropertyName,
const FProperty* InSourceProperty,
TSubclassOf< URCVirtualPropertyInContainer > InPropertyClass
)

 Duplicates a property from given FProperty.
Public function Virtual URCVirtualPropertyInContainer *

DuplicatePropertyWithCopy ( const FName& InPropertyName,
const FProperty* InSourceProperty,
const uint8* InSourceContainerPtr,
TSubclassOf< URCVirtualPropertyInContainer > InPropertyClass
)

 Duplicates a property from a given FProperty and copies the property value That will add property to Property Bag and Create Remote Control Virtual Property
Public function Virtual URCVirtualPropertyInContainer * Given a virtual property this funciton duplicates it (via DuplicateObject) and syncs the internal Controller Container and PropertyBag containers as well.
Public function void Fix controllers labels for older presets.
Public function Static FName

GenerateUniqueDisplayName ( const FName& InPropertyName,
const URCVirtualPropertyContainerBase* InContainer
)

 Generates unique display name for the controllers
Public function Static FName

GenerateUniquePropertyName ( const FName& InPropertyName,
const EPropertyBagPropertyType InValueType,
UObject* InValueTypeObject,
const URCVirtualPropertyContainerBase* InContainer
)

 Generates unique name for the property for specified property container
Public function Static FName

GenerateUniquePropertyName ( const FName& InPropertyName,
const URCVirtualPropertyContainerBase* InContainer
)

 Generates unique name for the property for specified property container
Public function Const int32 Returns number of virtual properties.
Public function Virtual Const TArray< URCVirtualPropertyBase * >

GetVirtualPropertiesByFieldId ( const FName InFieldId
)

 Returns all virtual properties with the specified Field Id
Public function Const URCVirtualPropertyBase *

GetVirtualProperty ( const FGuid& InId
)

 Returns virtual property by unique Id.
Public function Virtual Const URCVirtualPropertyBase *

GetVirtualProperty ( const FName InPropertyName
)

 Returns virtual property by specified name.
Public function Virtual Const URCVirtualPropertyBase *

GetVirtualPropertyByDisplayName ( const FName InDisplayName
)

 Returns virtual property by user-friendly display name (Controller Name)
Public function Virtual Const URCVirtualPropertyBase *

GetVirtualPropertyByFieldId ( const FName InFieldId,
const EPropertyBagPropertyType InType
)

 Returns the first virtual property matching the specified Field Id and ValueType
Public function Virtual Const URCVirtualPropertyBase *

GetVirtualPropertyByFieldId ( const FName InFieldId
)

 Returns the first found virtual property matching the specified Field Id
Public function Virtual void

OnModifyPropertyValue ( const FPropertyChangedEvent& PropertyChangedEvent
)

 Delegate when object changed
Public function Virtual void

OnPreChangePropertyValue ( const FPropertyChangedEvent& PropertyChangedEvent
)

 Delegate when the value is being scrubbed in UI
Public function FOnVirtualPropertyContainerModified &  
Public function Virtual bool

RemoveProperty ( const FName& InPropertyName
)

 Removes a property from the container by name if it exists.
Public function Virtual void

Reset ()

 Resets the property bag instance to empty and remove Virtual Properties
Public function FName

SetControllerDisplayName ( FGuid InGuid,
FName InNewName
)

 Rename the controller with the given InGuid with the InNewName passed as candidate and return the new name
Public function Virtual void

UpdateEntityIds ( const TMap< FGuid, FGuid >& InEntityIdMap
)

 Called internally when entity Ids are renewed.

Overridden from UObject

  Type Name Description
Public function Virtual void Called after applying a transaction to the object.

Typedefs

Name Description
FOnVirtualPropertyContainerModified Returns the delegate that notifies changes to the virtual property container

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page