Navigation
API > API/Plugins > API/Plugins/DMXGDTF > API/Plugins/DMXGDTF/GDTF > API/Plugins/DMXGDTF/GDTF/DMXModes
Inheritance Hierarchy
- FSharedFromThisBase
- TSharedFromThis
- FDMXGDTFNode
- FDMXGDTFDMXMode
References
| Module | DMXGDTF |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/DMXModes/DMXGDTFDMXMode.h |
| Include | #include "GDTF/DMXModes/DMXGDTFDMXMode.h" |
Syntax
class FDMXGDTFDMXMode : public UE::DMX::GDTF::FDMXGDTFNode
Remarks
Each DMX mode describes logical control a part of the device in a specific mode (XML node
Variables
| Type | Name | Description | |
|---|---|---|---|
| FString | Description | Description of the DMX mode. | |
| TArray< TSharedPtr< FDMXGDTFDMXChannel > > | DMXChannels | Description of all DMX channels used in the mode | |
| TArray< TSharedPtr< FDMXGDTFFTMacro > > | FTMacros | Is used to describe macros of the manufacturer. | |
| FName | Geometry | The first geometry in the device; Only top level geometries are allowed to be linked | |
| FName | Name | The unique name of the DMX mode | |
| const TWeakPtr< FDMXGDTFFixtureType > | OuterFixtureType | The outer fixture type | |
| TArray< TSharedPtr< FDMXGDTFChannelRelation > > | Relations | Description of relations between channels |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FDMXGDTFDMXMode
(
const TSharedRef< FDMXGDTFFixtureType >& InFixtureType |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | ResolveChannel
(
const FString& Link, |
Resolves a DMX channel or channel function | |
| TSharedPtr< FDMXGDTFGeometry > | Resolves the Geometry for this mode |
Overridden from FDMXGDTFNode
| Type | Name | Description | |
|---|---|---|---|
| FXmlNode * | CreateXmlNode
(
FXmlNode& Parent |
Creates an XML node in the parent node | |
| const TCHAR * | GetXmlTag () |
Gets the Xml Tag corresponding to this node | |
| void | Initialize
(
const FXmlNode& InXmlNode |
Initializes the node from an Xml node. Called after the node was constructed. |