Navigation
API > API/Plugins > API/Plugins/DMXRuntime
This node defines a light fixture object.
| Name | UDMXMVRFixtureNode |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/MVR/Types/DMXMVRFixtureNode.h |
| Include Path | #include "MVR/Types/DMXMVRFixtureNode.h" |
Syntax
UCLASS ()
class UDMXMVRFixtureNode : public UDMXMVRParametricObjectNodeBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDMXMVRParametricObjectNodeBase → UDMXMVRFixtureNode
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CastShadow | FDMXOptionalBool | Defines if a Object cast Shadow. | MVR/Types/DMXMVRFixtureNode.h | |
| CIEColor | FDMXOptionalColorCIE1931 | A color assigned to a fixture. If it is not defined, there is no color for the fixture. | MVR/Types/DMXMVRFixtureNode.h | |
| Classing | FDMXOptionalGuid | The Class the object belongs to. | MVR/Types/DMXMVRFixtureNode.h | |
| CustomId | FDMXOptionalInt32 | The Custom ID is a value that can be used as a short name of the Fixture Instance. | MVR/Types/DMXMVRFixtureNode.h | |
| FixtureID | FString | The Fixture Id of the lighting fixture. This is the short name of the fixture. | MVR/Types/DMXMVRFixtureNode.h | |
| FixtureTypeId | FDMXOptionalInt32 | The Fixture Type ID is a value that can be used as a short name of the Fixture Type. | MVR/Types/DMXMVRFixtureNode.h | |
| Focus | FDMXOptionalGuid | A focus point reference that this lighting fixture aims at if this reference exists. | MVR/Types/DMXMVRFixtureNode.h | |
| GDTFMode | FString | The name of the used DMX mode. This has to match the name of a DMXMode in the GDTF file. | MVR/Types/DMXMVRFixtureNode.h | |
| GDTFSpec | FString | The name of the file containing the GDTF information for this light fixture. | MVR/Types/DMXMVRFixtureNode.h | |
| Gobo | FDMXOptionalMVRFixtureGobo | The Gobo used for the fixture. The image ressource must apply to the GDTF standard. | MVR/Types/DMXMVRFixtureNode.h | |
| Mappings | TArray< FDMXMVRFixtureMapping > | The container for Mappings for this fixture. | MVR/Types/DMXMVRFixtureNode.h | |
| MultiPatch | FDMXOptionalGuid | The unique identifier of the parent multipatch fixture. | MVR/Types/DMXMVRFixtureNode.h | |
| Name | FString | The name of the object. | MVR/Types/DMXMVRFixtureNode.h | |
| Position | FDMXOptionalGuid | A position reference that this lighting fixture belongs to if this reference exists. | MVR/Types/DMXMVRFixtureNode.h | |
| UnitNumber | int32 | The unit number of the lighting fixture in a position. | MVR/Types/DMXMVRFixtureNode.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Addresses | FDMXMVRFixtureAddresses | The container for DMX Addresses for this fixture. | MVR/Types/DMXMVRFixtureNode.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetStartingChannel() |
Returns the Address of the MVR Fixture | MVR/Types/DMXMVRFixtureNode.h | |
int32 GetUniverseID() |
Returns the Universe ID, in UE form (Index 0 is ID 1) | MVR/Types/DMXMVRFixtureNode.h | |
bool InitializeFromFixtureXmlNode
(
const FXmlNode& FixtureXmlNode |
Initializes the Fixture Node and its Children from a Fixture Xml Node. | MVR/Types/DMXMVRFixtureNode.h | |
bool IsValid
(
bool bLogInvalidReason |
Returns true if the data is sufficient to fullfill the mvr standard. | MVR/Types/DMXMVRFixtureNode.h | |
void SetStartingChannel
(
int32 Address |
Sets the Address of the MVR Fixture | MVR/Types/DMXMVRFixtureNode.h | |
void SetUniverseID
(
int32 UniverseID |
Sets the Universe ID, in UE form (Index 0 is ID 1) | MVR/Types/DMXMVRFixtureNode.h |
Overridden from UDMXMVRParametricObjectNodeBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CreateXmlNodeInParent
(
FXmlNode& ParentNode |
Creates a DMX Xml Node as per MVR standard in parent, or logs warnings if no compliant Node can be created. | MVR/Types/DMXMVRFixtureNode.h |