Navigation
API > API/Plugins > API/Plugins/DMXGDTF > API/Plugins/DMXGDTF/GDTF > API/Plugins/DMXGDTF/GDTF/Geometries
Inheritance Hierarchy
- FSharedFromThisBase
- TSharedFromThis
- FDMXGDTFNode
- FDMXGDTFGeometryCollectBase
- FDMXGDTFGeometry
- FDMXGDTFLaserGeometry
References
| Module | DMXGDTF |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/Geometries/DMXGDTFLaserGeometry.h |
| Include | #include "GDTF/Geometries/DMXGDTFLaserGeometry.h" |
Syntax
class FDMXGDTFLaserGeometry : public UE::DMX::GDTF::FDMXGDTFGeometry
Remarks
This type of geometry is used to describe the position of a laser’s light output (XML node
Variables
| Type | Name | Description | |
|---|---|---|---|
| float | BeamDiameter | Beam diameter where it leaves the projector; Unit: meter | |
| float | BeamDivergenceMax | Maximum beam divergence; Unit: mrad (milliradian) | |
| float | BeamDivergenceMin | Minimum beam divergence; Unit: mrad (milliradian) | |
| float | Color | Required if ColorType is “SingleWaveLength”; Unit:nm (nanometers) | |
| EDMXLaserGeometryColorType | ColorType | Color type of a Laser | |
| FString | Emitter | (Optional) link to the emitter group. The starting point is the Emitter Collect. | |
| float | OutputStrength | Output Strength of the Laser; Unit: Watt | |
| TArray< TSharedPtr< FDMXGDTFLaserProtocol > > | ProtocolArray | A list of protocols supported by the laser | |
| float | ScanAnglePan | Possible Total Scan Angle Pan of the beam. Assumes symmetrical output; Unit: Degree | |
| float | ScanAngleTilt | Possible Total Scan Angle Tilt of the beam. Assumes symmetrical output; Unit: Degree | |
| float | ScanSpeed | Speed of the beam; Unit: kilo point per second |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FDMXGDTFLaserGeometry
(
const TSharedRef< FDMXGDTFGeometryCollectBase >& InGeometryCollect |
Functions
| Type | Name | Description | |
|---|---|---|---|
| TSharedPtr< FDMXGDTFEmitter > | Resolves the linked emitter. Returns the emitter, or nullptr if no emitter 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. |