Navigation
API > API/Plugins > API/Plugins/DMXPixelMappingRuntime
Base class for all Designer and configurable components
| Name | UDMXPixelMappingOutputComponent |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingOutputComponent.h |
| Include Path | #include "Components/DMXPixelMappingOutputComponent.h" |
Syntax
UCLASS (Abstract)
class UDMXPixelMappingOutputComponent : public UDMXPixelMappingBaseComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDMXPixelMappingBaseComponent → UDMXPixelMappingOutputComponent
Derived Classes
- UDMXPixelMappingOutputDMXComponent
- UDMXPixelMappingFixtureGroupComponent
- UDMXPixelMappingMatrixCellComponent
- UDMXPixelMappingRendererComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDMXPixelMappingOutputComponent() |
Default Constructor | Components/DMXPixelMappingOutputComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EditorColor | FLinearColor | The color displayed in editor | Components/DMXPixelMappingOutputComponent.h |
|
| ZOrder | int32 | ZOrder in the UI | Components/DMXPixelMappingOutputComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDMXPixelMappingRendererComponent * FindRendererComponent() |
Helper that returns render component if available | Components/DMXPixelMappingOutputComponent.h | |
virtual int32 GetDownsamplePixelIndex() |
Get pixel index in downsample texture | Components/DMXPixelMappingOutputComponent.h | |
void GetEdges
(
FVector2D& A, |
Returns the edges of the component, absolute, rotated, clockwise order | Components/DMXPixelMappingOutputComponent.h | |
virtual FLinearColor GetEditorColor() |
Returns an editor color for the widget | Components/DMXPixelMappingOutputComponent.h | |
virtual const FText GetPaletteCategory() |
Returns the text of palette category | Components/DMXPixelMappingOutputComponent.h | |
FVector2D GetPosition() |
Returns the absolute position, without rotation | Components/DMXPixelMappingOutputComponent.h | |
FVector2D GetPositionRotated() |
Returns the absolute position with rotation. | Components/DMXPixelMappingOutputComponent.h | |
double GetRotation() |
Gets the absolute rotation, in degrees | Components/DMXPixelMappingOutputComponent.h | |
FVector2D GetSize() |
Get the absolute size | Components/DMXPixelMappingOutputComponent.h | |
virtual int32 GetZOrder() |
Returns the UI ZOrder | Components/DMXPixelMappingOutputComponent.h | |
void InvalidatePixelMapRenderer() |
Invalidates the pixel map, effectively causing the renderer component to aquire a new pixel map | Components/DMXPixelMappingOutputComponent.h | |
virtual bool IsExposedToTemplate() |
Whether component should be part of Palette view | Components/DMXPixelMappingOutputComponent.h | |
virtual bool IsLockInDesigner() |
Whether component can be re-sized or re-position at the editor | Components/DMXPixelMappingOutputComponent.h | |
virtual bool IsOverParent() |
Returns true if the the component's over all its parents. | Components/DMXPixelMappingOutputComponent.h | |
virtual bool IsOverPosition
(
const FVector2D& Position |
Returns true if the component is over specified position | Components/DMXPixelMappingOutputComponent.h | |
virtual bool IsVisible() |
Whether component should be visible | Components/DMXPixelMappingOutputComponent.h | |
virtual bool OverlapsComponent
(
UDMXPixelMappingOutputComponent* Other |
Returns true if the component overlaps the other | Components/DMXPixelMappingOutputComponent.h | |
virtual void QueueDownsample() |
Queue rendering to downsample rendering target | Components/DMXPixelMappingOutputComponent.h | |
virtual void SetPosition
(
const FVector2D& NewPosition |
Sets the absolute position of the component, without rotation. | Components/DMXPixelMappingOutputComponent.h | |
virtual void SetPositionRotated
(
FVector2D NewRotatedPosition |
Sets the the absolute position with rotation. | Components/DMXPixelMappingOutputComponent.h | |
virtual void SetRotation
(
double NewRotation |
Sets the absolute rotation, in degrees | Components/DMXPixelMappingOutputComponent.h | |
virtual void SetSize
(
const FVector2D& NewSize |
Sets the absolue size | Components/DMXPixelMappingOutputComponent.h | |
virtual void SetZOrder
(
int32 NewZOrder |
Sets the ZOrder in the UI | Components/DMXPixelMappingOutputComponent.h | |
void ZOrderTopmost() |
Updates children to match the size of this instance Z-orders this component and its children topmost | Components/DMXPixelMappingOutputComponent.h |
Overridden from UDMXPixelMappingBaseComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanBeMovedTo
(
const UDMXPixelMappingBaseComponent* Component |
Check if a Component can be moved under another one (used for copy/move/duplicate) | Components/DMXPixelMappingOutputComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Components/DMXPixelMappingOutputComponent.h | ||
virtual void PostInitProperties() |
Components/DMXPixelMappingOutputComponent.h | ||
virtual void PostLoad() |
Components/DMXPixelMappingOutputComponent.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetLockInDesignerPropertyName() |
Property Name getters. | Components/DMXPixelMappingOutputComponent.h | |
static FName GetPositionXPropertyName() |
Components/DMXPixelMappingOutputComponent.h | ||
static FName GetPositionYPropertyName() |
Components/DMXPixelMappingOutputComponent.h | ||
static FName GetRotationPropertyName() |
Components/DMXPixelMappingOutputComponent.h | ||
static FName GetSizeXPropertyName() |
Components/DMXPixelMappingOutputComponent.h | ||
static FName GetSizeYPropertyName() |
Components/DMXPixelMappingOutputComponent.h | ||
static FName GetVisibleInDesignerPropertyName() |
Components/DMXPixelMappingOutputComponent.h |