Navigation
API > API/Plugins > API/Plugins/RemoteControl
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- URCVirtualPropertyContainerBase
- URCControllerContainer
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 | |
|---|---|---|---|
| FInstancedPropertyBag | Bag | Holds bag of properties. | |
| FOnVirtualPropertyContainerModified | OnVirtualPropertyContainerModifiedDelegate | Delegate that notifies changes to the virtual property container | |
| TWeakObjectPtr< URemoteControlPreset > | PresetWeakPtr | Pointer to Remote Control Preset | |
| TSet< TObjectPtr< URCVirtualPropertyBase > > | VirtualProperties | Set of the virtual properties |
Functions
| Type | Name | Description | |
|---|---|---|---|
| URCVirtualPropertyInContainer * | AddProperty
(
const FName& InPropertyName, |
Add property to this container. | |
| void | Cache this preset's controllers labels. | ||
| TSharedPtr< FStructOnScope > | Creates new Struct on Scope for this Property Bag UStruct and Memory | ||
| URCVirtualPropertyInContainer * | DuplicateProperty
(
const FName& InPropertyName, |
Duplicates a property from given FProperty. | |
| URCVirtualPropertyInContainer * | DuplicatePropertyWithCopy
(
const FName& InPropertyName, |
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 | |
| 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. | |
| void | Fix controllers labels for older presets. | ||
| FName | GenerateUniqueDisplayName
(
const FName& InPropertyName, |
Generates unique display name for the controllers | |
| FName | GenerateUniquePropertyName
(
const FName& InPropertyName, |
Generates unique name for the property for specified property container | |
| FName | GenerateUniquePropertyName
(
const FName& InPropertyName, |
Generates unique name for the property for specified property container | |
| int32 | Returns number of virtual properties. | ||
| TArray< URCVirtualPropertyBase * > | GetVirtualPropertiesByFieldId
(
const FName InFieldId |
Returns all virtual properties with the specified Field Id | |
| URCVirtualPropertyBase * | GetVirtualProperty
(
const FGuid& InId |
Returns virtual property by unique Id. | |
| URCVirtualPropertyBase * | GetVirtualProperty
(
const FName InPropertyName |
Returns virtual property by specified name. | |
| URCVirtualPropertyBase * | GetVirtualPropertyByDisplayName
(
const FName InDisplayName |
Returns virtual property by user-friendly display name (Controller Name) | |
| URCVirtualPropertyBase * | GetVirtualPropertyByFieldId
(
const FName InFieldId, |
Returns the first virtual property matching the specified Field Id and ValueType | |
| URCVirtualPropertyBase * | GetVirtualPropertyByFieldId
(
const FName InFieldId |
Returns the first found virtual property matching the specified Field Id | |
| void | OnModifyPropertyValue
(
const FPropertyChangedEvent& PropertyChangedEvent |
Delegate when object changed | |
| void | OnPreChangePropertyValue
(
const FPropertyChangedEvent& PropertyChangedEvent |
Delegate when the value is being scrubbed in UI | |
| FOnVirtualPropertyContainerModified & | |||
| bool | RemoveProperty
(
const FName& InPropertyName |
Removes a property from the container by name if it exists. | |
| void | Reset () |
Resets the property bag instance to empty and remove Virtual Properties | |
| FName | SetControllerDisplayName
(
FGuid InGuid, |
Rename the controller with the given InGuid with the InNewName passed as candidate and return the new name | |
| void | UpdateEntityIds
(
const TMap< FGuid, FGuid >& InEntityIdMap |
Called internally when entity Ids are renewed. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditUndo () |
Called after applying a transaction to the object. |
Typedefs
| Name | Description |
|---|---|
| FOnVirtualPropertyContainerModified | Returns the delegate that notifies changes to the virtual property container |