1. Epic GamesDeveloper
  3. FSceneOutlinerModule

FSceneOutlinerModule

Implements the Scene Outliner module.

API > API/Editor > API/Editor/SceneOutliner

Implements the Scene Outliner module.

   
Name FSceneOutlinerModule
Type class
Header File /Engine/Source/Editor/SceneOutliner/Public/SceneOutlinerModule.h
Include Path #include "SceneOutlinerModule.h"

Syntax

class FSceneOutlinerModule : public IModuleInterface

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FSceneOutlinerModule()

   SceneOutlinerModule.h  

Typedefs

Name Type Remarks Include Path
FOnColumnPermissionListChanged TMulticastDelegate_NoParams< void > Delegate that broadcasts when column permission list changes. SceneOutlinerModule.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DefaultColumnMap TMap< FName, FSceneOutlinerColumnInfo > Map of column type name -> default column info SceneOutlinerModule.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ColumnMap TMap< FName, FCreateSceneOutlinerColumn > Map of column type name -> factory delegate SceneOutlinerModule.h  
ColumnPermissionList TSharedRef< FNamePermissionList > Column permission list used to filter scene ouliner columns. SceneOutlinerModule.h  
ColumnPermissionListChanged FOnColumnPermissionListChanged Delegate that broadcasts when column permission list changes. SceneOutlinerModule.h  
CustomOutlinerFactories TMap< FName, FSceneOutlinerFactory >   SceneOutlinerModule.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< ISceneOutliner > CreateActorBrowser ( const FSceneOutlinerInitializationOptions& InInitOptions,
TWeakObjectPtr< UWorld > SpecifiedWorld
) const

 Creates an actor browser widget (also known as a World Outliner). SceneOutlinerModule.h  

virtual void CreateActorBrowserColumns ( FSceneOutlinerInitializationOptions& InInitOptions,
UWorld* InWorld
) const

 Add the columns present in the level editor's Outliner (Actor Browser) to the given init options SceneOutlinerModule.h  

void CreateActorInfoColumns ( FSceneOutlinerInitializationOptions& InInitOptions,
UWorld* WorldPtr
) const

   SceneOutlinerModule.h  

virtual TSharedRef< ISceneOutliner > CreateActorPicker ( const FSceneOutlinerInitializationOptions& InInitOptions,
const FOnActorPicked& OnActorPickedDelegate,
TWeakObjectPtr< UWorld > SpecifiedWorld,
bool bHideLevelInstanceHierarchy
) const

 Creates an actor picker widget. Calls the OnActorPickedDelegate when an item is selected. SceneOutlinerModule.h  

virtual TSharedRef< ISceneOutliner > CreateComponentPicker ( const FSceneOutlinerInitializationOptions& InInitOptions,
const FOnComponentPicked& OnComponentPickedDelegate,
TWeakObjectPtr< UWorld > SpecifiedWorld
) const

 Creates a component picker widget. Calls the OnComponentPickedDelegate when an item is selected. SceneOutlinerModule.h  

virtual TSharedPtr< ISceneOutliner > CreateCustomRegisteredOutliner ( FName ID,
FSceneOutlinerInitializationOptions InInitOptions
)

 Try to create a custom scene outliner using a registered factory (nullptr if ID was not registered) SceneOutlinerModule.h  

virtual TSharedRef< ISceneOutliner > CreateSceneOutliner ( const FSceneOutlinerInitializationOptions& InitOptions
) const

 Creates a scene outliner widget SceneOutlinerModule.h  

void CreateWorldPartitionColumns ( FSceneOutlinerInitializationOptions& InInitOptions,
UWorld* WorldPtr
) const

   SceneOutlinerModule.h  

TSharedPtr< ISceneOutlinerColumn > FactoryColumn ( FName ID,
ISceneOutliner& Outliner
) const

 Factory a new column from the specified name. SceneOutlinerModule.h  

TSharedRef< FNamePermissionList > & GetColumnPermissionList()

 Column permission list SceneOutlinerModule.h  

virtual bool IsCustomSceneOutlinerFactoryRegistered ( FName ID
)

 Check if a custom scene outliner factory is registered with the given ID SceneOutlinerModule.h  

FOnColumnPermissionListChanged & OnColumnPermissionListChanged()

   SceneOutlinerModule.h  

void RegisterColumnType()

 Register a new type of column available to all scene outliners SceneOutlinerModule.h  

virtual void RegisterCustomSceneOutlinerFactory ( FName ID,
FSceneOutlinerFactory InOutlinerFactory
)

 Register a factory to create a custom Scene Outliner SceneOutlinerModule.h  

void RegisterDefaultColumnType ( FSceneOutlinerColumnInfo InColumnInfo
)

 Register a new type of default column available to all scene outliners SceneOutlinerModule.h  

virtual void ShutdownModule()

   SceneOutlinerModule.h  

virtual void StartupModule()

   SceneOutlinerModule.h  

void UnRegisterColumnType()

 Unregister a previously registered column type SceneOutlinerModule.h  

virtual void UnregisterCustomSceneOutlinerFactory ( FName ID
)

 Unregister a factory to create a custom Scene Outliner SceneOutlinerModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page