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 > UDMXPixelMappingBaseComponent

Light Theme

Dark Theme

UDMXPixelMappingBaseComponent

Base class for all DMX Pixel Mapping components

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDMXPixelMappingBaseComponent

UDMXPixelMappingOutputComponent

UDMXPixelMappingFixtureGroupComponent

UDMXPixelMappingMatrixComponent

UDMXPixelMappingOutputDMXComponent

	UDMXPixelMappingFixtureGroupItemComponent
	UDMXPixelMappingMatrixCellComponent
	UDMXPixelMappingScreenComponent

UDMXPixelMappingRendererComponent

UDMXPixelMappingRootComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, Abstract)
class UDMXPixelMappingBaseComponent :
public UObject,
public FTickableGameObject

Remarks

Base class for all DMX Pixel Mapping components

Variables

		Name	Description
	TArray< UDMXPix...	Children	Array of children belong to this component
	UDMXPixelMappin...	Parent	Parent component

Constructors

	Name	Description
	UDMXPixelMappingBaseComponent()	Public constructor

Functions

	Name	Description
int32	AddChild ( UDMXPixelMappingBaseComponent*... )	Add a new child componet
bool	CanBeMovedTo ( const UDMXPixelMappingBaseComponent... )	Check if a Component can be moved under another one (used for copy/move/duplicate)
void	ClearChildren()	Remove all children
void	ForComponentAndChildren ( UDMXPixelMappingBaseComponent*..., TComponentPredicate Predicate )	Recursively loop through all child by given Component and Predicate
void	ForEachChild ( TComponentPredicate Predicate, bool bIsRecursive )	Loop through all child by given Predicate
void	ForEachComponentOfClass ( TComponentPredicateType< TComponent..., bool bIsRecursive )	Loop through all templated child class by given Predicate
UDMXPixelMap...	GetChildAt ( int32 Index )	Get the child component by the given index.
void	GetChildComponentsRecursively ( TArray< UDMXPixelMappingBaseCompone... )	Gathers descendant child Components of a parent Component.
int32	GetChildIndex()	Get the index of this component, it returns -1 if the component doesn't have a parent
const TArray...	GetChildren()	Get all children to belong to this component
int32	GetChildrenCount()	Get the number of children components
TComponentCl...	GetFirstChildOfClass()	Looking for the first child by given Class
TComponentCl...	GetFirstParentByClass ( UDMXPixelMappingBaseComponent*... )	Recursively looking for the first parent by given Class
const FName ...	GetNamePrefix()	Helper function for generating UObject name, the child should implement their own logic for Prefix name generation.
UDMXPixelMap...	GetPixelMapping()	Get Pixel Mapping asset UObject
UDMXPixelMap...	GetRendererComponent()	Get renderer component associated with current component It could be this component itself if this component is root component It could be parent component if that is pixel component It could be nullptr if that is Root component
UDMXPixelMap...	GetRootComponent()	Get root component of the component tree
UDMXPixelMap...	GetRootComponentChecked()	Get the root component and not allow a null option.
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.
bool	RemoveChild ( UDMXPixelMappingBaseComponent*... )	Remove the child component by the given component object.
bool	RemoveChildAt ( int32 Index )	Remove the child component by the given index.
void	Render()	Render downsample texture for this component and all children
void	RenderAndSendDMX()	Render downsample texture and send DMX for this component and all children
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
bool	ValidateProperties()	Should log properties that were changed in underlying fixture patch or fixture type

Overridden from FTickableGameObject

		Name	Description
	bool	IsTickableInEditor()	Used to determine whether the object should be ticked in the editor.
	bool	IsTickableWhenPaused()	Used to determine if an object should be ticked when the game is paused.

Overridden from FTickableObjectBase

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
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.

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

Take our survey

Dismiss