Manager of basic entity transformation in all axes, e.g., translation or rotation. More...

Inheritance diagram for SCR_TransformingEditorComponent:

Public Member Functions
void	StartEditing (SCR_EditableEntityComponent pivot, notnull set< SCR_EditableEntityComponent > entities, vector transform[4])
	Initiate editing process.

bool	ConfirmEditing ()
	Confirm editing process.

void	CancelEditing ()
	Cancel editing process.

bool	IsEditing ()
	Check if editing is currently on.

bool	IsEditing (SCR_EditableEntityComponent entity)
	Check if given entity is edited.

ScriptInvoker	GetOnTransformationRequest ()
	Get event called when request for editing is sent to server.

ScriptInvoker	GetOnTransformationStart ()
	Get event called when editing is confirmed by server.

ScriptInvoker	GetOnTransformationConfirm ()
	Get event called when editing is confirmed.

ScriptInvoker	GetOnTransformationConfirmServer ()
	Get event called when editing is confirmed on server only.

ScriptInvoker	GetOnTransformationCancel ()
	Get event called when editing is canceled.

ScriptInvokerVoid	GetOnCleanStart ()

bool	CanBeTransformed ()

void	SetCanBeTransformed (bool val)

override void	EOnFrame (IEntity owner, float timeSlice)

override void	EOnEditorActivate ()
	When the component is activated.

override void	EOnEditorDeactivate ()
	When the component is deactivated.

Public Member Functions inherited from SCR_BaseEditorComponent
sealed void	OnInitBase ()

sealed void	OnDeleteBase ()

sealed void	OnRequestBase (bool isOpen)

sealed void	OnOpenedBase ()

sealed void	OnClosedBase ()

sealed void	OnPreActivateBase ()

sealed void	OnActivateBase ()

sealed bool	OnActivateAsyncBase (int attempt)

sealed void	OnPostActivateBase ()

sealed void	OnDeactivateBase ()

sealed void	OnPostDeactivateBase ()

sealed bool	OnDeactivateAsyncBase (int attempt)

sealed void	OnEffectBase (SCR_BaseEditorEffect effect)

SCR_EditorManagerEntity	GetManager ()
	Get editor manager this component belongs to.

SCR_BaseEditorComponent	FindEditorComponent (TypeName type, bool showError=false, bool modeFirst=false)
	Get the editor manager to which this component belongs.

EntityComponentPrefabData	GetEditorComponentData ()
	Get prefab data of this component.

bool	IsRemoved ()
	Check if the component is being deleted.

void	ResetEditorComponent ()
	Reset values controlled by the component.

ScriptInvoker	GetOnEffect ()
	Get event called when an effect is activated.

void	InitServer ()

void	InitOwner ()

override void	OnPostInit (IEntity owner)

void	SCR_BaseEditorComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

void	~SCR_BaseEditorComponent ()

Protected Member Functions
void	StartEditingServer (int pivotId, array< int > entityIds, vector dummyVector, vector transform[4], bool isUnderwater, EEditorTransformVertical verticalMode)

void	StartEditingOwner ()

void	ConfirmEditingServer (SCR_EditorPreviewParams params, int playerID)

void	ConfirmEditingOwner (bool result)

void	CancelEditingServer ()

void	Clean ()

void	OnEntityUnregistered (SCR_EditableEntityComponent entity)

void	OnEntityVisibilityChanged (SCR_EditableEntityComponent entity)

void	OnEntityAccessKeyChanged (SCR_EditableEntityComponent entity)

Protected Member Functions inherited from SCR_BaseEditorComponent
bool	IsOnEditorManager ()

bool	IsOwner ()

bool	IsProxy ()

bool	IsMaster ()

bool	IsAdmin ()

SCR_BaseEditorComponent	GetParentComponent ()

void	SetParentComponent (SCR_BaseEditorComponent parent)

void	SendNotification (ENotification notificationID, int selfID=0, int targetID=0, vector position=vector.Zero)

void	EOnEditorInit ()
	When the entity is created.

void	EOnEditorDelete ()
	When the entity is destroyed.

void	EOnEditorRequest (bool isOpen)
	When opening/closing request is sent to server.

void	EOnEditorOpen ()
	When the editor is opened.

void	EOnEditorClose ()
	When the editor is closed.

void	EOnEditorPreActivate ()
	Before the component is activated.

bool	EOnEditorActivateAsync (int attempt)
	When the component is activated.

void	EOnEditorPostActivate ()
	When the component is activated, but after EOnEditorActivate() function was called in all components.

bool	EOnEditorDeactivateAsync (int attempt)
	When the component is deactivated.

void	EOnEditorPostDeactivate ()
	When the component is deactivated, but after the next mode is activated.

void	EOnEditorDebug (array< string > debugTexts)
	Every frame while the editor is opened and debug menu is shown.

void	EOnEffect (SCR_BaseEditorEffect effect)
	When an effect is created in reaction an an event.

void	EOnEditorInitServer ()
	When the entity is created (called on server)

void	EOnEditorDeleteServer ()
	When the entity is destroyed (called on server)

void	EOnEditorOpenServer ()
	When the editor is opened (called on server)

void	EOnEditorOpenServerCallback ()
	When the editor is opened (called on server after async loading finished on client)

void	EOnEditorCloseServer ()
	When the editor is closed (called on server)

void	EOnEditorCloseServerCallback ()
	When the editor is closed (called on server after async loading finished on client)

void	EOnEditorActivateServer ()
	When the component is activated (called on server)

void	EOnEditorDeactivateServer ()
	When the component is deactivated (called on server)

Protected Attributes
ref set< SCR_EditableEntityComponent >	m_aEditedEntities

ref map< SCR_EditableEntityComponent, vector >	m_mServerEntityStartingPosition = new map<SCR_EditableEntityComponent, vector>()

SCR_EditableEntityComponent	m_EditedPivot

SCR_EditableEntityComponent	m_EditedLayer

SCR_RefPreviewEntity	m_RefEntity

SCR_StatesEditorComponent	m_StatesManager

SCR_PreviewEntityEditorComponent	m_PreviewManager

bool	m_bIsComposition

bool	m_bCanBeTransformed = true

ref ScriptInvoker	Event_OnTransformationRequest = new ScriptInvoker

ref ScriptInvoker	Event_OnTransformationStart = new ScriptInvoker

ref ScriptInvoker	Event_OnTransformationConfirm = new ScriptInvoker

ref ScriptInvoker	Event_OnTransformationCancel = new ScriptInvoker

ref ScriptInvokerVoid	m_OnCleanStart = new ScriptInvokerVoid()

ref ScriptInvoker	Event_OnTransformationConfirmServer = new ScriptInvoker

Protected Attributes inherited from SCR_BaseEditorComponent
SCR_EditorBaseEntity	m_Owner

SCR_EditorManagerEntity	m_Manager

SCR_BaseEditorComponent	m_Parent

RplComponent	m_RplComponent

Additional Inherited Members
Static Public Member Functions inherited from SCR_BaseEditorComponent
static Managed	GetInstance (TypeName type, bool showError=false, bool modeFirst=false)
	Get the local instance of a component attached on editor manager (SCR_EditorManagerEntity).

static Managed	GetInstance (SCR_EditorBaseEntity editorManager, TypeName type, bool showError=false)
	Get instance of a component attached on specific editor manager / mode (SCR_EditorBaseEntity).

static int	GetAllInstances (TypeName type, out notnull array< Managed > outComponents)
	Get component instances on editor manager (SCR_EditorBaseEntity) and all its modes (SCR_EditorModeEntity).

Detailed Description

Manager of basic entity transformation in all axes, e.g., translation or rotation.

Member Function Documentation

◆ CanBeTransformed()

bool SCR_TransformingEditorComponent.CanBeTransformed ( )

◆ CancelEditing()

void SCR_TransformingEditorComponent.CancelEditing ( )

Cancel editing process.

Must be called on editor's owner.

◆ CancelEditingServer()

void SCR_TransformingEditorComponent.CancelEditingServer ( )

protected

Implemented in SCR_CampaignBuildingTransformingEditorComponent.

◆ Clean()

void SCR_TransformingEditorComponent.Clean ( )

protected

◆ ConfirmEditing()

bool SCR_TransformingEditorComponent.ConfirmEditing ( )

Confirm editing process.

Must be called on editor's owner. All entities marked for editing by StartEditing() will be transformed to match the current position and rotation of the preview entity.

Returns: True if the request was sent

Implemented in SCR_CampaignBuildingTransformingEditorComponent.

◆ ConfirmEditingOwner()

void SCR_TransformingEditorComponent.ConfirmEditingOwner ( bool result )

protected

◆ ConfirmEditingServer()

void SCR_TransformingEditorComponent.ConfirmEditingServer	(	SCR_EditorPreviewParams	params,
		int	playerID
	)

protected

Implemented in SCR_CampaignBuildingTransformingEditorComponent.

◆ EOnEditorActivate()

override void SCR_TransformingEditorComponent.EOnEditorActivate ( )

When the component is activated.

When attached on SCR_EditorManagerEntity, this is executed together with EOnEditorOpen()
When attached on SCR_EditorModeEntity, it's executed when the mode is activated

Implements SCR_BaseEditorComponent.

Implemented in SCR_CampaignBuildingTransformingEditorComponent.

◆ EOnEditorDeactivate()

override void SCR_TransformingEditorComponent.EOnEditorDeactivate ( )

When the component is deactivated.

When attached on SCR_EditorManagerEntity, this is executed together with EOnEditorClose()
When attached on SCR_EditorModeEntity, it's executed when the mode is deactivated

Implements SCR_BaseEditorComponent.

Implemented in SCR_CampaignBuildingTransformingEditorComponent.

◆ EOnFrame()

override void SCR_TransformingEditorComponent.EOnFrame	(	IEntity	owner,
		float	timeSlice
	)

◆ GetOnCleanStart()

ScriptInvokerVoid SCR_TransformingEditorComponent.GetOnCleanStart ( )

◆ GetOnTransformationCancel()

ScriptInvoker SCR_TransformingEditorComponent.GetOnTransformationCancel ( )

Get event called when editing is canceled.

Called only for editor user.

Returns: Script invoker

◆ GetOnTransformationConfirm()

ScriptInvoker SCR_TransformingEditorComponent.GetOnTransformationConfirm ( )

Get event called when editing is confirmed.

Called only for editor user.

Returns: Script invoker

◆ GetOnTransformationConfirmServer()

ScriptInvoker SCR_TransformingEditorComponent.GetOnTransformationConfirmServer ( )

Get event called when editing is confirmed on server only.

Called only for editor user.

Returns: Script invoker (returns null if not on server)

◆ GetOnTransformationRequest()

ScriptInvoker SCR_TransformingEditorComponent.GetOnTransformationRequest ( )

Get event called when request for editing is sent to server.

Called only for editor user.

Returns: Script invoker

◆ GetOnTransformationStart()

ScriptInvoker SCR_TransformingEditorComponent.GetOnTransformationStart ( )

Get event called when editing is confirmed by server.

Called only for editor user.

Returns: Script invoker

◆ IsEditing() [1/2]

bool SCR_TransformingEditorComponent.IsEditing ( )

Check if editing is currently on.

Returns: True when editing

◆ IsEditing() [2/2]

bool SCR_TransformingEditorComponent.IsEditing ( SCR_EditableEntityComponent entity )

Check if given entity is edited.

Returns: True when editing the entity

◆ OnEntityAccessKeyChanged()

void SCR_TransformingEditorComponent.OnEntityAccessKeyChanged ( SCR_EditableEntityComponent entity )

protected

◆ OnEntityUnregistered()

void SCR_TransformingEditorComponent.OnEntityUnregistered ( SCR_EditableEntityComponent entity )

protected

◆ OnEntityVisibilityChanged()

void SCR_TransformingEditorComponent.OnEntityVisibilityChanged ( SCR_EditableEntityComponent entity )

protected

◆ SetCanBeTransformed()

void SCR_TransformingEditorComponent.SetCanBeTransformed ( bool val )

◆ StartEditing()

void SCR_TransformingEditorComponent.StartEditing	(	SCR_EditableEntityComponent	pivot,
		notnull set< SCR_EditableEntityComponent >	entities,
		vector	transform[4]
	)

Initiate editing process.

Must be called on editor's owner.

Parameters

pivot	Directly edited entity (most likely the one under cursor)
entities	Edited entities
transform	Pivot transformation, e.g., transformation of entity under cursor or position on which cursor clicked

Implemented in SCR_CampaignBuildingTransformingEditorComponent.

◆ StartEditingOwner()

void SCR_TransformingEditorComponent.StartEditingOwner ( )

protected

Implemented in SCR_CampaignBuildingTransformingEditorComponent.

◆ StartEditingServer()

void SCR_TransformingEditorComponent.StartEditingServer	(	int	pivotId,
		array< int >	entityIds,
		vector	dummyVector,
		vector	transform[4],
		bool	isUnderwater,
		EEditorTransformVertical	verticalMode
	)

protected

Implemented in SCR_CampaignBuildingTransformingEditorComponent.

Member Data Documentation

◆ Event_OnTransformationCancel

ref ScriptInvoker SCR_TransformingEditorComponent.Event_OnTransformationCancel = new ScriptInvoker

protected

◆ Event_OnTransformationConfirm

ref ScriptInvoker SCR_TransformingEditorComponent.Event_OnTransformationConfirm = new ScriptInvoker

protected

◆ Event_OnTransformationConfirmServer

ref ScriptInvoker SCR_TransformingEditorComponent.Event_OnTransformationConfirmServer = new ScriptInvoker

protected

◆ Event_OnTransformationRequest

ref ScriptInvoker SCR_TransformingEditorComponent.Event_OnTransformationRequest = new ScriptInvoker

protected

◆ Event_OnTransformationStart

ref ScriptInvoker SCR_TransformingEditorComponent.Event_OnTransformationStart = new ScriptInvoker

protected

◆ m_aEditedEntities

ref set<SCR_EditableEntityComponent> SCR_TransformingEditorComponent.m_aEditedEntities

protected

◆ m_bCanBeTransformed

bool SCR_TransformingEditorComponent.m_bCanBeTransformed = true

protected

◆ m_bIsComposition

bool SCR_TransformingEditorComponent.m_bIsComposition

protected

◆ m_EditedLayer

SCR_EditableEntityComponent SCR_TransformingEditorComponent.m_EditedLayer

protected

◆ m_EditedPivot

SCR_EditableEntityComponent SCR_TransformingEditorComponent.m_EditedPivot

protected

◆ m_mServerEntityStartingPosition

ref map<SCR_EditableEntityComponent, vector> SCR_TransformingEditorComponent.m_mServerEntityStartingPosition = new map<SCR_EditableEntityComponent, vector>()

protected

◆ m_OnCleanStart

ref ScriptInvokerVoid SCR_TransformingEditorComponent.m_OnCleanStart = new ScriptInvokerVoid()

protected

◆ m_PreviewManager

SCR_PreviewEntityEditorComponent SCR_TransformingEditorComponent.m_PreviewManager

protected

◆ m_RefEntity

SCR_RefPreviewEntity SCR_TransformingEditorComponent.m_RefEntity

protected

◆ m_StatesManager

SCR_StatesEditorComponent SCR_TransformingEditorComponent.m_StatesManager

protected

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

Game/Editor/Components/Editor/SCR_TransformingEditorComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CanBeTransformed()

◆ CancelEditing()

◆ CancelEditingServer()

◆ Clean()

◆ ConfirmEditing()

◆ ConfirmEditingOwner()

◆ ConfirmEditingServer()

◆ EOnEditorActivate()

◆ EOnEditorDeactivate()

◆ EOnFrame()

◆ GetOnCleanStart()

◆ GetOnTransformationCancel()

◆ GetOnTransformationConfirm()

◆ GetOnTransformationConfirmServer()

◆ GetOnTransformationRequest()

◆ GetOnTransformationStart()

◆ IsEditing() [1/2]

◆ IsEditing() [2/2]

◆ OnEntityAccessKeyChanged()

◆ OnEntityUnregistered()

◆ OnEntityVisibilityChanged()

◆ SetCanBeTransformed()

◆ StartEditing()

◆ StartEditingOwner()

◆ StartEditingServer()

Member Data Documentation

◆ Event_OnTransformationCancel

◆ Event_OnTransformationConfirm

◆ Event_OnTransformationConfirmServer

◆ Event_OnTransformationRequest

◆ Event_OnTransformationStart

◆ m_aEditedEntities

◆ m_bCanBeTransformed

◆ m_bIsComposition

◆ m_EditedLayer

◆ m_EditedPivot

◆ m_mServerEntityStartingPosition

◆ m_OnCleanStart

◆ m_PreviewManager

◆ m_RefEntity

◆ m_StatesManager