1. Epic GamesDeveloper
  3. UDMXPixelMappingMatrixComponent

UDMXPixelMappingMatrixComponent

DMX Matrix group component

API > API/Plugins > API/Plugins/DMXPixelMappingRuntime

DMX Matrix group component

   
Name UDMXPixelMappingMatrixComponent
Type class
Header File /Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingMatrixComponent.h
Include Path #include "Components/DMXPixelMappingMatrixComponent.h"

Syntax

UCLASS ()  
class UDMXPixelMappingMatrixComponent : public UDMXPixelMappingOutputDMXComponent

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDMXPixelMappingMatrixComponent()

 Default Constructor Components/DMXPixelMappingMatrixComponent.h  

Classes

Name Remarks
FDMXPixelMappingOnMatrixChanged  

Typedefs

Name Type Remarks Include Path
ChildCallback TFunctionRef< void(UDMXPixelMappingMatrixCellComponent *)> Helper callback for loop through all component child Components/DMXPixelMappingMatrixComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bInvertCellsX bool Inverts the cell ordering along the X-axis. Useful when the matrix is facing away from the screen. Components/DMXPixelMappingMatrixComponent.h
  • EditAnywhere
  • Category="Matrix"
bInvertCellsY bool Inverts the cell ordering along the Y-axis. Useful when the matrix is facing away from the screen . Components/DMXPixelMappingMatrixComponent.h
  • EditAnywhere
  • Category="Matrix"
CellSize FVector2D   Components/DMXPixelMappingMatrixComponent.h  
CoordinateGrid FIntPoint   Components/DMXPixelMappingMatrixComponent.h  
Distribution EDMXPixelMappingDistribution   Components/DMXPixelMappingMatrixComponent.h  
LayoutScript TObjectPtr< UDMXPixelMappingLayoutScript > Layout script for the children of this component (hidden in customizations and displayed in its own panel). Components/DMXPixelMappingMatrixComponent.h
  • EditAnywhere
  • Instanced
  • Category="Layout"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void HandleMatrixChanged()

 Handles changes in size or in matrix Components/DMXPixelMappingMatrixComponent.h  

void LogInvalidProperties()

 Logs properties that were changed in underlying fixture patch or fixture type Components/DMXPixelMappingMatrixComponent.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void RenderWithInputAndSendDMX()

   Components/DMXPixelMappingMatrixComponent.h  

Overridden from UDMXPixelMappingOutputComponent

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Returns the text of palette category Components/DMXPixelMappingMatrixComponent.h  

virtual bool IsOverParent()

 Returns true if the the component's over all its parents. Components/DMXPixelMappingMatrixComponent.h  

virtual void QueueDownsample()

   Components/DMXPixelMappingMatrixComponent.h  

virtual void SetPosition ( const FVector2D& NewPosition
)

 Sets the absolute position of the component, without rotation. Components/DMXPixelMappingMatrixComponent.h  

virtual void SetPositionRotated ( FVector2D NewRotatedPosition
)

 Sets the the absolute position with rotation. Components/DMXPixelMappingMatrixComponent.h  

virtual void SetRotation ( double NewRotation
)

 Sets the absolute rotation, in degrees Components/DMXPixelMappingMatrixComponent.h  

virtual void SetSize ( const FVector2D& NewSize
)

 Sets the absolue size Components/DMXPixelMappingMatrixComponent.h  

Overridden from UDMXPixelMappingBaseComponent

Name Remarks Include Path Unreal Specifiers

virtual bool CanBeMovedTo ( const UDMXPixelMappingBaseComponent* Component
) const

 Render input texture for downsample texture, donwsample and send DMX for this component Check if a Component can be moved under another one (used for copy/move/duplicate) Components/DMXPixelMappingMatrixComponent.h  

virtual const FName & GetNamePrefix()

 Helper function for generating UObject name, the child should implement their own logic for Prefix name generation. Components/DMXPixelMappingMatrixComponent.h  

virtual FString GetUserName ()

 Returns the name of the component. Components/DMXPixelMappingMatrixComponent.h  

virtual void ResetDMX ( EDMXPixelMappingResetDMXMode ResetMode
)

 Reset all sending DMX channels to 0 for this component and all children Components/DMXPixelMappingMatrixComponent.h  

virtual void SendDMX()

 Send DMX values of this component and all children. Components/DMXPixelMappingMatrixComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedChainEvent
)

   Components/DMXPixelMappingMatrixComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/DMXPixelMappingMatrixComponent.h  

virtual void PostInitProperties()

   Components/DMXPixelMappingMatrixComponent.h  

virtual void PostLoad()

   Components/DMXPixelMappingMatrixComponent.h  

virtual void Serialize ( FArchive& Ar
)

   Components/DMXPixelMappingMatrixComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnFixturePatchChanged ( const UDMXEntityFixturePatch* FixturePatch
)

 Called when the fixture patch in use changed Components/DMXPixelMappingMatrixComponent.h  

void OnFixtureTypeChanged ( const UDMXEntityFixtureType* FixtureType
)

 Called when the fixture type in use changed Components/DMXPixelMappingMatrixComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static FDMXPixelMappingOnMatrixChanged & GetOnMatrixChanged()

 Gets an Event broadcast when a the matrix (and by that its num cells) changed Components/DMXPixelMappingMatrixComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
AttributeB_DEPRECATED FDMXAttributeName   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
AttributeBExpose_DEPRECATED bool   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
AttributeBInvert_DEPRECATED bool   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
AttributeG_DEPRECATED FDMXAttributeName   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
AttributeGExpose_DEPRECATED bool   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
AttributeGInvert_DEPRECATED bool   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
AttributeR_DEPRECATED FDMXAttributeName   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
AttributeRExpose_DEPRECATED bool   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
AttributeRInvert_DEPRECATED bool   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
bMonochromeExpose_DEPRECATED bool   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
bMonochromeInvert_DEPRECATED bool   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
ColorMode_DEPRECATED EDMXColorMode   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")
FixturePatchMatrixRef_DEPRECATED FDMXEntityFixturePatchRef   Components/DMXPixelMappingMatrixComponent.h  
MonochromeIntensity_DEPRECATED FDMXAttributeName   Components/DMXPixelMappingMatrixComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated in favor of DMXPixelMappingColorSpace. See ColorSpace member.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page