Navigation
API > API/Plugins > API/Plugins/DMXPixelMappingRuntime > API/Plugins/DMXPixelMappingRuntime/Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDMXPixelMappingBaseComponent
- UDMXPixelMappingOutputComponent
- UDMXPixelMappingFixtureGroupComponent
- UDMXPixelMappingMatrixCellComponent
- UDMXPixelMappingOutputDMXComponent
- UDMXPixelMappingFixtureGroupItemComponent
- UDMXPixelMappingMatrixComponent
- UDMXPixelMappingScreenComponent
- UDMXPixelMappingRendererComponent
References
| Module | DMXPixelMappingRuntime |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingOutputComponent.h |
| Include | #include "Components/DMXPixelMappingOutputComponent.h" |
Syntax
UCLASS&40;Abstract&41;
class UDMXPixelMappingOutputComponent : public UDMXPixelMappingBaseComponent
Remarks
Base class for all Designer and configurable components
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
bool | bLockInDesigner | |
    |
bool | bVisibleInDesigner | |
    |
FLinearColor | EditorColor | The color displayed in editor |
 |
EDMXPixelMappingComponentLabelAlignment | LabelAlignment | Where the component's label is shown, if it uses one. |
 |
TArray< UDMXPixelMappingBaseComponent * > | PreEditUndoChildren | Children available PreEditUndo, useful to hide all removed ones in post edit undo |
  |
int32 | ZOrder | ZOrder in the UI |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Default Constructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
UDMXPixelMappingRendererComponent * | Helper that returns render component if available | |
   |
FLinearColor | Returns an editor color for the widget | |
  |
FName | Property Name getters. | |
  |
const FText | Returns the text of palette category | |
  |
FVector2D | GetPosition () |
Returns the position |
  |
FName | ||
  |
FName | ||
  |
FVector2D | GetSize () |
Get the size |
  |
FName | ||
  |
FName | ||
  |
FName | ||
   |
int32 | GetZOrder () |
Returns the UI ZOrder |
 |
void | Invalidates the pixel map, effectively causing the renderer component to aquire a new pixel map | |
  |
bool | Whether component should be part of Palette view | |
   |
bool | Whether component can be re-sized or re-position at the editor | |
   |
bool | IsOverParent () |
Returns true if the the component's over all its parents. |
   |
bool | IsOverPosition
(
const FVector2D& Position |
Returns true if the component is over specified position |
   |
bool | IsVisible () |
Whether component should be visible |
   |
bool | OverlapsComponent
(
UDMXPixelMappingOutputComponent* Other |
Returns true if the component overlaps the other |
  |
void | SetPosition
(
const FVector2D& NewPosition |
Sets the position |
  |
void | SetSize
(
const FVector2D& NewSize |
Sets the size |
  |
void | SetZOrder
(
int32 NewZOrder |
Sets the ZOrder in the UI |
 |
void | UpdateComponentWidget
(
EVisibility NewVisibility, |
Udpates the component widget. |
 |
void | Updates children to match the size of this instance Makes the component the highest ZOrdered of components in the component rectangle, updates childs if needed |
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) |
  |
void | Called when the component was added to a parent | |
  |
void | Called when the component was added to a parent |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
Called before destroying the object. |
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | PostEditUndo () |
Called after applying a transaction to the object. |
  |
void | PreEditUndo () |
Called before applying a transaction to the object. |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
 |
PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< FDMXPixelMappingComponentWidget > | ComponentWidget_DEPRECATED | The widget shown for this component |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedRef< FDMXPixelMappingComponentWidget > | BuildSlot
(
TSharedRef< SConstraintCanvas > InCanvas |
Pixel Mapping Components no longer hold their own widget, in an effort to separate Views from Data. |
 |
PRAGMA_DISABLE_DEPRECATION_WARNINGS const TSharedPtr< FDMXPixelMappingComponentWidget > | Pixel Mapping Components no longer hold their own widget, in an effort to separate Views from Data. | |
   |
int32 | Please use UDMXPixelMappingPixelMapRenderer to render the pixel map | |
  |
void | Please use UDMXPixelMappingPixelMapRenderer to render the pixel map |