Navigation
API > API/Plugins > API/Plugins/DMXRuntime
MVR General Scene Description Object
| Name | UDMXMVRGeneralSceneDescription |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/MVR/DMXMVRGeneralSceneDescription.h |
| Include Path | #include "MVR/DMXMVRGeneralSceneDescription.h" |
Syntax
UCLASS ()
class UDMXMVRGeneralSceneDescription : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDMXMVRGeneralSceneDescription
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDMXMVRGeneralSceneDescription() |
Constructor | MVR/DMXMVRGeneralSceneDescription.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FDMXMVRGeneralSceneDescriptionWorldParams | UE::DMX::FDMXMVRGeneralSceneDescriptionWorldParams | MVR/DMXMVRGeneralSceneDescription.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MVRAssetImportData | TObjectPtr< UDMXMVRAssetImportData > | Import Data for this asset | MVR/DMXMVRGeneralSceneDescription.h | |
| RootNode | TObjectPtr< UDMXMVRRootNode > | The Root Node of the General Scene Description | MVR/DMXMVRGeneralSceneDescription.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanCreateXmlFile
(
FText& OutReason |
Returns true if an Xml File can be created. Gives a reason if no MVR can be exported | MVR/DMXMVRGeneralSceneDescription.h | |
TSharedPtr< FXmlFile > CreateXmlFile() |
Creates an General Scene Description Xml File from this. | MVR/DMXMVRGeneralSceneDescription.h | |
UDMXMVRFixtureNode * FindFixtureNode
(
const FGuid& FixtureUUID |
Returns the Fixture Node corresponding to the UUID, or nullptr if it cannot be found | MVR/DMXMVRGeneralSceneDescription.h | |
void GetFixtureNodes
(
TArray< UDMXMVRFixtureNode* >& OutFixtureNodes |
Gets the MVR Fixture Nodes in this General Scene Description | MVR/DMXMVRGeneralSceneDescription.h | |
UDMXMVRAssetImportData * GetMVRAssetImportData() |
Returns MVR Asset Import Data for this asset | MVR/DMXMVRGeneralSceneDescription.h | |
void RemoveFixtureNode
(
const FGuid& FixtureUUID |
Removes a fixture node from the General Scene Description. | MVR/DMXMVRGeneralSceneDescription.h | |
void WriteDMXLibrary
(
const UDMXLibrary& DMXLibrary, |
Writes the Library to the General Scene Description, effectively removing inexisting and adding new MVR Fixtures, according to what MVR Fixture UUIDs the Fixture Patches of the Library contain. | MVR/DMXMVRGeneralSceneDescription.h | |
void WriteDMXLibraryToGeneralSceneDescription
(
const UDMXLibrary& DMXLibrary |
DEPRECATED 5.5 | MVR/DMXMVRGeneralSceneDescription.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UDMXMVRGeneralSceneDescription * CreateFromDMXLibrary
(
const UDMXLibrary& DMXLibrary, |
Creates an MVR General Scene Description from a DMX Library | MVR/DMXMVRGeneralSceneDescription.h | |
static UDMXMVRGeneralSceneDescription * CreateFromXmlFile
(
TSharedRef< FXmlFile > GeneralSceneDescriptionXml, |
Creates an MVR General Scene Description from an Xml File | MVR/DMXMVRGeneralSceneDescription.h |