Navigation
API > API/Plugins > API/Plugins/DMXGDTF
It is a basic geometry type without specification (XML node
The beam geometry emits its light into negative Z direction (and Y-up)
| Name | FDMXGDTFBeamGeometry |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/Geometries/DMXGDTFBeamGeometry.h |
| Include Path | #include "GDTF/Geometries/DMXGDTFBeamGeometry.h" |
Syntax
class FDMXGDTFBeamGeometry : public UE::DMX::GDTF::FDMXGDTFGeometry
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FDMXGDTFNode → FDMXGDTFGeometryCollectBase → FDMXGDTFGeometry → FDMXGDTFBeamGeometry
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDMXGDTFBeamGeometry
(
const TSharedRef< FDMXGDTFGeometryCollectBase >& InGeometryCollect |
GDTF/Geometries/DMXGDTFBeamGeometry.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BeamAngle | float | Beam angle; Default value: 25,0; Unit: degree | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| BeamRadius | float | Beam radius on starting point. Default value: 0,05; Unit: meter. | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| BeamType | EDMXGDTFBeamGeometryBeamType | Beam Type The |
GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| ColorRenderingIndex | uint8 | The CRI according to ANSI/IES TM-30 is a quantitative measure of the ability of the light source showing the object color naturally as it does as daylight reference. | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| ColorTemperature | float | Color temperature; Default value: 6 000; Unit: kelvin | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| EmitterSpectrum | FString | (Optional) Link to emitter in the physical description; use this to define the white light source of a subtractive color mixing system. | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| FieldAngle | float | Field angle; Default value: 25,0; Unit: degree | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| LampType | EDMXGDTFBeamGeometryLampType | Defines type of the light source | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| LuminousFlux | float | Intensity of all the represented light emitters; Default value: 10 000; Unit: lumen | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| PowerConsumption | float | Power consumption; Default value: 1 000; Unit: Watt | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| RectangleRatio | float | Ratio from Width to Height of the Rectangle Type Beam; Default value: 1.7777; Unit: None | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
| ThrowRatio | float | Throw Ratio of the lens for BeamType Rectangle; Default value: 1; Unit: None | GDTF/Geometries/DMXGDTFBeamGeometry.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Resolves the linked emitter spectrum. | GDTF/Geometries/DMXGDTFBeamGeometry.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/DMXGDTFBeamGeometry.h | |
virtual const TCHAR * GetXmlTag() |
Gets the Xml Tag corresponding to this node | GDTF/Geometries/DMXGDTFBeamGeometry.h | |
virtual void Initialize
(
const FXmlNode& InXmlNode |
Initializes the node from an Xml node. Called after the node was constructed. | GDTF/Geometries/DMXGDTFBeamGeometry.h |