Navigation
API > API/Plugins > API/Plugins/DMXGDTF > API/Plugins/DMXGDTF/GDTF > API/Plugins/DMXGDTF/GDTF/DMXModes
Inheritance Hierarchy
- FSharedFromThisBase
- TSharedFromThis
- FDMXGDTFNode
- FDMXGDTFChannelFunction
References
| Module | DMXGDTF |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/DMXModes/DMXGDTFChannelFunction.h |
| Include | #include "GDTF/DMXModes/DMXGDTFChannelFunction.h" |
Syntax
class FDMXGDTFChannelFunction : public UE::DMX::GDTF::FDMXGDTFNode
Remarks
The Fixture Type Attribute is assigned to a Channel Function and defines the function of its DMX Range. (XML node
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FString | Attribute | Link to attribute. |
 |
TArray< TSharedPtr< FDMXGDTFChannelSet > > | ChannelSetArray | A list of channel sets |
 |
FString | ColorSpace | (Optional) Link to a color space in the physical description; Starting point: Physical Descriptions Collect |
 |
FString | CustomName | Custom Name that can he used do adress this channel function with other command based protocols like OSC. |
 |
FDMXGDTFDMXValue | Default | Default DMX value of channel function when activated by the control system. |
 |
FDMXGDTFDMXValue | DMXFrom | Start DMX value; The end DMX value is calculated as a DMXFrom of the next channel function -1 or the maximum value of the DMX channel. |
 |
FString | DMXProfile | (Optional) Link to DMX Profile; Starting point: DMX Profile Collect |
 |
FString | Emitter | (Optional) Link to an emitter in the physical description; Starting point: Emitter Collect |
 |
FString | Filter | (Optional) Link to a filter in the physical description; Starting point: Filter Collect |
 |
FString | Gamut | (Optional) Link to a gamut in the physical description; Starting point: Gamut Collect |
 |
float | Max | Maximum Physical Value that will be used for the DMX Profile. Default: Value from PhysicalTo |
 |
float | Min | Minimum Physical Value that will be used for the DMX Profile. Default: Value from PhysicalFrom 1 |
 |
FDMXGDTFDMXValue | ModeFrom | Only used together with ModeMaster; DMX start value; Default value: 0/1 |
 |
FString | ModeMaster | (Optional) Link to DMX Channel or Channel Function; Starting point DMX mode. |
 |
FDMXGDTFDMXValue | ModeTo | Only used together with ModeMaster; DMX start value; Default value: 0/1 |
 |
FName | Name | Unique name; Default value: Name of attribute and number of channel function. |
 |
FString | OriginalAttribute | The manufacturer’s original name of the attribute; Default: empty |
 |
const TWeakPtr< FDMXGDTFLogicalChannel > | OuterLogicalChannel | The outer logical channel |
 |
float | PhysicalFrom | Physical start value; Default value : 0 |
 |
float | PhysicalTo | Physical end value; Default value : 1 |
 |
float | RealAcceleration | Time in seconds to accelerate from stop to maximum velocity; Default value : 0 |
 |
float | RealFade | Time in seconds to move from min to max of the Channel Function; Default value : 0 |
 |
TArray< TSharedPtr< FDMXGDTFSubchannelSet > > | SubchannelSetArray | A list of subchannel sets |
 |
FString | Wheel | (Optional) Link to a wheel; Starting point: Wheel Collect |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FDMXGDTFChannelFunction
(
const TSharedRef< FDMXGDTFLogicalChannel >& InLogicalChannel |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FDMXGDTFDMXValue | ParseDefault
(
const FString& Value, |
Parses the default value. |
  |
TSharedPtr< FDMXGDTFAttribute > | Resolves the linked attribute. Returns the attribute, or nullptr if no attribute is linked | |
  |
TSharedPtr< FDMXGDTFColorSpace > | Resolves the linked color space. Returns the color space, or nullptr if no color space is linked | |
  |
TSharedPtr< FDMXGDTFDMXProfile > | Resolves the linked DMX profile. Returns the DMX profile, or nullptr if no DMX profile is linked | |
  |
TSharedPtr< FDMXGDTFEmitter > | Resolves the linked emitter. Returns the emitter, or nullptr if no emitter is linked | |
  |
TSharedPtr< FDMXGDTFFilter > | Resolves the linked filter. Returns the filter, or nullptr if no filter is linked | |
  |
TSharedPtr< FDMXGDTFGamut > | ResolveGamut () |
Resolves the linked gamut. Returns the gamut, or nullptr if no gamut is linked |
  |
void | ResolveModeMaster
(
TSharedPtr< FDMXGDTFDMXChannel >& OutDMXChannel, |
Resolves the linked mode master. |
  |
void | ResolveModePrimary
(
TSharedPtr< FDMXGDTFDMXChannel >& OutDMXChannel, |
Same as resolve mode master but using inclusive language |
  |
TSharedPtr< FDMXGDTFWheel > | ResolveWheel () |
Resolves the linked wheel. Returns the wheel, or nullptr if no wheel is linked |
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. |