Navigation
API > API/Plugins > API/Plugins/DMXPixelMappingRuntime > API/Plugins/DMXPixelMappingRuntime/Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDMXPixelMappingBaseComponent
- UDMXPixelMappingOutputComponent
- UDMXPixelMappingOutputDMXComponent
- UDMXPixelMappingMatrixComponent
References
| Module | DMXPixelMappingRuntime |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingMatrixComponent.h |
| Include | #include "Components/DMXPixelMappingMatrixComponent.h" |
Syntax
UCLASS&40;&41;
class UDMXPixelMappingMatrixComponent : public UDMXPixelMappingOutputDMXComponent
Remarks
DMX Matrix group component
Variables
| Type | Name | Description | |
|---|---|---|---|
  |
FVector2D | CellSize | |
  |
FIntPoint | CoordinateGrid | |
  |
EDMXPixelMappingDistribution | Distribution | |
    |
TObjectPtr< UDMXPixelMappingLayoutScript > | LayoutScript | Layout script for the children of this component (hidden in customizations and displayed in its own panel). |
 |
TArray< UDMXPixelMappingBaseComponent * > | PreEditUndoMatrixCellChildren | Children available PreEditUndo, useful to hide all removed ones in post edit undo |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Default Constructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FDMXPixelMappingOnMatrixChanged & | Gets an Event broadcast when a the matrix (and by that its num cells) changed | |
 |
void | Handles changes in size or in matrix | |
 |
void | Handles changes in position | |
 |
void | Handles changes in size or in matrix | |
 |
void | Logs properties that were changed in underlying fixture patch or fixture type | |
 |
void | OnFixturePatchChanged
(
const UDMXEntityFixturePatch* FixturePatch |
Called when the fixture patch in use changed |
 |
void | OnFixtureTypeChanged
(
const UDMXEntityFixtureType* FixtureType |
Called when the fixture type in use changed |
Overridden from UDMXPixelMappingOutputComponent
| Type | Name | Description | |
|---|---|---|---|
  |
const FText | Returns the text of palette category | |
   |
bool | IsOverParent () |
Returns true if the the component's over all its parents. |
  |
void | SetPosition
(
const FVector2D& NewPosition |
Sets the position |
  |
void | SetSize
(
const FVector2D& NewSize |
Sets the size |
Overridden from UDMXPixelMappingBaseComponent
| Type | Name | Description | |
|---|---|---|---|
   |
bool | CanBeMovedTo
(
const UDMXPixelMappingBaseComponent* Component |
Check if a Component can be moved under another one (used for copy/move/duplicate) |
  |
const FName & | Helper function for generating UObject name, the child should implement their own logic for Prefix name generation. | |
   |
FString | GetUserName () |
Returns the name of the component. |
  |
void | ResetDMX () |
Reset all sending DMX channels to 0 for this component and all children |
  |
void | SendDMX () |
Send DMX values of this component and all children. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedEvent |
This alternate version of PostEditChange is called when properties inside structs are modified. |
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. | |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
  |
void | PreEditChange
(
FProperty* PropertyAboutToChange |
This is called when a property is about to be modified externally |
  |
void | Handles reading, writing, and reference collecting using FArchive. |
Typedefs
| Name | Description |
|---|---|
| ChildCallback | Helper callback for loop through all component child |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
   |
FDMXAttributeName | AttributeB_DEPRECATED | |
   |
bool | AttributeBExpose_DEPRECATED | |
   |
bool | AttributeBInvert_DEPRECATED | |
   |
FDMXAttributeName | AttributeG_DEPRECATED | |
   |
bool | AttributeGExpose_DEPRECATED | |
   |
bool | AttributeGInvert_DEPRECATED | |
   |
FDMXAttributeName | AttributeR_DEPRECATED | |
   |
bool | AttributeRExpose_DEPRECATED | |
   |
bool | AttributeRInvert_DEPRECATED | |
   |
bool | bMonochromeExpose_DEPRECATED | |
   |
bool | bMonochromeInvert_DEPRECATED | |
   |
EDMXColorMode | ColorMode_DEPRECATED | |
  |
FDMXEntityFixturePatchRef | FixturePatchMatrixRef_DEPRECATED | |
   |
FDMXAttributeName | MonochromeIntensity_DEPRECATED |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | Please use UDMXPixelMappingPixelMapRenderer to render the pixel map | |
  |
PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid | Deprecated for performance reasons. Instead use 'Get DMX Pixel Mapping Renderer Component' and Render only once each tick. |