1. Epic GamesDeveloper
  3. URCVirtualPropertyContainerBase

URCVirtualPropertyContainerBase

Container for more then one Virtual Property

API > API/Plugins > API/Plugins/RemoteControl

Container for more then one Virtual Property

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

Syntax

UCLASS (BlueprintType)  
class URCVirtualPropertyContainerBase : public UObject

Inheritance Hierarchy

Derived Classes

Typedefs

Name Type Remarks Include Path
FOnVirtualPropertyContainerModified TMulticastDelegate_NoParams< void > Returns the delegate that notifies changes to the virtual property container RCVirtualPropertyContainer.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Categories TArray< FRCVirtualPropertyCategory >   RCVirtualPropertyContainer.h  
OnVirtualPropertyContainerModifiedDelegate FOnVirtualPropertyContainerModified Delegate that notifies changes to the virtual property container RCVirtualPropertyContainer.h  
PresetWeakPtr TWeakObjectPtr< URemoteControlPreset > Pointer to Remote Control Preset RCVirtualPropertyContainer.h  
VirtualProperties TSet< TObjectPtr< URCVirtualPropertyBase > > Set of the virtual properties RCVirtualPropertyContainer.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ControllerLabelToIdCache TMap< FName, FGuid > Map of Controller Name to GUID. RCVirtualPropertyContainer.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Add property to this container. RCVirtualPropertyContainer.h  

void CacheControllersLabels()

 Cache this preset's controllers labels. RCVirtualPropertyContainer.h  

TSharedPtr< FStructOnScope > CreateStructOnScope()

 Creates new Struct on Scope for this Property Bag UStruct and Memory RCVirtualPropertyContainer.h  

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

 Duplicates a property from given FProperty. RCVirtualPropertyContainer.h  

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 RCVirtualPropertyContainer.h  

virtual URCVirtualPropertyInContainer * DuplicateVirtualProperty ( URCVirtualPropertyInContainer* InVirtualProperty
)

 Given a virtual property this funciton duplicates it (via DuplicateObject) and syncs the internal Controller Container and PropertyBag containers as well. RCVirtualPropertyContainer.h  

void FixAndCacheControllersLabels()

 Fix controllers labels for older presets. RCVirtualPropertyContainer.h  

int32 GetNumVirtualProperties()

 Returns number of virtual properties. RCVirtualPropertyContainer.h  

FStructView GetPropertyBagMutableValue()

 Creates new Struct View for this Property Bag UStruct and Memory RCVirtualPropertyContainer.h  

const UPropertyBag * GetPropertyBagStruct()

 Returns the Property Bag Struct of this Container RCVirtualPropertyContainer.h  

virtual TArray< URCVirtualPropertyBase * > GetVirtualPropertiesByFieldId ( const FName InFieldId
) const

 Returns all virtual properties with the specified Field Id RCVirtualPropertyContainer.h  
Returns virtual property by unique Id. RCVirtualPropertyContainer.h  

virtual URCVirtualPropertyBase * GetVirtualProperty ( const FName InPropertyName
) const

 Returns virtual property by specified name. RCVirtualPropertyContainer.h  

virtual URCVirtualPropertyBase * GetVirtualPropertyByDisplayName ( const FName InDisplayName
) const

 Returns virtual property by user-friendly display name (Controller Name) RCVirtualPropertyContainer.h  

virtual URCVirtualPropertyBase * GetVirtualPropertyByFieldId ( const FName InFieldId,
const EPropertyBagPropertyType InType
) const

 Returns the first virtual property matching the specified Field Id and ValueType RCVirtualPropertyContainer.h  

virtual URCVirtualPropertyBase * GetVirtualPropertyByFieldId ( const FName InFieldId
) const

 Returns the first found virtual property matching the specified Field Id RCVirtualPropertyContainer.h  

bool HasVirtualProperty ( const URCVirtualPropertyBase* InVirtualProperty
) const

 Returns whether this container contains the given property. RCVirtualPropertyContainer.h  

virtual void OnModifyPropertyValue ( const FPropertyChangedEvent& PropertyChangedEvent
)

 Delegate when object changed RCVirtualPropertyContainer.h  

virtual void OnPreChangePropertyValue ( const FPropertyChangedEvent& PropertyChangedEvent
)

 Delegate when the value is being scrubbed in UI RCVirtualPropertyContainer.h  

FOnVirtualPropertyContainerModified & OnVirtualPropertyContainerModified()

   RCVirtualPropertyContainer.h  

virtual bool RemoveProperty ( const FName& InPropertyName
)

 Removes a property from the container by name if it exists. RCVirtualPropertyContainer.h  

virtual void Reset()

 Resets the property bag instance to empty and remove Virtual Properties RCVirtualPropertyContainer.h  

FName SetControllerDisplayName ( FGuid InGuid,
FName InNewName
)

 Rename the controller with the given InGuid with the InNewName passed as candidate and return the new name RCVirtualPropertyContainer.h  

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

 Called internally when entity Ids are renewed. RCVirtualPropertyContainer.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditUndo ()

 Called after applying a transaction to the object. RCVirtualPropertyContainer.h  

Static

Name Remarks Include Path Unreal Specifiers

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

 Generates unique display name for the controllers RCVirtualPropertyContainer.h  

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

 Generates unique name for the property for specified property container RCVirtualPropertyContainer.h  

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

 Generates unique name for the property for specified property container RCVirtualPropertyContainer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page