Navigation
API > API/Plugins > API/Plugins/DMXGDTF
The Fixture Type Attribute is assigned to a LogicalChannel and defines the function of the LogicalChannel. All logical channels that are children of the same DMX channel are mutually exclusive. In a DMX mode, only one logical channel with the same attribute can reference the same geometry at a time. The name of a Logical Channel cannot be user-defined and is equal to the linked attribute name. The XML node of the logical channel is
| Name | FDMXGDTFLogicalChannel |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/DMXModes/DMXGDTFLogicalChannel.h |
| Include Path | #include "GDTF/DMXModes/DMXGDTFLogicalChannel.h" |
Syntax
class FDMXGDTFLogicalChannel : public UE::DMX::GDTF::FDMXGDTFNode
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FDMXGDTFNode → FDMXGDTFLogicalChannel
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDMXGDTFLogicalChannel
(
const TSharedRef< FDMXGDTFDMXChannel >& InDMXChannel |
GDTF/DMXModes/DMXGDTFLogicalChannel.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Attribute | FName | Link to the attribute; The starting point is the Attribute Collect. | GDTF/DMXModes/DMXGDTFLogicalChannel.h | |
| ChannelFunctionArray | TArray< TSharedPtr< FDMXGDTFChannelFunction > > | A list of channel functions | GDTF/DMXModes/DMXGDTFLogicalChannel.h | |
| DMXChangeTimeLimit | float | Minimum fade time for the subordinate channel functions to change DMX values by the control system.DMXChangeTimeLimit is defined for the complete DMX range.Default value : 0; Unit: second | GDTF/DMXModes/DMXGDTFLogicalChannel.h | |
| Master | EDMXGDTFLogicalChannelMaster | Defines if all the subordinate channel functions react to a Group Control defined by the control system. | GDTF/DMXModes/DMXGDTFLogicalChannel.h | |
| MibFade | float | Minimum fade time for moves in black action. | GDTF/DMXModes/DMXGDTFLogicalChannel.h | |
| OuterDMXChannel | const TWeakPtr< FDMXGDTFDMXChannel > | The outer DMX channel | GDTF/DMXModes/DMXGDTFLogicalChannel.h | |
| Snap | EDMXGDTFLogicalChannelSnap | If snap is enabled, the logical channel will not fade between values. | GDTF/DMXModes/DMXGDTFLogicalChannel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FDMXGDTFAttribute > ResolveAttribute() |
Resolves the linked attribute. Returns the attribute, or nullptr if no attribute is linked | GDTF/DMXModes/DMXGDTFLogicalChannel.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/DMXGDTFLogicalChannel.h | |
virtual const TCHAR * GetXmlTag() |
Gets the Xml Tag corresponding to this node | GDTF/DMXModes/DMXGDTFLogicalChannel.h | |
virtual void Initialize
(
const FXmlNode& InXmlNode |
Initializes the node from an Xml node. Called after the node was constructed. | GDTF/DMXModes/DMXGDTFLogicalChannel.h |