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