FDMXGDTFDMXChannel | Unreal Engine 5.5 Documentation

API > API/Plugins > API/Plugins/DMXGDTF > API/Plugins/DMXGDTF/GDTF > API/Plugins/DMXGDTF/GDTF/DMXModes

Inheritance Hierarchy

References


Module	DMXGDTF
Header	/Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/DMXModes/DMXGDTFDMXChannel.h
Include	#include "GDTF/DMXModes/DMXGDTFDMXChannel.h"

Syntax

class FDMXGDTFDMXChannel : public UE::DMX::GDTF::FDMXGDTFNode

Remarks

This section defines the DMX channel (XML node ). The name of a DMX channel cannot be user-defined and must consist of a geometry name and the attribute name of the first logical channel with the separator "_". In one DMX Mode, this combination needs to be unique.

Variables

Type	Name	Description
FDMXGDTFDMXValue	Default
int32	DMXBreak	Number of the DMXBreak; Default value: 1; Special value: “Overwrite” – means that this number will be overwritten by Geometry Reference; Size: 4 bytes
FName	Geometry	Name of the geometry the current channel controls.
FDMXGDTFDMXValue	Highlight	Highlight value for current channel; Special value : “None”.Default value : “None”
FString	InitialFunction	Link to the channel function that will be activated by default for this DMXChannel.
TArray< TSharedPtr< FDMXGDTFLogicalChannel > >	LogicalChannelArray	A list of logical channels
TArray< uint32 >	Offset	Relative addresses of the current DMX channel from highest to least significant; Size per int: 4 bytes
const TWeakPtr< FDMXGDTFDMXMode >	OuterDMXMode	The outer DMX mode

Constructors

Type	Name	Description
	FDMXGDTFDMXChannel ( const TSharedRef< FDMXGDTFDMXMode >& InDMXMode )
PRAGMA_DISABLE_DEPRECATION_WARNINGS	FDMXGDTFDMXChannel ( const FDMXGDTFDMXChannel& Node )	Explicit constructors, required to avoid deprecation warnings on Clang with deprecated member Default.
	FDMXGDTFDMXChannel ( FDMXGDTFDMXChannel&& Node )

Destructors

	Type	Name	Description
		~FDMXGDTFDMXChannel ()

Functions

Type	Name	Description
TSharedPtr< FDMXGDTFGeometry >	ResolveGeometry ()	Resolves the linked geometry.
TArray< TSharedPtr< FDMXGDTFGeometryReference > >	ResolveGeometryReferences ()	Resolves the linked geometry as geometry references.
TSharedPtr< FDMXGDTFChannelFunction >	ResolveInitialFunction ()	Resolves the linked initial function.

Overridden from FDMXGDTFNode

Type	Name	Description
FXmlNode *	CreateXmlNode ( FXmlNode& Parent )	Creates an XML node in the parent node
PRAGMA_ENABLE_DEPRECATION_WARNINGS 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.