Navigation
API > API/Plugins > API/Plugins/DMXGDTF
This type of geometry is used to describe an electrical device that can be wired (XML node
| Name | FDMXGDTFWiringObjectGeometry |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/Geometries/DMXGDTFWiringObjectGeometry.h |
| Include Path | #include "GDTF/Geometries/DMXGDTFWiringObjectGeometry.h" |
Syntax
class FDMXGDTFWiringObjectGeometry : public UE::DMX::GDTF::FDMXGDTFGeometry
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FDMXGDTFNode → FDMXGDTFGeometryCollectBase → FDMXGDTFGeometry → FDMXGDTFWiringObjectGeometry
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDMXGDTFWiringObjectGeometry
(
const TSharedRef< FDMXGDTFGeometryCollectBase >& InGeometryCollect |
GDTF/Geometries/DMXGDTFWiringObjectGeometry.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ComponentType | EDMXWiringObjectGeometryComponentType | The type of the electrical component used | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| ConnectorType | FName | The type of the connector.Find a list of predefined types in Annex D.This is not applicable for Component Types Fuses. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| CosPhi | float | The Power Factor of the device. Only for consumers. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| ElectricalPayLoad | float | The electrical consumption in Watts.Only for Consumers.Unit: Watt. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| FrequencyRangeMax | float | The Frequency range’s maximum value.Only for Consumers.Unit: hertz. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| FrequencyRangeMin | float | The Frequency range’s minimum value.Only for Consumers.Unit: hertz. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| FuseCurrent | float | The fuse value.Only for fuses. Unit: ampere. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| FuseRating | EDMXWiringObjectGeometryFuseRating | Fuse Rating | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| Matrix | FTransform | Relative position of geometry | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| MaxPayLoad | float | The maximum electrical payload that this power source can handle. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| Model | FString | Link to the corresponding model. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| Orientation | EDMXWiringObjectGeometryOrientation | Where the pins are placed on the object | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| PinCount | int32 | The number of available pins of the connector type to connect internal wiring to it. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| PinPatchArray | TArray< TSharedPtr< FDMXGDTFWiringObjectPinPatch > > | The wiring object has pin patch children. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| SignalLayer | int32 | The layer of the Signal Type. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| SignalType | FString | The type of the signal used.Predefinded values are “Power”, “DMX512”, “Protocol”, “AES”, “AnalogVideo”, “AnalogAudio”.When you have a custom protocol, you can add it here. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| Voltage | float | He voltage output that this power source can handle. Only for Power Sources.Unit : volt. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| VoltageRangeMax | float | The voltage range’s maximum value.Only for Consumers.Unit: volt. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| VoltageRangeMin | float | The voltage range’s minimum value.Only for Consumers.Unit: volt. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
| WireGroup | FString | Name of the group to which this wiring object belong | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FDMXGDTFModel > ResolveModel() |
Resolves the linked model. Returns the model, or nullptr if no model is linked | GDTF/Geometries/DMXGDTFWiringObjectGeometry.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/DMXGDTFWiringObjectGeometry.h | |
virtual const TCHAR * GetXmlTag() |
Gets the Xml Tag corresponding to this node | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h | |
virtual void Initialize
(
const FXmlNode& InXmlNode |
Initializes the node from an Xml node. Called after the node was constructed. | GDTF/Geometries/DMXGDTFWiringObjectGeometry.h |