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