Navigation
API > API/Plugins > API/Plugins/DMXRuntime
The root node of an MVR General Scene Description as typically held in an MVR's GeneralSceneDescription.xml.
UE specific: Note, while properties follow the standard closely, only children relevant to the Engine are implemented.
| Name | UDMXMVRRootNode |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/MVR/Types/DMXMVRRootNode.h |
| Include Path | #include "MVR/Types/DMXMVRRootNode.h" |
Syntax
UCLASS ()
class UDMXMVRRootNode : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDMXMVRRootNode
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDMXMVRRootNode() |
Constructor | MVR/Types/DMXMVRRootNode.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SceneNode | TObjectPtr< UDMXMVRSceneNode > | This node contains information about the scene. | MVR/Types/DMXMVRRootNode.h | |
| UserDataNode | TObjectPtr< UDMXMVRUserDataNode > | This node contains a collection of user data nodes defined and used by provider applications if required. | MVR/Types/DMXMVRRootNode.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FXmlFile > CreateXmlFile() |
Creates a DMX Xml Node as per MVR standard, returns nullptr if the Xml File cannot be created. | MVR/Types/DMXMVRRootNode.h | |
TObjectPtr< UDMXMVRParametricObjectNodeBase > * FindParametricObjectNodeByUUID
(
const FGuid& UUID |
Returns a pointer ot the Parametric Object Node that corresponds to the UUID, or nullptr if there is no corresponding Parametric Object Node | MVR/Types/DMXMVRRootNode.h | |
void GetFixtureNodes
(
TArray< UDMXMVRFixtureNode* >& OutFixtureNodes |
Returns the Fixture Nodes contained in this Layer. Note, does not clear the array. | MVR/Types/DMXMVRRootNode.h | |
UDMXMVRChildListNode & GetOrCreateFirstChildListNode() |
Returns the first Child List Node in the Scene | MVR/Types/DMXMVRRootNode.h | |
UDMXMVRSceneNode * GetSceneNode() |
Returns the node that contains information about the mvr scene | MVR/Types/DMXMVRRootNode.h | |
bool InitializeFromGeneralSceneDescriptionXml
(
const TSharedRef< FXmlFile >& GeneralSceneDescriptionXml |
Initializes the Object and its children from a General Scene Description Xml File. | MVR/Types/DMXMVRRootNode.h | |
bool RemoveParametricObjectNode
(
UDMXMVRParametricObjectNodeBase* ParametricObjectNode |
Removes the Parametric Object Node from the General Scene Description. | MVR/Types/DMXMVRRootNode.h |