Navigation
API > API/Plugins > API/Plugins/DMXGDTF
The Description of a GDTF, corresponds to the description.xml of the GDTF.
The descritpion and all related members in this module shall follow the currently implemented GDTF standard. See DMXGDTFVersion for details.
| Name | FDMXGDTFDescription |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/DMXGDTFDescription.h |
| Include Path | #include "GDTF/DMXGDTFDescription.h" |
Syntax
class FDMXGDTFDescription : public TSharedFromThis< FDMXGDTFDescription >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FDMXGDTFDescription
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FixtureType | TSharedPtr< FDMXGDTFFixtureType > | The Fixture Type Child Node | GDTF/DMXGDTFDescription.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FXmlFile > ExportAsXml () |
Exports an Xml file from the node tree in this description. | GDTF/DMXGDTFDescription.h | |
TSharedPtr< FDMXGDTFFixtureType > GetFixtureType() |
Returns the Fixture Type of this GDTF description | GDTF/DMXGDTFDescription.h | |
void InitializeFromDescriptionXml
(
const TSharedRef< FXmlFile >& DescriptionXml |
Initializes this node and its chilren from a GDTF Description.xml | GDTF/DMXGDTFDescription.h | |
void InitializeFromFixtureType
(
const TSharedRef< FDMXGDTFFixtureType >& InFixtureType |
Initializes this object from a GDTF fixture type. | GDTF/DMXGDTFDescription.h |