Navigation
API > API/Plugins > API/Plugins/DMXGDTF
This section defines the DMX channel (XML node
| Name | FDMXGDTFDMXChannel |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/DMXModes/DMXGDTFDMXChannel.h |
| Include Path | #include "GDTF/DMXModes/DMXGDTFDMXChannel.h" |
Syntax
class FDMXGDTFDMXChannel : public UE::DMX::GDTF::FDMXGDTFNode
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FDMXGDTFNode → FDMXGDTFDMXChannel
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDMXGDTFDMXChannel
(
const TSharedRef< FDMXGDTFDMXMode >& InDMXMode |
GDTF/DMXModes/DMXGDTFDMXChannel.h | ||
PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXGDTFDMXChannel
(
const FDMXGDTFDMXChannel& Node |
Explicit constructors, required to avoid deprecation warnings on Clang with deprecated member Default. | GDTF/DMXModes/DMXGDTFDMXChannel.h | |
FDMXGDTFDMXChannel
(
FDMXGDTFDMXChannel&& Node |
GDTF/DMXModes/DMXGDTFDMXChannel.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FDMXGDTFDMXChannel() |
GDTF/DMXModes/DMXGDTFDMXChannel.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Default | FDMXGDTFDMXValue | GDTF/DMXModes/DMXGDTFDMXChannel.h | ||
| DMXBreak | int32 | Number of the DMXBreak; Default value: 1; Special value: “Overwrite” – means that this number will be overwritten by Geometry Reference; Size: 4 bytes | GDTF/DMXModes/DMXGDTFDMXChannel.h | |
| Geometry | FName | Name of the geometry the current channel controls. | GDTF/DMXModes/DMXGDTFDMXChannel.h | |
| Highlight | FDMXGDTFDMXValue | Highlight value for current channel; Special value : “None”.Default value : “None” | GDTF/DMXModes/DMXGDTFDMXChannel.h | |
| InitialFunction | FString | Link to the channel function that will be activated by default for this DMXChannel. | GDTF/DMXModes/DMXGDTFDMXChannel.h | |
| LogicalChannelArray | TArray< TSharedPtr< FDMXGDTFLogicalChannel > > | A list of logical channels | GDTF/DMXModes/DMXGDTFDMXChannel.h | |
| Offset | TArray< uint32 > | Relative addresses of the current DMX channel from highest to least significant; Size per int: 4 bytes | GDTF/DMXModes/DMXGDTFDMXChannel.h | |
| OuterDMXMode | const TWeakPtr< FDMXGDTFDMXMode > | The outer DMX mode | GDTF/DMXModes/DMXGDTFDMXChannel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Resolves the linked geometry. | GDTF/DMXModes/DMXGDTFDMXChannel.h | ||
| Resolves the linked geometry as geometry references. | GDTF/DMXModes/DMXGDTFDMXChannel.h | ||
| Resolves the linked initial function. | GDTF/DMXModes/DMXGDTFDMXChannel.h |
Overridden from FDMXGDTFNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FXmlNode * CreateXmlNode
(
FXmlNode& Parent |
Creates an XML node in the parent node | GDTF/DMXModes/DMXGDTFDMXChannel.h | |
virtual const TCHAR * GetXmlTag() |
Gets the Xml Tag corresponding to this node | GDTF/DMXModes/DMXGDTFDMXChannel.h | |
virtual void Initialize
(
const FXmlNode& InXmlNode |
Initializes the node from an Xml node. Called after the node was constructed. | GDTF/DMXModes/DMXGDTFDMXChannel.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDMXGDTFDMXChannel & operator=
(
const FDMXGDTFDMXChannel& Node |
GDTF/DMXModes/DMXGDTFDMXChannel.h | ||
FDMXGDTFDMXChannel & operator=
(
FDMXGDTFDMXChannel&& Node |
GDTF/DMXModes/DMXGDTFDMXChannel.h |