1. Epic GamesDeveloper
  3. ULayersSubsystem

ULayersSubsystem

API > API/Editor > API/Editor/UnrealEd

   
Name ULayersSubsystem
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/Layers/LayersSubsystem.h
Include Path #include "Layers/LayersSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class ULayersSubsystem : public UEditorSubsystem

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ULayersSubsystem()

 Destructor Layers/LayersSubsystem.h  

Classes

Name Remarks
FOnActorsLayersChanged Broadcasts whenever one or more Actors changed layers
FOnLayersChanged Broadcasts whenever one or more Layers are modified

Typedefs

Name Type Remarks Include Path
ActorFilter IFilter< const TWeakObjectPtr< AActor > & >   Layers/LayersSubsystem.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActorsLayersChanged FOnActorsLayersChanged Fires whenever one or more actor layer changes Layers/LayersSubsystem.h  
LayersBroadcast TSharedPtr< class FLayersBroadcast > Auxiliary class that sets the callback function to FEditorDelegates::MapChange.Broadcast() and FEditorDelegates::RefreshLayerBrowser.Broadcast(). Layers/LayersSubsystem.h  
LayersChanged FOnLayersChanged Fires whenever one or more layer changes Layers/LayersSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AddActorsToLayer ( const TArray< TWeakObjectPtr< AActor > >& Actors,
const FName& LayerName
)

 Add the actors to the named layer Layers/LayersSubsystem.h  

bool AddActorsToLayer ( const TArray< AActor* >& Actors,
const FName& LayerName
)

 Add the actors to the named layer Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool AddActorsToLayers ( const TArray< TWeakObjectPtr< AActor > >& Actors,
const TArray< FName >& LayerNames
)

 Add the actors to the named layers Layers/LayersSubsystem.h  

bool AddActorsToLayers ( const TArray< AActor* >& Actors,
const TArray< FName >& LayerNames
)

 Add the actors to the named layers Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool AddActorToLayer ( AActor* Actor,
const FName& LayerName
)

 Adds the actor to the named layer. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool AddActorToLayers ( AActor* Actor,
const TArray< FName >& LayerNames
)

 Adds the provided actor to the named layers. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void AddAllLayerNamesTo ( TArray< FName >& OutLayerNames
) const

 Gets all known layers and appends their names to the provide array Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void AddAllLayersTo ( TArray< TWeakObjectPtr< ULayer > >& OutLayers
) const

 Gets all known layers and appends them to the provided array Layers/LayersSubsystem.h  

virtual void AddAllLayersTo ( TArray< ULayer* >& OutLayers
) const

 Gets all known layers and appends them to the provided array Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void AddLevelLayerInformation ( ULevel* Level
)

 Aggregates any information regarding layers associated with the level and it contents Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool AddSelectedActorsToLayer ( const FName& LayerName
)

 Adds selected actors to the named layer. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool AddSelectedActorsToLayers ( const TArray< FName >& LayerNames
)

 Adds selected actors to the named layers. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void AppendActorsFromLayer ( const FName& LayerName,
TArray< TWeakObjectPtr< AActor > >& InOutActors,
const TSharedPtr< ActorFilter >& Filter
) const

 Appends all the actors associated with the specified layer. Layers/LayersSubsystem.h  

void AppendActorsFromLayer ( const FName& LayerName,
TArray< AActor* >& InOutActors
) const

 Appends all the actors associated with the specified layer. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

void AppendActorsFromLayer ( const FName& LayerName,
TArray< AActor* >& InOutActors,
const TSharedPtr< ActorFilter >& Filter
) const

 Appends all the actors associated with the specified layer. Layers/LayersSubsystem.h  

virtual void AppendActorsFromLayers ( const TArray< FName >& LayerNames,
TArray< TWeakObjectPtr< AActor > >& InOutActors,
const TSharedPtr< ActorFilter >& Filter
) const

 Appends all the actors associated with ANY of the specified layers. Layers/LayersSubsystem.h  

void AppendActorsFromLayers ( const TArray< FName >& LayerNames,
TArray< AActor* >& InOutActors,
const TSharedPtr< ActorFilter >& Filter
) const

 Appends all the actors associated with ANY of the specified layers. Layers/LayersSubsystem.h  

void AppendActorsFromLayers ( const TArray< FName >& LayerNames,
TArray< AActor* >& InOutActors
) const

 Appends all the actors associated with ANY of the specified layers. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

ULayer * CreateLayer ( const FName& LayerName
)

 Creates a ULayer Object for the named layer Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void Deinitialize()

 Internal cleanup Layers/LayersSubsystem.h  

virtual void DeleteLayer ( const FName& LayerToDelete
)

 Deletes the provided layer, disassociating all actors from them Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void DeleteLayers ( const TArray< FName >& LayersToDelete
)

 Deletes all of the provided layers, disassociating all actors from them Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool DisassociateActorFromLayers ( AActor* Actor
)

 Disassociates an Actor's layers from the layer system, general used before deleting the Actor Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool DisassociateActorsFromLayers ( const TArray< AActor* >& Actors
)

 Disassociates actors from the layer system, generally used before deleting the Actors Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

void EditorMapChange()

 Delegate handler for FEditorDelegates::MapChange. It internally calls LayersChanged.Broadcast. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers
Delegate handler for FEditorDelegates::RefreshLayerBrowser. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

TArray< AActor * > GetActorsFromLayer ( const FName& LayerName
) const

 Gets all the actors associated with the specified layer. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

TArray< AActor * > GetActorsFromLayer ( const FName& LayerName,
const TSharedPtr< ActorFilter >& Filter
) const

 Gets all the actors associated with the specified layer. Layers/LayersSubsystem.h  

TArray< AActor * > GetActorsFromLayers ( const TArray< FName >& LayerNames,
const TSharedPtr< ActorFilter >& Filter
) const

 Gets all the actors associated with ANY of the specified layers. Layers/LayersSubsystem.h  

TArray< AActor * > GetActorsFromLayers ( const TArray< FName >& LayerNames
) const

 Gets all the actors associated with ANY of the specified layers. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

ULayer * GetLayer ( const FName& LayerName
) const

 Gets the ULayer Object of the named layer Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

TArray< AActor * > GetSelectedActors()

 Find and return the selected actors. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

UWorld * GetWorld()

 Get the current UWorld object. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

 Prepares for use Layers/LayersSubsystem.h  

virtual bool InitializeNewActorLayers ( AActor* Actor
)

 Synchronizes an newly created Actor's layers with the layer system Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool IsActorValidForLayer ( AActor* Actor
)

 Checks to see if the specified actor is in an appropriate state to interact with layers Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

bool IsLayer ( const FName& LayerName
)

 Checks whether the ULayer Object of the provided layer name exists. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void MakeAllLayersVisible()

 Set the visibility of all layers to true Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual FOnActorsLayersChanged & OnActorsLayersChanged()

   Layers/LayersSubsystem.h  

virtual FOnLayersChanged & OnLayersChanged()

   Layers/LayersSubsystem.h  

void PostUndoRedo ()

 Delegate handler for FEditorDelegates::PostUndoRedo. Layers/LayersSubsystem.h  

virtual bool RemoveActorFromLayer ( AActor* Actor,
const FName& LayerToRemove,
const bool bUpdateStats
)

 Removes an actor from the specified layer. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool RemoveActorFromLayers ( AActor* Actor,
const TArray< FName >& LayerNames,
const bool bUpdateStats
)

 Removes the provided actor from the named layers. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool RemoveActorsFromLayer ( const TArray< TWeakObjectPtr< AActor > >& Actors,
const FName& LayerName,
const bool bUpdateStats
)

 Removes the actors from the specified layer. Layers/LayersSubsystem.h  

bool RemoveActorsFromLayer ( const TArray< AActor* >& Actors,
const FName& LayerName,
const bool bUpdateStats
)

 Removes the actors from the specified layer. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

bool RemoveActorsFromLayers ( const TArray< AActor* >& Actors,
const TArray< FName >& LayerNames,
const bool bUpdateStats
)

 Remove the actors to the named layers Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool RemoveActorsFromLayers ( const TArray< TWeakObjectPtr< AActor > >& Actors,
const TArray< FName >& LayerNames,
const bool bUpdateStats
)

 Remove the actors to the named layers Layers/LayersSubsystem.h  

virtual void RemoveLevelLayerInformation ( ULevel* Level
)

 Purges any information regarding layers associated with the level and it contents Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool RemoveSelectedActorsFromLayer ( const FName& LayerName
)

 Removes the selected actors from the named layer. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool RemoveSelectedActorsFromLayers ( const TArray< FName >& LayerNames
)

 Removes selected actors from the named layers. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void RemoveViewFromActorViewVisibility ( FLevelEditorViewportClient* ViewportClient
)

 Removes the corresponding visibility bit from all actors (slides the later bits down 1) Layers/LayersSubsystem.h  

virtual bool RenameLayer ( const FName& OriginalLayerName,
const FName& NewLayerName
)

 Renames the provided originally named layer to the provided new name Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

bool SelectActorsInLayer ( const FName& LayerName,
const bool bSelect,
const bool bNotify,
const bool bSelectEvenIfHidden
)

 Selects/de-selects actors belonging to the named layer. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool SelectActorsInLayer ( const FName& LayerName,
const bool bSelect,
const bool bNotify,
const bool bSelectEvenIfHidden,
const TSharedPtr< ActorFilter >& Filter
)

 Selects/de-selects actors belonging to the named layer. Layers/LayersSubsystem.h  

bool SelectActorsInLayers ( const TArray< FName >& LayerNames,
const bool bSelect,
const bool bNotify,
const bool bSelectEvenIfHidden
)

 Selects/de-selects actors belonging to the named layers. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool SelectActorsInLayers ( const TArray< FName >& LayerNames,
const bool bSelect,
const bool bNotify,
const bool bSelectEvenIfHidden,
const TSharedPtr< ActorFilter >& Filter
)

 Selects/de-selects actors belonging to the named layers. Layers/LayersSubsystem.h  

virtual void SetLayersVisibility ( const TArray< FName >& LayerNames,
const bool bIsVisible
)

 Changes visibility of the named layers to the provided state Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void SetLayerVisibility ( const FName& LayerName,
const bool bIsVisible
)

 Changes the named layer's visibility to the provided state Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void ToggleLayersVisibility ( const TArray< FName >& LayerNames
)

 Toggles the visibility of all of the named layers Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void ToggleLayerVisibility ( const FName& LayerName
)

 Toggles the named layer's visibility Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool TryGetLayer ( const FName& LayerName,
ULayer*& OutLayer
)

 Attempts to get the ULayer Object of the provided layer name. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void UpdateActorAllViewsVisibility ( AActor* Actor
)

 Updates per-view visibility for the given actor for all views Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void UpdateActorViewVisibility ( FLevelEditorViewportClient* ViewportClient,
AActor* Actor,
const bool bReregisterIfDirty
)

 Updates per-view visibility for the given actor in the given view Layers/LayersSubsystem.h  

virtual bool UpdateActorVisibility ( AActor* Actor,
bool& bOutSelectionChanged,
bool& bOutActorModified,
const bool bNotifySelectionChange,
const bool bRedrawViewports
)

 Updates the provided actors visibility in the viewports Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual bool UpdateAllActorsVisibility ( const bool bNotifySelectionChange,
const bool bRedrawViewports
)

 Updates the visibility of all actors in the viewports Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void UpdateAllViewVisibility ( const FName& LayerThatChanged
)

 Updates the visibility for all actors for all views. Layers/LayersSubsystem.h
  • BlueprintCallable
  • Category=Layers

virtual void UpdatePerViewVisibility ( FLevelEditorViewportClient* ViewportClient,
const FName& LayerThatChanged
)

 Updates the per-view visibility for all actors for the given view Layers/LayersSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page