Navigation
API > API/Plugins > API/Plugins/DMXPixelMappingRuntime
| Name | UDEPRECATED_DMXPixelMappingScreenComponent |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingScreenComponent.h |
| Include Path | #include "Components/DMXPixelMappingScreenComponent.h" |
Syntax
UCLASS (Deprecated,
Meta=(DeprecationMessage="Deprecated 5.5. DMXScreenComponent is no longer supported in favor of a fully Fixture Patch based workflow."))
class UDEPRECATED_DMXPixelMappingScreenComponent : public UDMXPixelMappingOutputDMXComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDMXPixelMappingBaseComponent → UDMXPixelMappingOutputComponent → UDMXPixelMappingOutputDMXComponent → UDEPRECATED_DMXPixelMappingScreenComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDEPRECATED_DMXPixelMappingScreenComponent() |
Default Constructor | Components/DMXPixelMappingScreenComponent.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ForEachPixelCallback | TFunctionRef< void(const int32, const int32, const int32)> | Components/DMXPixelMappingScreenComponent.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MinGridSize | const FVector2D | Components/DMXPixelMappingScreenComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AlphaIntensity | float | Components/DMXPixelMappingScreenComponent.h |
|
|
| bIgnoreAlphaChannel | bool | Components/DMXPixelMappingScreenComponent.h |
|
|
| bSendToAllOutputPorts | bool | If true, outputs to all DMX Output Ports | Components/DMXPixelMappingScreenComponent.h |
|
| bShowAddresses | bool | Components/DMXPixelMappingScreenComponent.h |
|
|
| bShowUniverse | bool | Components/DMXPixelMappingScreenComponent.h |
|
|
| Distribution | EDMXPixelMappingDistribution | Components/DMXPixelMappingScreenComponent.h |
|
|
| LocalUniverse | int32 | Components/DMXPixelMappingScreenComponent.h |
|
|
| NumXCells | int32 | Components/DMXPixelMappingScreenComponent.h |
|
|
| NumYCells | int32 | Components/DMXPixelMappingScreenComponent.h |
|
|
| OutputPortReferences | TArray< FDMXOutputPortReference > | The port this render component outputs to | Components/DMXPixelMappingScreenComponent.h |
|
| PixelFormat | EDMXCellFormat | Components/DMXPixelMappingScreenComponent.h |
|
|
| PixelIntensity | float | Components/DMXPixelMappingScreenComponent.h |
|
|
| StartAddress | int32 | Components/DMXPixelMappingScreenComponent.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsUpdateWidgetRequested | bool | Components/DMXPixelMappingScreenComponent.h | ||
| Brush | FSlateBrush | Components/DMXPixelMappingScreenComponent.h | ||
| OutputPorts | TSet< FDMXOutputPortSharedRef > | The output port instances, generated from OutputPortReferences | Components/DMXPixelMappingScreenComponent.h | |
| PixelDownsamplePositionRange | TTuple< int32, int32 > | Range of the downsample pixel positions | Components/DMXPixelMappingScreenComponent.h | |
| ScreenComponentBox | TSharedPtr< SDMXPixelMappingScreenComponentBox > | Screen Component box used in the ComponentWidget | Components/DMXPixelMappingScreenComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ForEachPixel
(
ForEachPixelCallback InCallback |
Loop through X and Y pixels in screen component | Components/DMXPixelMappingScreenComponent.h | |
TSet< FDMXOutputPortSharedRef > GetOutputPorts() |
Returns the output Ports of the renderer component | Components/DMXPixelMappingScreenComponent.h | |
const TTuple< int32, int32 > GetPixelDownsamplePositionRange() |
Get range of the downsample pixel positions | Components/DMXPixelMappingScreenComponent.h | |
const FVector2D GetScreenPixelSize() |
Calculate screen size of the single pixel in screen component | Components/DMXPixelMappingScreenComponent.h | |
virtual void RenderWithInputAndSendDMX() |
Components/DMXPixelMappingScreenComponent.h |
Overridden from UDMXPixelMappingOutputComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
Returns the text of palette category | Components/DMXPixelMappingScreenComponent.h | |
virtual bool IsExposedToTemplate() |
Whether component should be part of Palette view | Components/DMXPixelMappingScreenComponent.h | |
virtual void QueueDownsample() |
Queue rendering to downsample rendering target | Components/DMXPixelMappingScreenComponent.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/DMXPixelMappingScreenComponent.h | |
virtual const FName & GetNamePrefix() |
Helper function for generating UObject name, the child should implement their own logic for Prefix name generation. | Components/DMXPixelMappingScreenComponent.h | |
virtual void SendDMX() |
Send DMX values of this component and all children. | Components/DMXPixelMappingScreenComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedChainEvent |
Components/DMXPixelMappingScreenComponent.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ProtocolName_DEPRECATED | FDMXProtocolName | Components/DMXPixelMappingScreenComponent.h |
|