SCR_LayersEditorComponent Class Reference

Inheritance diagram for SCR_LayersEditorComponent:

Protected Member Functions
bool	IsEditingLayersEnabled ()
void	SetEditingLayersEnabled (bool enableLayerEditing)
ScriptInvoker	GetOnCurrentLayerChange ()
void	OnEditorModeChanged (SCR_EditorModeEntity currentModeEntity, SCR_EditorModeEntity prevModeEntity)
void	SetCurrentLayer (SCR_EditableEntityComponent entity)
void	SetCurrentLayerToParent ()
void	ToggleCurrentLayer (SCR_EditableEntityComponent entity)
SCR_EditableEntityComponent	GetCurrentLayer ()
void	CreateNewLayerWithSelected (notnull set< SCR_EditableEntityComponent > entities, vector worldPosition)
void	CreateNewLayerWithSelectedRpl (notnull array< RplId > entityIDs, vector transform[4], RplId currentLayerID)
SCR_EditableEntityComponent	GetParentBelowCurrentLayer (SCR_EditableEntityComponent entity)
bool	IsUnderCurrentLayer (SCR_EditableEntityComponent entity, bool onlyDirect=false, bool applyExceptions=false)
void	MoveToCurrentLayer (notnull set< SCR_EditableEntityComponent > entities)
void	MoveToLayer (notnull set< SCR_EditableEntityComponent > entities, SCR_EditableEntityComponent layer)
void	MoveToLayerAndSelect (notnull set< SCR_EditableEntityComponent > entities, SCR_EditableEntityComponent layer, bool selectParentAfterMove=false)
void	SplitGroupAndAddCharacters (SCR_EditableCharacterComponent leader, notnull set< SCR_EditableEntityComponent > entities)
void	AddCharactersToGroup (notnull set< SCR_EditableEntityComponent > entities, SCR_EditableEntityComponent group)
void	OnEditableParentChanged (SCR_EditableEntityComponent entity, SCR_EditableEntityComponent newParent, SCR_EditableEntityComponent prevParent)
void	DelayedSelectMovedEntity (SCR_EditableEntityComponent entity)
void	OnSelectionChanged (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesSelected, set< SCR_EditableEntityComponent > entitiesDeselected)
void	ClearEntitiesSelectAfterMove ()
void	EntitiesSelectAfterMoveDone (SCR_EditableEntityComponent lastEntity)
void	MoveToLayerServer (notnull array< RplId > entityIDs, RplId layerID)
void	OnUserSettingsChanged ()
void	OnEntityUnregistered (SCR_EditableEntityComponent entity)
void	OnEntityAccessKeyChanged (SCR_EditableEntityComponent entity)
void	OnEntityVisibilityChanged (SCR_EditableEntityComponent entity)
void	OnAccessKeysChanged ()
override void	EOnEditorDebug (array< string > debugTexts)
override void	EOnEditorInit ()
override void	EOnEditorDelete ()
override void	EOnEditorOpen ()
override void	EOnEditorClose ()
override void	OnDelete (IEntity owner)

Protected Attributes
ResourceName	m_sNewLayerPrefab
bool	m_bEditingLayersEnabled
SCR_BaseEditableEntityFilter	m_SelectionFilter
SCR_EditableEntityCore	m_Core
ref set< SCR_EditableEntityComponent >	m_EntitiesToSelectAfterMove = new set<SCR_EditableEntityComponent>()
SCR_EditableEntityComponent	m_NewGroupLeader
bool	m_bSelectAfterMoveCanceled
bool	m_bSelectParentAfterMove

Detailed Description

Manager of current layer.

Examples

F:/Games/AReforger/scripts/Game/Editor/Containers/EditableEntityFilters/SCR_RenderedEditableEntityFilter.c.

Definition at line 11 of file SCR_LayersEditorManager.c.

Member Function Documentation

AddCharactersToGroup()

void SCR_LayersEditorComponent::AddCharactersToGroup ( notnull set< SCR_EditableEntityComponent > entities, SCR_EditableEntityComponent group )

inlineprotected

Definition at line 317 of file SCR_LayersEditorManager.c.

ClearEntitiesSelectAfterMove()

void SCR_LayersEditorComponent::ClearEntitiesSelectAfterMove ( )

inlineprotected

Definition at line 392 of file SCR_LayersEditorManager.c.

CreateNewLayerWithSelected()

void SCR_LayersEditorComponent::CreateNewLayerWithSelected ( notnull set< SCR_EditableEntityComponent > entities, vector worldPosition )

inlineprotected

Creates a new layer and add selected entities in it

Definition at line 127 of file SCR_LayersEditorManager.c.

CreateNewLayerWithSelectedRpl()

void SCR_LayersEditorComponent::CreateNewLayerWithSelectedRpl ( notnull array< RplId > entityIDs, vector transform[4], RplId currentLayerID )

inlineprotected

Definition at line 146 of file SCR_LayersEditorManager.c.

DelayedSelectMovedEntity()

void SCR_LayersEditorComponent::DelayedSelectMovedEntity ( SCR_EditableEntityComponent entity )

inlineprotected

Definition at line 340 of file SCR_LayersEditorManager.c.

EntitiesSelectAfterMoveDone()

void SCR_LayersEditorComponent::EntitiesSelectAfterMoveDone ( SCR_EditableEntityComponent lastEntity )

inlineprotected

Definition at line 405 of file SCR_LayersEditorManager.c.

EOnEditorClose()

override void SCR_LayersEditorComponent::EOnEditorClose ( )

inlineprotected

Definition at line 550 of file SCR_LayersEditorManager.c.

EOnEditorDebug()

override void SCR_LayersEditorComponent::EOnEditorDebug ( array< string > debugTexts )

inlineprotected

Definition at line 483 of file SCR_LayersEditorManager.c.

EOnEditorDelete()

override void SCR_LayersEditorComponent::EOnEditorDelete ( )

inlineprotected

Definition at line 519 of file SCR_LayersEditorManager.c.

EOnEditorInit()

override void SCR_LayersEditorComponent::EOnEditorInit ( )

inlineprotected

Definition at line 499 of file SCR_LayersEditorManager.c.

EOnEditorOpen()

override void SCR_LayersEditorComponent::EOnEditorOpen ( )

inlineprotected

Definition at line 537 of file SCR_LayersEditorManager.c.

GetCurrentLayer()

SCR_EditableEntityComponent SCR_LayersEditorComponent::GetCurrentLayer ( )

inlineprotected

Get current layer.

Returns

Editable entity

Definition at line 119 of file SCR_LayersEditorManager.c.

GetOnCurrentLayerChange()

ScriptInvoker SCR_LayersEditorComponent::GetOnCurrentLayerChange ( )

inlineprotected

Used to subscribe to Event_OnCurrentLayerChange.

Returns

Script invoker is returned to subscribe to.

Definition at line 53 of file SCR_LayersEditorManager.c.

GetParentBelowCurrentLayer()

SCR_EditableEntityComponent SCR_LayersEditorComponent::GetParentBelowCurrentLayer ( SCR_EditableEntityComponent entity )

inlineprotected

Get parent below selection current layer, i.e., composition of an entity. When the entity is directly below current layer, the entity will be returned. When the entity is above the current layer, null is returned. Entity with IGNORE_LAYERS flag is always returned directly.

Parameters

entity

Queried entity

Returns

Editable entity

Definition at line 175 of file SCR_LayersEditorManager.c.

IsEditingLayersEnabled()

bool SCR_LayersEditorComponent::IsEditingLayersEnabled ( )

inlineprotected

Returns

True if layer editing is enabled

Definition at line 30 of file SCR_LayersEditorManager.c.

IsUnderCurrentLayer()

bool SCR_LayersEditorComponent::IsUnderCurrentLayer ( SCR_EditableEntityComponent entity, bool onlyDirect = false, bool applyExceptions = false )

inlineprotected

Check if the entity is under given current layer.

Parameters

entity	Queried entity
onlyDirect	True to check if the entity is directly under current layer, false to check it recursively

Returns

True if under current layer, or if flagged with EEditableEntityFlag.IGNORE_LAYERS

Definition at line 195 of file SCR_LayersEditorManager.c.

MoveToCurrentLayer()

void SCR_LayersEditorComponent::MoveToCurrentLayer ( notnull set< SCR_EditableEntityComponent > entities )

inlineprotected

Move all entities under the current root. Entities which are under other marked entities will remain under them.

Parameters

entities

Affected entities

Definition at line 243 of file SCR_LayersEditorManager.c.

MoveToLayer()

void SCR_LayersEditorComponent::MoveToLayer ( notnull set< SCR_EditableEntityComponent > entities, SCR_EditableEntityComponent layer )

inlineprotected

Move all entities under specific layer. Entities which are under other marked entities will remain under them.

Parameters

entities	Affected entities
layer	Target layer

Definition at line 253 of file SCR_LayersEditorManager.c.

MoveToLayerAndSelect()

void SCR_LayersEditorComponent::MoveToLayerAndSelect ( notnull set< SCR_EditableEntityComponent > entities, SCR_EditableEntityComponent layer, bool selectParentAfterMove = false )

inlineprotected

Move all entities under specific layer then sets the layer as current and sets the entities moved selected Entities which are under other marked entities will remain under them.

Parameters

entities	Affected entities
layer	Target layer

Definition at line 272 of file SCR_LayersEditorManager.c.

MoveToLayerServer()

void SCR_LayersEditorComponent::MoveToLayerServer ( notnull array< RplId > entityIDs, RplId layerID )

inlineprotected

Definition at line 417 of file SCR_LayersEditorManager.c.

OnAccessKeysChanged()

void SCR_LayersEditorComponent::OnAccessKeysChanged ( )

inlineprotected

Definition at line 478 of file SCR_LayersEditorManager.c.

OnDelete()

override void SCR_LayersEditorComponent::OnDelete ( IEntity owner )

inlineprotected

Definition at line 562 of file SCR_LayersEditorManager.c.

OnEditableParentChanged()

void SCR_LayersEditorComponent::OnEditableParentChanged ( SCR_EditableEntityComponent entity, SCR_EditableEntityComponent newParent, SCR_EditableEntityComponent prevParent )

inlineprotected

Definition at line 323 of file SCR_LayersEditorManager.c.

OnEditorModeChanged()

void SCR_LayersEditorComponent::OnEditorModeChanged ( SCR_EditorModeEntity currentModeEntity, SCR_EditorModeEntity prevModeEntity )

inlineprotected

Definition at line 59 of file SCR_LayersEditorManager.c.

OnEntityAccessKeyChanged()

void SCR_LayersEditorComponent::OnEntityAccessKeyChanged ( SCR_EditableEntityComponent entity )

inlineprotected

Definition at line 468 of file SCR_LayersEditorManager.c.

OnEntityUnregistered()

void SCR_LayersEditorComponent::OnEntityUnregistered ( SCR_EditableEntityComponent entity )

inlineprotected

Definition at line 463 of file SCR_LayersEditorManager.c.

OnEntityVisibilityChanged()

void SCR_LayersEditorComponent::OnEntityVisibilityChanged ( SCR_EditableEntityComponent entity )

inlineprotected

Definition at line 473 of file SCR_LayersEditorManager.c.

OnSelectionChanged()

void SCR_LayersEditorComponent::OnSelectionChanged ( EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesSelected, set< SCR_EditableEntityComponent > entitiesDeselected )

inlineprotected

Definition at line 359 of file SCR_LayersEditorManager.c.

OnUserSettingsChanged()

void SCR_LayersEditorComponent::OnUserSettingsChanged ( )

inlineprotected

Definition at line 452 of file SCR_LayersEditorManager.c.

SetCurrentLayer()

void SCR_LayersEditorComponent::SetCurrentLayer ( SCR_EditableEntityComponent entity )

inlineprotected

Set current layer. When a entity is focused / selected, it will include all siblings up to this current layer.

Parameters

entity

Editable entity

Definition at line 70 of file SCR_LayersEditorManager.c.

SetCurrentLayerToParent()

void SCR_LayersEditorComponent::SetCurrentLayerToParent ( )

inlineprotected

Set selection current layer to the parent entity of the current current layer entity.

Parameters

entity

Editable entity

Definition at line 87 of file SCR_LayersEditorManager.c.

SetEditingLayersEnabled()

void SCR_LayersEditorComponent::SetEditingLayersEnabled ( bool enableLayerEditing )

inlineprotected

Set if layer editing should ne enabled. When disabled, it will not be possible to enter layers or move entities between them.

Parameters

enableLayerEditing

True to enable layer editing

Definition at line 40 of file SCR_LayersEditorManager.c.

SplitGroupAndAddCharacters()

void SCR_LayersEditorComponent::SplitGroupAndAddCharacters ( SCR_EditableCharacterComponent leader, notnull set< SCR_EditableEntityComponent > entities )

inlineprotected

Definition at line 294 of file SCR_LayersEditorManager.c.

ToggleCurrentLayer()

void SCR_LayersEditorComponent::ToggleCurrentLayer ( SCR_EditableEntityComponent entity )

inlineprotected

When given entity is the current layer, move one layer up, otherwise set current layer to the entity's composition root (unless it's from inactive layer, in which case set the entity as current layer directly).

Parameters

entity

Editable entity

Definition at line 99 of file SCR_LayersEditorManager.c.

Member Data Documentation

m_bEditingLayersEnabled

bool SCR_LayersEditorComponent::m_bEditingLayersEnabled

protected

Definition at line 19 of file SCR_LayersEditorManager.c.

m_bSelectAfterMoveCanceled

bool SCR_LayersEditorComponent::m_bSelectAfterMoveCanceled

protected

Definition at line 24 of file SCR_LayersEditorManager.c.

m_bSelectParentAfterMove

bool SCR_LayersEditorComponent::m_bSelectParentAfterMove

protected

Definition at line 25 of file SCR_LayersEditorManager.c.

m_Core

SCR_EditableEntityCore SCR_LayersEditorComponent::m_Core

protected

Definition at line 21 of file SCR_LayersEditorManager.c.

m_EntitiesToSelectAfterMove

ref set<SCR_EditableEntityComponent> SCR_LayersEditorComponent::m_EntitiesToSelectAfterMove = new set<SCR_EditableEntityComponent>()

protected

Definition at line 22 of file SCR_LayersEditorManager.c.

m_NewGroupLeader

SCR_EditableEntityComponent SCR_LayersEditorComponent::m_NewGroupLeader

protected

Definition at line 23 of file SCR_LayersEditorManager.c.

m_SelectionFilter

SCR_BaseEditableEntityFilter SCR_LayersEditorComponent::m_SelectionFilter

protected

Definition at line 20 of file SCR_LayersEditorManager.c.

m_sNewLayerPrefab

ResourceName SCR_LayersEditorComponent::m_sNewLayerPrefab

protected

Definition at line 14 of file SCR_LayersEditorManager.c.

---

The documentation for this class was generated from the following file:

• scripts/Game/Editor/Components/Editor/SCR_LayersEditorManager.c