UDMXPixelMappingOutputComponent

Base class for all Designer and configurable components

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

DMXPixelMappingRuntime

Header

/Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingOutputComponent.h

Include

#include "Components/DMXPixelMappingOutputComponent.h"

Syntax

UCLASS(Abstract)
class UDMXPixelMappingOutputComponent : public UDMXPixelMappingBaseComponent

Remarks

Base class for all Designer and configurable components

Variables

Name Description

Protected variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

bLockInDesigner

Protected variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

bVisibleInDesigner

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

EDMXPixelBlendi...

 

CellBlendingQuality

The quality level to use when averaging colors during downsampling.

Protected variable

TSharedPtr< FDM...

 

ComponentWidget

The widget shown for this component

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FLinearColor

 

EditorColor

The color displayed in editor

Public variable

EDMXPixelMappin...

 

LabelAlignment

Where the component's label is shown, if it uses one.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

float

 

PositionX

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

float

 

PositionY

Protected variable

TArray< UDMXPix...

 

PreEditUndoChildren

Children available PreEditUndo, useful to hide all removed ones in post edit undo

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

float

 

SizeX

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

float

 

SizeY

Public variable UProperty

int32

 

ZOrder

ZOrder in the UI

Constructors

Name Description

Public function

UDMXPixelMappingOutputComponent()

Default Constructor

Functions

Name Description

Public function Virtual

TSharedRef< ...

 

BuildSlot

(
    TSharedRef< SConstraintCanvas > InC...
)

Rebuild widget for designer view

Public function Const

UDMXPixelMap...

 

FindRendererComponent()

Helper that returns render component if available

Public function

const TShare...

 

GetComponentWidget()

Returns the component widget

Public function Virtual Const

int32

 

GetDownsamplePixelIndex()

Get pixel index in downsample texture

Public function Virtual Const

FLinearColor

 

GetEditorColor()

Returns an editor color for the widget

Public function Static

FName

 

GetLockInDesignerPropertyName()

Returns the bIsLockInDesigner property name

Public function Virtual

const FText

 

GetPaletteCategory()

Returns the text of palette category

Public function Const

FVector2D

 

GetPosition()

Returns the position

Public function Const

FVector2D

 

GetSize()

Get the size of the component

Public function Static

FName

 

GetVisibleInDesignerPropertyName()

Returns the bIsVisibleInDesigner property name

Public function Virtual Const

int32

 

GetZOrder()

Returns the UI ZOrder

Public function Virtual

bool

 

IsExposedToTemplate()

Whether component should be part of Palette view

Public function Virtual Const

bool

 

IsLockInDesigner()

Whether component can be re-sized or re-position at the editor

Public function Virtual Const

bool

 

IsOverParent()

Returns true if the the component's over all its parents.

Public function Virtual Const

bool

 

IsOverPosition

(
    const FVector2D& Position
)

Returns true if the component is over specified position

Public function Virtual Const

bool

 

IsVisible()

Whether component should be visible

Public function

void

 

MakeHighestZOrderInComponentRect()

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

Public function Virtual Const

bool

 

OverlapsComponent

Returns true if the component overlaps the other

Public function Virtual

void

 

QueueDownsample()

Queue rendering to downsample rendering target

Public function Virtual

void

 

SetPosition

(
    const FVector2D& NewPosition
)

Sets the position

Public function Virtual

void

 

SetSize

(
    const FVector2D& NewSize
)

Sets the size

Public function Virtual

void

 

SetZOrder

(
    int32 NewZOrder
)

Sets the ZOrder in the UI

Protected function

void

 

UpdateComponentWidget

(
    EVisibility NewVisibility,
    bool bWithChildrenRecursive
)

Udpates the component widget.

Overridden from UDMXPixelMappingBaseComponent

Name Description

Public function Virtual Const

bool

 

CanBeMovedTo

(
    const UDMXPixelMappingBaseComponent...
)

Check if a Component can be moved under another one (used for copy/move/duplicate)

Public function Virtual

void

 

NotifyAddedToParent()

Called when the component was added to a parent

Public function Virtual

void

 

NotifyRemovedFromParent()

Called when the component was added to a parent

Overridden from UObject

Name Description

Protected function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Protected function Virtual

void

 

PostEditUndo()

Called after applying a transaction to the object.

Protected function Virtual

void

 

PreEditUndo()

Called before applying a transaction to the object.