1. Epic GamesDeveloper
  3. DMXGDTF

DMXGDTF

API > API/Plugins

   
Name DMXGDTF
Type Plugin
Part of Plugins DMX GDTF
Location /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/
Module Build Rules DMXGDTF.Build.cs

Classes

Name Remarks
FDMXGDTFActivationGroup This section defines the activation group Attributes (XML node ).
FDMXGDTFAnimationSystem This section can only be defined for the animation system disk and it describes the animation system behavior (XML node ).
FDMXGDTFAttribute  
FDMXGDTFAttributeDefinitions This section defines the attribute definition collect for the Fixture Type Attributes.
FDMXGDTFAxisGeometry This type of geometry defines device parts with a rotation axis (XML node ).
FDMXGDTFBeamGeometry It is a basic geometry type without specification (XML node ).
FDMXGDTFChannelFunction The Fixture Type Attribute is assigned to a Channel Function and defines the function of its DMX Range.
FDMXGDTFChannelRelation This section defines the relation between the master DMX channel and the following logical channel(XML node ).
FDMXGDTFChannelSet This section defines the channel sets of the channel function (XML node ).
FDMXGDTFColorRenderingIndex This section defines the DMX ColorRenderingIndex description (XML node ).
FDMXGDTFColorRenderingIndexGroup This section contains CRIs for a single color temperature (XML node ).
FDMXGDTFColorSpace This section defines the description of the ColorSpace (XML node ).
FDMXGDTFDescription The Description of a GDTF, corresponds to the description.xml of the GDTF.
FDMXGDTFDisplayGeometry This type of geometry is used to describe a self-emitting surface which is used to display visual media (XML node )
FDMXGDTFDMXChannel This section defines the DMX channel (XML node ).
FDMXGDTFDMXMode Each DMX mode describes logical control a part of the device in a specific mode (XML node ).
FDMXGDTFDMXPersonality For each supported software version add an XML node ..
FDMXGDTFDMXProfile This section defines the DMX profile description (XML node ).
FDMXGDTFDMXProfilePoint This section contains points to define the DMX profile (XML node ).
FDMXGDTFEmitter This section defines the description of the emitter (XML node ).
FDMXGDTFEmitterMeasurement Measurement for emitters
FDMXGDTFFeature This section defines the feature.
FDMXGDTFFeatureGroup This section defines the feature group (XML node ).
FDMXGDTFFilter This section defines the description of the filter (XML node ).
FDMXGDTFFilterBeamGeometry This type of geometry defines device parts with a beam filter (XML node ).
FDMXGDTFFilterColorGeometry This type of geometry is used to describe device parts which have a color filter (XML node ).
FDMXGDTFFilterGoboGeometry This type of geometry is used to describe device parts which have gobo wheels (XML node ).
FDMXGDTFFilterMeasurement Measurement for filters
FDMXGDTFFilterShaperGeometry This type of geometry is used to describe device parts which have a shaper (XML node ).
FDMXGDTFFixtureType The FixtureType node is the starting point of the description of the fixture type within the XML file.
FDMXGDTFFTMacro This section defines a DMX sequence. (XML node ).
FDMXGDTFFTPreset This section defines fixture type specific presets.
FDMXGDTFGamut This section defines the color gamut of the fixture (XML node ), which is the set of attainable colors by the fixture.
FDMXGDTFGeometry It is a basic geometry type without specification (XML node ).
FDMXGDTFGeometryBreak This XML node specifies the DMX offset for the DMX channel of the referenced geometry (XML node )
FDMXGDTFGeometryCollect The physical description of the device parts is defined in the geometry collect.
FDMXGDTFGeometryCollectBase UE specific. Bases class for all classes that have a geometry collect.
FDMXGDTFGeometryReference The Geometry Type Reference is used to describe multiple instances of the same geometry.
FDMXGDTFInventoryGeometry This type of geometry is used to describe a geometry used for the inventory (XML node ).
FDMXGDTFLaserGeometry This type of geometry is used to describe the position of a laser’s light output (XML node )
FDMXGDTFLaserProtocol This XML node specifies the protocol for a Laser (XML node )
FDMXGDTFLegHeight This section defines the height of the legs (XML node ).
FDMXGDTFLogicalChannel The Fixture Type Attribute is assigned to a LogicalChannel and defines the function of the LogicalChannel.
FDMXGDTFMacroDMX This section defines the sequence of DMX values which are sent by a control system.
FDMXGDTFMacroDMXStep This section defines a DMX step (XML node ).
FDMXGDTFMacroDMXValue This section defines the value for DMX channel (XML node ).
FDMXGDTFMagnetGeometry This type of geometry is used to describe a magnet, a point where other geometries should be attached (XML node ).
FDMXGDTFMeasurementBase The measurement defines the relation between the requested output by a control channel and the physically achieved intensity.
FDMXGDTFMeasurementPoint The measurement point defines the energy of a specific wavelength of a spectrum.
FDMXGDTFMediaServerCameraGeometry This type of geometry is used to describe the layer of a media device that is used for representation of media files (XML node ).
FDMXGDTFMediaServerLayerGeometry This type of geometry is used to describe the layer of a media device that is used for representation of media files (XML node ).
FDMXGDTFMediaServerMasterGeometry This type of geometry is used to describe the master control of one or several media devices (XML node ).
FDMXGDTFModel Each device is divided into smaller parts: body, yoke, head and so on.
FDMXGDTFNode Base class for GDTF nodes.
FDMXGDTFOperatingTemperature This section defines the description of the OperatingTemperature (XML node ).
FDMXGDTFPhysicalDescriptions This section describes the physical constitution of the device.
FDMXGDTFPrismFacet This section can only be defined for the prism wheel slot and has a description for the prism facet (XML node ).
FDMXGDTFProperties This section defines the description of the Properties (XML node ).
FDMXGDTFProtocolArtNet If the device supports the Art-Net protocol, this section defines the corresponding information (XML node ).
FDMXGDTFProtocolArtNetDMXMap  
FDMXGDTFProtocolDMXMapBase To define a custom mapping between Streaming ACN values and DMX Stream values you can add an XML node as a child.
FDMXGDTFProtocolFTRDM This section defines the overall ProtocolRDM of the device (XML node ).
FDMXGDTFProtocols This section defines the overall Protocols of the device (XML node ).
FDMXGDTFProtocolSACN If the device supports the Art-Net protocol, this section defines the corresponding information (XML node ).
FDMXGDTFProtocolSACNDMXMap  
FDMXGDTFRevision This section defines one revision of a the device type (XML node Revision>).
FDMXGDTFSoftwareVersionID For each supported software version add an XML node ..
FDMXGDTFStructureGeometry This type of geometry is used to describe a structure (XML node ).
FDMXGDTFSubchannelSet This section defines the sub channel sets of the channel function (XML node ).
FDMXGDTFSubphysicalUnit  
FDMXGDTFSupportGeometry This type of geometry is used to describe a support (XML node ).
FDMXGDTFWeight This section defines the overall weight of the device (XML node ).
FDMXGDTFWheel Each wheel describes a single physical or virtual wheel of the fixture type.
FDMXGDTFWheelSlot The wheel slot represents a slot on the wheel (XML node ).
FDMXGDTFWiringObjectGeometry This type of geometry is used to describe an electrical device that can be wired (XML node ).
FDMXGDTFWiringObjectPinPatch This node (XML node ) specifies how the different sockets of its parent wiring object are connected to the pins of other wiring objects
UDMXGDTF The implementation of the GDTF standard in Unreal Engine.

Structs

Name Remarks
FDMXGDTFColorCIE1931xyY XyY color representation in the CIE 1931 color space, as typically used in GDTF and MVR
FDMXGDTFDMXAddress The container for DMX Addresses
FDMXGDTFDMXValue Special type to define DMX value where n is the byte count.
FDMXGDTFVersion Version of the GDTF standard currently being used by the engine

Enums

Public

Name Remarks
EDMXGDTFBeamGeometryBeamType Beam Type; Specified values: “Wash”, “Spot”, “None”, “Rectangle”; “PC”, “Fresnel”, “Glow”.
EDMXGDTFBeamGeometryLampType Defines type of the light source; The currently defined types are: Discharge, Tungsten, Halogen, LED; Default value “Discharge”
EDMXGDTFChannelRelationType Type of the relation; Values: “Multiply”, “Override”
EDMXGDTFColorSpaceMode Measurement interpolation to
EDMXGDTFGeometrySupportType The type of support. Defined values are “Rope”, “GroundSupport”.
EDMXGDTFLogicalChannelMaster Defines if all the subordinate channel functions react to a Group Control defined by the control system.
EDMXGDTFLogicalChannelSnap If snap is enabled, the logical channel will not fade between values.
EDMXGDTFMeasurementInterpolationTo Measurement interpolation to
EDMXGDTFModelPrimitiveType Type of 3D model; The currently defined values are: “Undefined”, “Cube”, “Cylinder”, “Sphere”, “Base”, “Yoke”, “Head”, “Scanner”, “Conventional”, “Pigtail”, “Base1_1”, “Scanner1_1”, “Conventional1_1”; Default value: “Undefined"
EDMXGDTFPhysicalUnit Attribute Pyhsical Unit.
EDMXGDTFStructureGeometryCrossSectionType The type of cross section. Defined values are “TrussFramework”, “Tube”.
EDMXGDTFStructureGeometryType The type of structure. Defined values are “CenterLineBased”, “Detail”.
EDMXGDTFSubphysicalUnit Subphysical Unit Type.
EDMXLaserGeometryColorType Color type of a Laser Geometry.
EDMXWiringObjectGeometryComponentType The type of the electrical component used.
EDMXWiringObjectGeometryFuseRating Fuse Rating.Defined values are “B”, “C”, “D”, “K”, “Z”.
EDMXWiringObjectGeometryOrientation Where the pins are placed on the object.Defined values are “Left”, “Right”, “Top”, “Bottom”.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page