1. Epic GamesDeveloper
  3. IMovieGraphModifierNodeInterface

IMovieGraphModifierNodeInterface

Provides the interface that nodes must implement if they want to provide modifier behavior.

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

Provides the interface that nodes must implement if they want to provide modifier behavior.

If a modifier node does not support collections, it must specify this explicitly via SupportsCollections(). If it does not support collections, all collection-related methods can remain unimplemented.

Note that some of these methods may not be called by MRG yet, but they may be called in the future (eg, in future UIs). To ensure modifier functionality in the future, implement all methods that make sense for the modifier.

   
Name IMovieGraphModifierNodeInterface
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/Nodes/MovieGraphModifierNode.h
Include Path #include "Graph/Nodes/MovieGraphModifierNode.h"

Syntax

class IMovieGraphModifierNodeInterface : public IInterface

Implements Interfaces

Derived Classes

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddCollection ( const FName& InCollectionName
)

 Adds a collection identified by the given name which will be affected by the modifiers on this node. Graph/Nodes/MovieGraphModifierNode.h
  • BlueprintCallable
  • Category="Modifiers"

virtual TArray< FName > GetAllCollections()

 Gets all collections that will be affected by the modifiers used by this node. Graph/Nodes/MovieGraphModifierNode.h
  • BlueprintCallable
  • Category="Modifiers"

virtual TArray< UMovieGraphModifierBase * > GetAllModifiers()

 Gets all modifiers that will be applied with this modifier node. Graph/Nodes/MovieGraphModifierNode.h
  • BlueprintCallable
  • Category="Modifiers"

virtual bool IsCollectionEnabled ( const FName& InCollectionName
) const

 Gets the enable state (within this modifier) of the collection with the given name. Graph/Nodes/MovieGraphModifierNode.h
  • BlueprintCallable
  • Category="Modifiers"

virtual bool RemoveCollection ( const FName& InCollectionName
)

 Removes a collection identified by the given name. Graph/Nodes/MovieGraphModifierNode.h
  • BlueprintCallable
  • Category="Modifiers"

virtual void SetCollectionEnabled ( const FName& InCollectionName,
const bool bIsCollectionEnabled
)

 Sets the enable state (within this modifier) of the collection with the given name. Graph/Nodes/MovieGraphModifierNode.h
  • BlueprintCallable
  • Category="Modifiers"

virtual bool SupportsCollections()

 Gets whether this modifier node supports/uses collections. Graph/Nodes/MovieGraphModifierNode.h
  • BlueprintCallable
  • Category="Modifiers"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page