Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DMXPixelMappingRuntime > Components > UDMXPixelMappingMatrixComponent

Light Theme

Dark Theme

UDMXPixelMappingMatrixComponent

DMX Matrix group component

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDMXPixelMappingBaseComponent

UDMXPixelMappingOutputComponent

UDMXPixelMappingMatrixComponent

References

Module	DMXPixelMappingRuntime
Header	/Engine/Plugins/Experimental/DigitalMultiplex/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingMatrixComponent.h
Include	#include "Components/DMXPixelMappingMatrixComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UDMXPixelMappingMatrixComponent : public UDMXPixelMappingOutputComponent

Remarks

DMX Matrix group component

Variables

	Name	Description
FDMXAttributeNa...	AttributeB
bool	AttributeBExpose
bool	AttributeBInvert
FDMXAttributeNa...	AttributeG
bool	AttributeGExpose
bool	AttributeGInvert
FDMXAttributeNa...	AttributeR
bool	AttributeRExpose
bool	AttributeRInvert
bool	bMonochromeExpose
bool	bMonochromeInvert
EDMXColorMode	ColorMode
EDMXPixelMappin...	Distribution
TArray< FDMXPix...	ExtraAttributes	Extra attributes for the whole Matrix Fixture
TArray< FDMXPix...	ExtraCellAttributes	Extra attributes for each Matrix Fixture Cell
FDMXEntityFixtu...	FixturePatchMatrixRef
FDMXAttributeNa...	MonochromeIntensity
FIntPoint	NumCells
FVector2D	PixelSize

Constructors

	Name	Description
	UDMXPixelMappingMatrixComponent()	Default Constructor

Functions

	Name	Description
void	LogInvalidProperties()	Logs properties that were changed in underlying fixture patch or fixture type
void	SetChildSizeAndPosition ( UDMXPixelMappingMatrixCellComponent..., const FIntPoint& InPixelCoordinate )
void	SetNumCells ( const FIntPoint& InNumCells )
void	SetPositionBasedOnRelativePixel ( UDMXPixelMappingMatrixCellComponent..., FVector2D InDelta )
void	SetSizeWithinMaxBoundaryBox()	Resize the target to max available size, it is driven by children components

Overridden from UDMXPixelMappingOutputComponent

	Name	Description
TSharedRef< ...	BuildSlot ( TSharedRef< SConstraintCanvas > InC... )	Rebuild widget for designer view
const FText	GetPaletteCategory()	Returns the text of palette category
FVector2D	GetPosition()	Get rendering position of the component. Using for determining UV map input rendering offset
FVector2D	GetSize()	Get rendering size of component
bool	IsExposedToTemplate()	Whether component should be part of Palette view
void	QueueDownsample()	Queue rendering to downsample rendering target
void	SetPosition ( const FVector2D& InPosition )	Get rendering component position
void	SetSize ( const FVector2D& InSize )	Set rendering size of component
void	SetZOrder ( int32 NewZOrder )	Sets the ZOrder in the UI
void	ToggleHighlightSelection ( bool bIsSelected )	Change widget visuals whether it selected or not
void	UpdateWidget()	Update the content in designer widget

Overridden from UDMXPixelMappingBaseComponent

	Name	Description
bool	CanBeMovedTo ( const UDMXPixelMappingBaseComponent... )	Check if a Component can be moved under another one (used for copy/move/duplicate)
const FName ...	GetNamePrefix()	Helper function for generating UObject name, the child should implement their own logic for Prefix name generation.
FString	GetUserFriendlyName()	Returns the name of the component used across all widgets that draw it
void	PostParentAssigned()	The function might have custom behavior implementation after object has been assigned to the parent.
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

		Name	Description
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Overridden from FTickableObjectBase

		Name	Description
	bool	IsTickable()	Virtual that can be overloaded by the inheriting class.
	void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Typedefs

Name	Description
ChildCallback	Helper callback for loop through all component child

Constants

Name	Description
DefaultSize
MinSize

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss