UDMXPixelMappingBaseComponent

Base class for all DMX Pixel Mapping components

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

DMXPixelMappingRuntime

Header

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

Include

#include "Components/DMXPixelMappingBaseComponent.h"

Syntax

UCLASS(BlueprintType, Blueprintable, Abstract)
class UDMXPixelMappingBaseComponent :
    public UObject,
    public FTickableGameObject

Remarks

Base class for all DMX Pixel Mapping components

Variables

Name Description

Public variable UProperty

TArray< UDMXPix...

 

Children

Array of children belong to this component

Constructors

Name Description

Public function

UDMXPixelMappingBaseComponent()

Public constructor

Functions

Name Description

Public function Virtual

void

 

AddChild

Add a new child componet

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

void

 

ClearChildren()

Remove all children

Public function Static

void

 

ForComponentAndChildren

(
    UDMXPixelMappingBaseComponent*...,
    TComponentPredicate Predicate
)

Recursively loop through all child by given Component and Predicate

Public function

void

 

ForEachChild

(
    TComponentPredicate Predicate,
    bool bIsRecursive
)

Loop through all child by given Predicate

Public function

void

 

ForEachChildOfClass

(
    TComponentPredicateType< TComponent...,
    bool bIsRecursive
)

Loop through all templated child class by given Predicate

Public function Const

UDMXPixelMap...

 

GetChildAt

(
    int32 Index
)

Get the child component by the given index.

Public function

void

 

GetChildComponentsRecursively

Gathers descendant child Components of a parent Component.

Public function Const

const TArray...

 

GetChildren()

Get all children to belong to this component

Public function Const

int32

 

GetChildrenCount()

Get the number of children components

Public function

TComponentCl...

 

GetFirstChildOfClass()

Looking for the first child by given Class

Public function Static

TComponentCl...

 

GetFirstParentByClass

Recursively looking for the first parent by given Class

Public function Virtual

const FName ...

 

GetNamePrefix()

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

Public function Static

FDMXPixelMap...

 

GetOnComponentAdded()

Gets an Event broadcast when a component was added

Public function Static

FDMXPixelMap...

 

GetOnComponentRemoved()

Gets an Event broadcast when a component was added

Public function Static

FDMXPixelMap...

 

GetOnComponentRenamed()

Gets an Event broadcast when a component was renamed

Public function Const

UDMXPixelMap...

 

GetParent()

Returns the parent. May be nullptr when the the component is creating or destroying

Public function

UDMXPixelMap...

 

GetPixelMapping()

Get Pixel Mapping asset UObject

Public function

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

Public function Const

const UDMXPi...

 

GetRootComponent()

Get root component of the component tree

Public function Const

const UDMXPi...

 

GetRootComponentChecked()

Get the root component and not allow a null option.

Public function Virtual Const

FString

 

GetUserFriendlyName()

Returns the name of the component used across all widgets that draw it

Public function Const

bool

 

HasValidParent()

Returns the parent. May be nullptr when the the component is creating or destroying

Protected function Virtual

void

 

NotifyAddedToParent()

Called when the component was added to a parent

Protected function Virtual

void

 

NotifyRemovedFromParent()

Called when the component was added to a parent

Public function Virtual

void

 

RemoveChild

Remove the child component by the given component object.

Public function Virtual UFunction BlueprintCallable, Category

void

 

Render()

Render downsample texture for this component and all children

Public function Virtual UFunction BlueprintCallable, Category

void

 

RenderAndSendDMX()

Render downsample texture and send DMX for this component and all children

Public function Virtual UFunction BlueprintCallable, Category

void

 

ResetDMX()

Reset all sending DMX channels to 0 for this component and all children

Public function Virtual UFunction BlueprintCallable, Category

void

 

SendDMX()

Send DMX values of this component and all children

Public function

void

 

SetParent

(
    const TWeakObjectPtr< UDMXPixelMapp...
)

Set the components parent

Public function Virtual

bool

 

ValidateProperties()

Should log properties that were changed in underlying fixture patch or fixture type

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostEditUndo()

Called after applying a transaction to the object.

Protected function Virtual

void

 

PostRename

(
    UObject* OldOuter,
    const FName OldName
)

Called at the end of Rename(), but only if the rename was actually carried out

Protected function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Overridden from FTickableGameObject

Name Description

Public function Virtual Const

bool

 

IsTickableInEditor()

Used to determine whether the object should be ticked in the editor.

Public function Virtual Const

bool

 

IsTickableWhenPaused()

Used to determine if an object should be ticked when the game is paused.

Overridden from FTickableObjectBase

Name Description

Public function Virtual Const

TStatId

 

GetStatId()

Return the stat id to use for this tickable

Public function Virtual Const

bool

 

IsTickable()

Virtual that can be overloaded by the inheriting class.

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

Pure virtual that must be overloaded by the inheriting class.

Deprecated Variables

Name Description

Public variable UProperty Meta

UDMXPixelMappin...

 

Parent_DEPRECATED

Parent component

Deprecated Functions

Name Description

Public function

void

 

ForEachComponentOfClass

(
    TComponentPredicateType< TComponent...,
    bool bIsRecursive
)

Use ForEachChildOfClass in favor of a clearer name instead.