Navigation
API > API/Plugins > API/Plugins/DMXGDTF
This type of geometry is used to describe the position of a laser’s light output (XML node
| Name | FDMXGDTFLaserGeometry |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/Geometries/DMXGDTFLaserGeometry.h |
| Include Path | #include "GDTF/Geometries/DMXGDTFLaserGeometry.h" |
Syntax
class FDMXGDTFLaserGeometry : public UE::DMX::GDTF::FDMXGDTFGeometry
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FDMXGDTFNode → FDMXGDTFGeometryCollectBase → FDMXGDTFGeometry → FDMXGDTFLaserGeometry
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDMXGDTFLaserGeometry
(
const TSharedRef< FDMXGDTFGeometryCollectBase >& InGeometryCollect |
GDTF/Geometries/DMXGDTFLaserGeometry.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BeamDiameter | float | Beam diameter where it leaves the projector; Unit: meter | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
| BeamDivergenceMax | float | Maximum beam divergence; Unit: mrad (milliradian) | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
| BeamDivergenceMin | float | Minimum beam divergence; Unit: mrad (milliradian) | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
| Color | float | Required if ColorType is “SingleWaveLength”; Unit:nm (nanometers) | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
| ColorType | EDMXLaserGeometryColorType | Color type of a Laser | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
| Emitter | FString | (Optional) link to the emitter group. The starting point is the Emitter Collect. | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
| OutputStrength | float | Output Strength of the Laser; Unit: Watt | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
| ProtocolArray | TArray< TSharedPtr< FDMXGDTFLaserProtocol > > | A list of protocols supported by the laser | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
| ScanAnglePan | float | Possible Total Scan Angle Pan of the beam. Assumes symmetrical output; Unit: Degree | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
| ScanAngleTilt | float | Possible Total Scan Angle Tilt of the beam. Assumes symmetrical output; Unit: Degree | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
| ScanSpeed | float | Speed of the beam; Unit: kilo point per second | GDTF/Geometries/DMXGDTFLaserGeometry.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FDMXGDTFEmitter > ResolveEmitter() |
Resolves the linked emitter. Returns the emitter, or nullptr if no emitter is linked | GDTF/Geometries/DMXGDTFLaserGeometry.h |
Overridden from FDMXGDTFNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FXmlNode * CreateXmlNode
(
FXmlNode& Parent |
Creates an XML node in the parent node | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
virtual const TCHAR * GetXmlTag() |
Gets the Xml Tag corresponding to this node | GDTF/Geometries/DMXGDTFLaserGeometry.h | |
virtual void Initialize
(
const FXmlNode& InXmlNode |
Initializes the node from an Xml node. Called after the node was constructed. | GDTF/Geometries/DMXGDTFLaserGeometry.h |