UMovieGraphValueView

Provides a scripting-friendly way to get/set values, and add/remove properties, in a property bag.

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

Provides a scripting-friendly way to get/set values, and add/remove properties, in a property bag.

Does not protect against invalid property bags. When using, ensure that the property bag that the view is initialized with is valid. The view will also not take ownership of the property bag.

   
Name UMovieGraphValueView
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/MovieGraphValueView.h
Include Path #include "Graph/MovieGraphValueView.h"

Syntax

UCLASS (Abstract)  
class UMovieGraphValueView : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  Graph/MovieGraphValueView.h  
  Graph/MovieGraphValueView.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
PropertyBag FInstancedPropertyBag *   Graph/MovieGraphValueView.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddProperties ( const TArray< FMovieGraphValueViewProperty >& InProperties
)

 Bulk adds properties to the container. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool AddProperty ( const FName& InPropertyName,
const EMovieGraphValueType ValueType,
UObject* InValueTypeObject,
const TMap< FName, FString >& InMetadata
)

 Adds a new property to the container. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"
Gets a reference to the array backing the value, if any. Graph/MovieGraphValueView.h  

int32 GetNumProperties()

 Gets the number of properties that this container holds. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

TMap< FName, FString > GetPropertyMetadata ( const FName& InPropertyName
) const

 Gets the metadata for the given property. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

TArray< FName > GetPropertyNames()

 Gets the names of properties in this container. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueBool ( const FName& InPropertyName,
bool& bOutValue
) const

 Gets the bool value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueByte ( const FName& InPropertyName,
uint8& OutValue
) const

 Gets the byte value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueClass ( const FName& InPropertyName,
UClass*& OutValue
) const

 Gets the UClass value of the held data. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

EMovieGraphContainerType GetValueContainerType ( const FName& InPropertyName
) const

 Gets the container type of the stored value. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueDouble ( const FName& InPropertyName,
double& OutValue
) const

 Gets the double value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueEnum ( const FName& InPropertyName,
uint8& OutValue,
const UEnum* RequestedEnum
) const

 Gets the enum value (for a specific enum) of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueEnum ( const FName& InPropertyName,
T& OutValue
) const

 Gets the enum value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h  

bool GetValueFloat ( const FName& InPropertyName,
float& OutValue
) const

 Gets the float value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueInt32 ( const FName& InPropertyName,
int32& OutValue
) const

 Gets the int32 value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueInt64 ( const FName& InPropertyName,
int64& OutValue
) const

 Gets the int64 value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueName ( const FName& InPropertyName,
FName& OutValue
) const

 Gets the FName value of the held data. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueObject ( const FName& InPropertyName,
T*& OutValue
) const

 Gets the object value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h  

bool GetValueObject ( const FName& InPropertyName,
UObject*& OutValue,
const UClass* RequestedClass
) const

 Gets the object value (for a specific class) of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

FString GetValueSerializedString ( const FName& InPropertyName
) const

 Gets the serialized string value of the held data. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueString ( const FName& InPropertyName,
FString& OutValue
) const

 Gets the FString value of the held data. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool GetValueStruct ( const FName& InPropertyName,
FStructView& OutValue,
const UScriptStruct* RequestedStruct
) const

 Gets the struct value (for a specific struct) of the held data. Graph/MovieGraphValueView.h  

bool GetValueStruct ( const FName& InPropertyName,
T*& OutValue
) const

 Gets the struct value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h  

bool GetValueText ( const FName& InPropertyName,
FText& OutValue
) const

 Gets the FText value of the held data. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

EMovieGraphValueType GetValueType ( const FName& InPropertyName
) const

 Gets the type of the stored data. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

const UObject * GetValueTypeObject ( const FName& InPropertyName
) const

 Gets the object that defines the enum, struct, or class. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool HasProperty ( const FName& InPropertyName
) const

 Returns true if a property by the given name exists in the container, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool IsValid()

 Determines if this view is valid (meaning it points to a non-null property bag, and the bag is valid itself). Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

void RemoveAllProperties()

 Removes all properties and their values, effectively resetting the property bag. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool RemoveProperty ( const FName& InPropertyName
)

 Removes a property by the given name. Returns true on successful remove, otherwise returns false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueBool ( const FName& InPropertyName,
const bool bInValue
)

 Sets the bool value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueByte ( const FName& InPropertyName,
const uint8 InValue
)

 Sets the byte value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueClass ( const FName& InPropertyName,
UClass* InValue
)

 Sets the class value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

void SetValueContainerType ( const FName& InPropertyName,
EMovieGraphContainerType ContainerType
)

 Sets the container type of the stored value. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueDouble ( const FName& InPropertyName,
const double InValue
)

 Sets the double value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueEnum ( const FName& InPropertyName,
const uint8 InValue,
const UEnum* Enum
)

 Sets the enum value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueEnum ( const FName& InPropertyName,
const T InValue
)

 Sets the enum value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h  

bool SetValueFloat ( const FName& InPropertyName,
const float InValue
)

 Sets the float value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueInt32 ( const FName& InPropertyName,
const int32 InValue
)

 Sets the int32 value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueInt64 ( const FName& InPropertyName,
const int64 InValue
)

 Sets the int64 value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueName ( const FName& InPropertyName,
const FName InValue
)

 Sets the FName value of the held data. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueObject ( const FName& InPropertyName,
T* InValue
)

 Sets the object value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h  

bool SetValueObject ( const FName& InPropertyName,
UObject* InValue
)

 Sets the object value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueSerializedString ( const FName& InPropertyName,
const FString& NewValue
)

 Sets the serialized value of the held data. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueString ( const FName& InPropertyName,
const FString& InValue
)

 Sets the FString value of the held data. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

bool SetValueStruct ( const FName& InPropertyName,
FConstStructView InValue
)

 Sets the struct value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h  

bool SetValueStruct ( const FName& InPropertyName,
const T& InValue
)

 Sets the struct value of the held data. Returns true on success, else false. Graph/MovieGraphValueView.h  

bool SetValueText ( const FName& InPropertyName,
const FText& InValue
)

 Sets the FText value of the held data. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

void SetValueType ( const FName& InPropertyName,
EMovieGraphValueType ValueType,
UObject* InValueTypeObject
)

 Sets the type of the stored data. Enums, structs, and classes must specify a value type object. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

void SetValueTypeObject ( const FName& InPropertyName,
const UObject* ValueTypeObject
)

 Sets the object that defines the enum, struct, or class. Graph/MovieGraphValueView.h
  • BlueprintCallable
  • Category="Properties"

void ViewProperties ( FInstancedPropertyBag* InPropertyBag
)

 Update the view to use the specified property bag. Graph/MovieGraphValueView.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page