1. Epic GamesDeveloper
  3. UDMXPixelMappingBaseComponent

UDMXPixelMappingBaseComponent

Base class for all DMX Pixel Mapping components.

API > API/Plugins > API/Plugins/DMXPixelMappingRuntime

Base class for all DMX Pixel Mapping components.

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

Syntax

UCLASS (BlueprintType, NotBlueprintable, Abstract)  
class UDMXPixelMappingBaseComponent : public UObject

Inheritance Hierarchy

Derived Classes

Classes

Name Remarks
FDMXPixelMappingOnComponentAdded  
FDMXPixelMappingOnComponentRemoved  
FDMXPixelMappingOnComponentRenamed  

Typedefs

Name Type Remarks Include Path
TComponentPredicate TFunctionRef< void(UDMXPixelMappingBaseComponent *)>   Components/DMXPixelMappingBaseComponent.h
TComponentPredicateType TFunctionRef< void(Type *)>   Components/DMXPixelMappingBaseComponent.h

Constants

Name Type Remarks Include Path
OnComponentAdded FDMXPixelMappingOnComponentAdded Delegate Broadcast when a component was added Components/DMXPixelMappingBaseComponent.h
OnComponentRemoved FDMXPixelMappingOnComponentRemoved Delegate Broadcast when a component was removed Components/DMXPixelMappingBaseComponent.h
OnComponentRenamed FDMXPixelMappingOnComponentRenamed Delegate Broadcast when a component was renamed Components/DMXPixelMappingBaseComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bExpanded bool   Components/DMXPixelMappingBaseComponent.h  
Children TArray< TObjectPtr< UDMXPixelMappingBaseComponent > > Array of children belong to this component Components/DMXPixelMappingBaseComponent.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
WeakParent TWeakObjectPtr< UDMXPixelMappingBaseComponent > Parent component Components/DMXPixelMappingBaseComponent.h
  • NonTransactional

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddChild ( UDMXPixelMappingBaseComponent* InComponent
)

 Add a new child componet Components/DMXPixelMappingBaseComponent.h  

virtual bool CanBeMovedTo ( const UDMXPixelMappingBaseComponent* Component
) const

 Check if a Component can be moved under another one (used for copy/move/duplicate) Components/DMXPixelMappingBaseComponent.h  

void ClearChildren()

 Remove all children Components/DMXPixelMappingBaseComponent.h  

void ForEachChild ( TFunctionRef< void(UDMXPixelMappingBaseComponent*)> Predicate,
bool bIsRecursive
)

 Loop through all child by given Predicate Components/DMXPixelMappingBaseComponent.h  

void ForEachChildOfClass ( TComponentPredicateType< TComponentClass > Predicate,
bool bIsRecursive
)

 Loop through all templated child class by given Predicate Components/DMXPixelMappingBaseComponent.h  

UDMXPixelMappingBaseComponent * GetChildAt ( int32 Index
) const

 Get the child component by the given index. Components/DMXPixelMappingBaseComponent.h  

void GetChildComponentsRecursively ( TArray< UDMXPixelMappingBaseComponent* >& Components
)

 Gathers descendant child Components of a parent Component. Components/DMXPixelMappingBaseComponent.h  

const TArray< UDMXPixelMappingBaseComponent * > & GetChildren()

 Get all children to belong to this component Components/DMXPixelMappingBaseComponent.h  

int32 GetChildrenCount()

 Get the number of children components Components/DMXPixelMappingBaseComponent.h  

TComponentClass * GetFirstChildOfClass()

 Looking for the first child by given Class Components/DMXPixelMappingBaseComponent.h  

virtual const FName & GetNamePrefix()

 Helper function for generating UObject name, the child should implement their own logic for Prefix name generation. Components/DMXPixelMappingBaseComponent.h  
Returns the parent. May be nullptr when the the component is creating or destroying Components/DMXPixelMappingBaseComponent.h  

UDMXPixelMapping * GetPixelMapping()

 Get Pixel Mapping asset UObject Components/DMXPixelMappingBaseComponent.h  

UDMXPixelMappingRendererComponent * 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 Components/DMXPixelMappingBaseComponent.h  

const UDMXPixelMappingRootComponent * GetRootComponent()

 Get root component of the component tree Components/DMXPixelMappingBaseComponent.h  

const UDMXPixelMappingRootComponent * GetRootComponentChecked()

 Get the root component and not allow a null option. Components/DMXPixelMappingBaseComponent.h  

virtual FString GetUserFriendlyName()

 DEPRECATED 5.3 Components/DMXPixelMappingBaseComponent.h  

virtual FString GetUserName ()

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

bool HasValidParent()

 Returns the parent. May be nullptr when the the component is creating or destroying Components/DMXPixelMappingBaseComponent.h  

virtual void RemoveChild ( UDMXPixelMappingBaseComponent* InComponent
)

 Remove the child component by the given component object. Components/DMXPixelMappingBaseComponent.h  

virtual void Render()

 Renders this component and all children Components/DMXPixelMappingBaseComponent.h
  • BlueprintCallable
  • Category="DMX|PixelMapping"

virtual void RenderAndSendDMX()

 Render downsample texture and send DMX for this component and all children Components/DMXPixelMappingBaseComponent.h
  • BlueprintCallable
  • Category="DMX|PixelMapping"

virtual void ResetDMX ( EDMXPixelMappingResetDMXMode ResetMode
)

 Reset all sending DMX channels to 0 for this component and all children Components/DMXPixelMappingBaseComponent.h
  • BlueprintCallable
  • Category="DMX|PixelMapping"

virtual void SendDMX()

 Send DMX values of this component and all children. Components/DMXPixelMappingBaseComponent.h
  • BlueprintCallable
  • Category="DMX|PixelMapping"

void SetParent ( const TWeakObjectPtr< UDMXPixelMappingBaseComponent >& NewParent
)

 Set the components parent Components/DMXPixelMappingBaseComponent.h  

virtual void SetUserName ( const FString& NewName
)

 Sets the custom user name. If set, GetUserName returns this name. Components/DMXPixelMappingBaseComponent.h  

virtual bool ValidateProperties()

 Should log properties that were changed in underlying fixture patch or fixture type Components/DMXPixelMappingBaseComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditUndo()

   Components/DMXPixelMappingBaseComponent.h  

virtual void PostRename ( UObject* OldOuter,
const FName OldName
)

   Components/DMXPixelMappingBaseComponent.h  

virtual void Serialize ( FArchive& Ar
)

   Components/DMXPixelMappingBaseComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void NotifyAddedToParent()

 Called when the component was added to a parent Components/DMXPixelMappingBaseComponent.h  

virtual void NotifyRemovedFromParent()

 Called when the component was added to a parent Components/DMXPixelMappingBaseComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ForComponentAndChildren ( UDMXPixelMappingBaseComponent* Component,
TComponentPredicate Predicate
)

 Recursively loop through all child by given Component and Predicate Components/DMXPixelMappingBaseComponent.h  

static TComponentClass * GetFirstParentByClass ( UDMXPixelMappingBaseComponent* InComponent
)

 Recursively looking for the first parent by given Class Components/DMXPixelMappingBaseComponent.h  

static FDMXPixelMappingOnComponentAdded & GetOnComponentAdded()

 Gets an Event broadcast when a component was added Components/DMXPixelMappingBaseComponent.h  

static FDMXPixelMappingOnComponentRemoved & GetOnComponentRemoved()

 Gets an Event broadcast when a component was added Components/DMXPixelMappingBaseComponent.h  

static FDMXPixelMappingOnComponentRenamed & GetOnComponentRenamed ()

 Gets an Event broadcast this uobject was renamed. Components/DMXPixelMappingBaseComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Parent_DEPRECATED TObjectPtr< UDMXPixelMappingBaseComponent > Parent component Components/DMXPixelMappingBaseComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Leads to entangled references. Use GetParent() or WeakParent instead.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page