ICompElementManager

Interface for running editor operations/logic on compositing element actors.

Windows
MacOS
Linux

References

Module

ComposureLayersEditor

Header

/Engine/Plugins/Compositing/Composure/Source/ComposureLayersEditor/Public/ICompElementManager.h

Include

#include "ICompElementManager.h"

Syntax

class ICompElementManager

Remarks

Interface for running editor operations/logic on compositing element actors.

Functions

Name Description

Public function Const

void

 

AddAllCompElementsTo

(
    TArray< TWeakObjectPtr< ACompositin...
)

Gets all known elements and appends them to the provided array.

Public function

bool

 

AttachCompElement

(
    const FName ParentName,
    const FName ElementName
)

Attaches the specified element as a child to the named parent.

Public function

TWeakObjectP...

 

CreateElement

(
    const FName& ElementName,
    TSubclassOf< ACompositingElement > ...,
    AActor* LevelContext,
    UPackage* OverridePackage
)

Creates a actor object for the named element.

Public function

void

 

DeleteElementAndChildren

(
    const FName& ElementToDelete,
    bool bIsCalledFromEditor
)

Deletes the specified element and all of its children.

Public function

void

 

DeleteElements

(
    const TArray< FName >& ElementsToD...,
    bool bIsCalledFromEditor
)

Deletes all of the provided elements and all of their children if the function is called from editor.

Public function Const

TWeakObjectP...

 

GetElement

(
    const FName& ElementName
)

Gets the actor object of the named element.

Public function Const

bool

 

IsDrawing

(
    ACompositingElement* CompEleme...
)

Determines if the specified element is being rendered by the hidden compositing viewport.

Public function

void

 

OnCreateNewElement

(
    AActor* NewElement
)

Function used to expose the editor call back function after a new composure element is created via Blueprint and C++.

Public function

void

 

OnDeleteElement

(
    AActor* ElementToDelete
)

Function used to expose the editor call back function after an existing composure element

Public function

FOnElementsC...

 

OnElementsChanged()

Public function

void

 

RefreshElementsList()

Re-queries the scene for element actors and rebuilds the authoritative list used by the editor.

Public function

void

 

RemoveMediaCapture

(
    const FName& ElementName
)

Deletes any media-capture passes from the specified element.

Public function

bool

 

RenameElement

(
    const FName OriginalElementName,
    const FName& NewElementName
)

Renames the element with the specified original named to the provided new name.

Public function

void

 

RequestRedraw()

Dirties the draw state so editor element instance get ran/rendered this frame (utilized when rendering on demand, instead of intrinsically each frame).

Public function

UCompositing...

 

ResetMediaCapture

(
    const FName& ElementName
)

Re-Prompts the user to select a UMediaOutput asset to associate the name element's media-capture pass with.

Public function

bool

 

SelectElementActors

(
    const TArray< FName >& ElementName...,
    bool bSelect,
    bool bNotify,
    bool bSelectEvenIfHidden,
    const TSharedPtr< FActorFilter >& ...
)

Selects/de-selects specified element actors.

Public function

void

 

ToggleElementFreezeFrame

(
    const FName& ElementName
)

Toggles the named element's pause state.

Public function

void

 

ToggleElementRendering

(
    const FName& ElementName
)

Toggles the named element's enabled state.

Public function

void

 

ToggleMediaCapture

(
    const FName& ElementName
)

Adds/Enables/Disables a media-capture output pass for the specified element.

Public function

bool

 

TryGetElement

(
    const FName& ElementName,
    TWeakObjectPtr< ACompositingElement...
)

Attempts to get the actor object of the provided element name.

Classes

Name

Description

Public class

FOnElementsChanged

Broadcasts whenever one or more elements are modified

Typedefs

Name

Description

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