1. Epic GamesDeveloper
  3. UDMXPixelMappingBaseComponent

UDMXPixelMappingBaseComponent

Base class for all DMX Pixel Mapping components.

Unreal Engine C++ API Reference > Plugins > DMXPixelMappingRuntime > Components

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, NotBlueprintable, Abstract&41;  
class UDMXPixelMappingBaseComponent : public UObject

Remarks

Base class for all DMX Pixel Mapping components.

Variables

  Type Name Description
Public variable UProperty bool bExpanded  
Public variable UProperty TArray< TObjectPtr< UDMXPixelMappingBaseComponent > > Children Array of children belong to this component
Protected variable UProperty FString UserName Custom user name for the component. Should be used if set.

Functions

  Type Name Description
Public function Virtual void Add a new child componet
Public function Virtual Const bool Check if a Component can be moved under another one (used for copy/move/duplicate)
Public function void Remove all children
Public function Static void Recursively loop through all child by given Component and Predicate
Public function void

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

 Loop through all child by given Predicate
Public function void

ForEachChildOfClass ( TComponentPredicateType< TComponentClass > Predicate,
bool bIsRecursive
)

 Loop through all templated child class by given Predicate
Public function Const UDMXPixelMappingBaseComponent *

GetChildAt ( int32 Index
)

 Get the child component by the given index.
Public function void Gathers descendant child Components of a parent Component.
Public function Const const TArray< UDMXPixelMappingBaseComponent * > & Get all children to belong to this component
Public function Const int32 Get the number of children components
Public function TComponentClass * Looking for the first child by given Class
Public function Static TComponentClass * Recursively looking for the first parent by given Class
Public function Virtual const FName & Helper function for generating UObject name, the child should implement their own logic for Prefix name generation.
Public function Static FDMXPixelMappingOnComponentAdded & Gets an Event broadcast when a component was added
Public function Static FDMXPixelMappingOnComponentRemoved & Gets an Event broadcast when a component was added
Public function Static FDMXPixelMappingOnComponentRenamed & Gets an Event broadcast this uobject was renamed.
Public function Const UDMXPixelMappingBaseComponent * Returns the parent. May be nullptr when the the component is creating or destroying
Public function UDMXPixelMapping * Get Pixel Mapping asset UObject
Public function UDMXPixelMappingRendererComponent * 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 UDMXPixelMappingRootComponent * Get root component of the component tree
Public function Const const UDMXPixelMappingRootComponent * Get the root component and not allow a null option.
Public function Virtual Const FString Returns the name of the component.
Public function Const bool Returns the parent. May be nullptr when the the component is creating or destroying
Protected function Virtual void Called when the component was added to a parent
Protected function Virtual void Called when the component was added to a parent
Public function Virtual void 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 Render downsample texture and send DMX for this component and all children
Public function Virtual UFunction BlueprintCallable, Category void 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 Set the components parent
Public function Virtual void

SetUserName ( const FString& NewName
)

 Sets the custom user name. If set, GetUserName returns this name.
Public function Virtual bool Should log properties that were changed in underlying fixture patch or fixture type

Overridden from UObject

  Type Name Description
Protected function Virtual void 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 Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
TComponentPredicate  
TComponentPredicateType  

Constants

Name Description
OnComponentAdded Delegate Broadcast when a component was added
OnComponentRemoved Delegate Broadcast when a component was removed
OnComponentRenamed Delegate Broadcast when a component was renamed

Deprecated Variables

  Type Name Description
Public variable UProperty Meta TObjectPtr< UDMXPixelMappingBaseComponent > Parent_DEPRECATED Parent component

Deprecated Functions

  Type Name Description
Public function void

ForEachComponentOfClass ( TComponentPredicateType< TComponentClass > Predicate,
bool bIsRecursive
)

 Use ForEachChildOfClass in favor of a clearer name instead.
Public function Virtual Const FString Renamed GetUserName to be more explicit aobout the intent. The user name is displayed if set, otherwise the object name.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page