Navigation
API > API/Plugins > API/Plugins/DMXPixelMappingRuntime
Root component in the components tree
| Name | UDMXPixelMappingRootComponent |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingRootComponent.h |
| Include Path | #include "Components/DMXPixelMappingRootComponent.h" |
Syntax
UCLASS ()
class UDMXPixelMappingRootComponent : public UDMXPixelMappingBaseComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDMXPixelMappingBaseComponent → UDMXPixelMappingRootComponent
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedRendererComponentsByName | TMap< FName, TObjectPtr< UDMXPixelMappingRendererComponent > > | Chached Renderer Component names and their actual object pointer. | Components/DMXPixelMappingRootComponent.h |
|
| LastRenderedFrameNumber | uint32 | Holds the last rendered frame number, to avoid rendering multiple times in a single frame | Components/DMXPixelMappingRootComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDMXPixelMappingRendererComponent * FindRendererComponentByName
(
const FName& Name |
Finds a renderer component by its name. | Components/DMXPixelMappingRootComponent.h |
Overridden from UDMXPixelMappingBaseComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddChild
(
UDMXPixelMappingBaseComponent* InComponent |
Add a new child componet | Components/DMXPixelMappingRootComponent.h | |
virtual bool CanBeMovedTo
(
const UDMXPixelMappingBaseComponent* Component |
Check if a Component can be moved under another one (used for copy/move/duplicate) | Components/DMXPixelMappingRootComponent.h | |
virtual const FName & GetNamePrefix() |
Helper function for generating UObject name, the child should implement their own logic for Prefix name generation. | Components/DMXPixelMappingRootComponent.h | |
virtual FString GetUserName () |
Returns the name of the component. | Components/DMXPixelMappingRootComponent.h | |
virtual void RemoveChild
(
UDMXPixelMappingBaseComponent* InComponent |
Remove the child component by the given component object. | Components/DMXPixelMappingRootComponent.h | |
virtual void Render() |
Renders this component and all children | Components/DMXPixelMappingRootComponent.h | |
virtual void RenderAndSendDMX() |
Render downsample texture and send DMX for this component and all children | Components/DMXPixelMappingRootComponent.h | |
virtual void ResetDMX
(
EDMXPixelMappingResetDMXMode ResetMode |
Reset all sending DMX channels to 0 for this component and all children | Components/DMXPixelMappingRootComponent.h | |
virtual void SendDMX() |
Send DMX values of this component and all children. | Components/DMXPixelMappingRootComponent.h |
Protected
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Components/DMXPixelMappingRootComponent.h | ||
virtual void PostLoad() |
Components/DMXPixelMappingRootComponent.h |