SCR_PreviewEntityEditorComponent Class Reference

Inheritance diagram for SCR_PreviewEntityEditorComponent:

Protected Member Functions
bool	GetCanAdjustVerticalPosition ()
void	SetPreviewTransform (vector transform[4], float timeSlice=1, bool instant=false, EEditorTransformVertical verticalMode=EEditorTransformVertical.TERRAIN)
void	ResetPreviewTransform ()
bool	GetPreviewTransform (out vector transform[4])
bool	GetPreviewTransformOrigin (out vector transform[4])
void	SetPreviewHeight (vector pos)
void	ResetPreviewHeight ()
float	GetPreviewHeightAboveTerrain ()
float	GetPreviewHeightAboveSea ()
vector	GetLocalOffset ()
void	SetVerticalMode (EEditorTransformVertical mode)
EEditorTransformVertical	GetVerticalMode ()
EEditorTransformVertical	GetVerticalModeReal ()
void	SetVerticalSnap (bool enabled)
bool	IsVerticalSnap ()
vector	SnapVertically (vector pos)
bool	IsSnappedVertically ()
bool	CanUnsnap (float verticalDelta)
float	GetSnapBaseHeight (vector pos, EEditorTransformVertical verticalMode)
bool	CanMoveInRoot ()
void	ShowAsDisabled (bool disable=true)
void	SetPreviewState (SCR_EPreviewState state)
void	SetLastPreviewState (SCR_EPreviewState state)
bool	SetTarget (SCR_EditableEntityComponent target, bool isDelegate=false)
bool	CanInteractWith (SCR_EditableEntityComponent target, out bool snap, out EEditableEntityInteraction interaction, bool isDelegate)
SCR_EditableEntityComponent	GetTarget ()
EEditableEntityInteraction	GetTargetInteraction ()
bool	IsSnappedToTarget ()
SCR_EditablePreviewEntity	GetPreviewEntity ()
ResourceName	GetPreviewPrefab ()
string	GetActionContext ()
bool	IsEditing ()
bool	IsChange ()
bool	IsRotating ()
bool	IsFixedPosition ()
ResourceName	GetSlotPrefab ()
void	SetIsMovingVertically (bool isMovingVertically)
bool	IsMovingVertically ()
void	SetIsRotating (bool isRotating)
bool	IsUnderwater ()
array< IEntity >	GetExcludeArray ()
ScriptInvoker	GetOnPreviewCreate ()
ScriptInvoker	GetOnPreviewDelete ()
ScriptInvoker	GetOnPreviewChange ()
ScriptInvoker	GetOnTargetChange ()
ScriptInvoker	GetOnWaitingPreviewCreate ()
ScriptInvoker	GetOnVerticalModeChange ()
ScriptInvoker	GetOnVerticalSnapChange ()
void	InitTransform (vector transform[4])
SCR_BasePreviewEntity	CreatePreview (SCR_EditableEntityComponent pivot, set< SCR_EditableEntityComponent > entities)
SCR_BasePreviewEntity	CreatePreview (ResourceName prefab, notnull array< vector > offsets, vector initTransform[4]={})
void	DeletePreview ()
SCR_BasePreviewEntity	CreateWaitingPreview ()
vector	LerpTranslation (vector currentPos, vector targetPos, float timeSlice)
void	LerpAngles (vector currentAngles, out vector targetAngles, float timeSlice)
void	OnUserSettingsChanged ()
override void	EOnEditorDebug (array< string > debugTexts)
override void	EOnFrame (IEntity owner, float timeSlice)
override void	EOnEditorActivate ()
override void	EOnEditorDeactivate ()
override void	EOnEditorInit ()
override void	OnDelete (IEntity owner)

Protected Attributes
ref Color	m_HeightIndicatorColor
string	m_sActionContext
bool	m_bCanMoveInRoot
bool	m_bCanAdjustVerticalPosition
SCR_LayersEditorComponent	m_LayerManager
SCR_StatesEditorComponent	m_StateManager
SCR_EditablePreviewEntity	m_PreviewEntity
ResourceName	m_sPreviewPrefab
ref SCR_EditableEntityInteraction	m_Interaction
const float	VERTICAL_TRACE_OFFSET = 0.01

Detailed Description

Manager of 'ghost' preview shown while transforming or placing.

Definition at line 12 of file SCR_PreviewEntityEditorComponent.c.

Member Function Documentation

CanInteractWith()

bool SCR_PreviewEntityEditorComponent::CanInteractWith ( SCR_EditableEntityComponent target, out bool snap, out EEditableEntityInteraction interaction, bool isDelegate )

inlineprotected

Definition at line 572 of file SCR_PreviewEntityEditorComponent.c.

CanMoveInRoot()

bool SCR_PreviewEntityEditorComponent::CanMoveInRoot ( )

inlineprotected

Returns

True if the preview entity can be moved to root

Definition at line 457 of file SCR_PreviewEntityEditorComponent.c.

CanUnsnap()

bool SCR_PreviewEntityEditorComponent::CanUnsnap ( float verticalDelta )

inlineprotected

Checked if preview entity is snapped and can be unsnapped

Parameters

verticalDelta

Intended vertical change

Returns

True if the entity is snapped and can be unsnapped

Definition at line 425 of file SCR_PreviewEntityEditorComponent.c.

CreatePreview() [1/2]

SCR_BasePreviewEntity SCR_PreviewEntityEditorComponent::CreatePreview ( ResourceName prefab, notnull array< vector > offsets, vector initTransform[4] = {} )

inlineprotected

Create preview from prefab.

Parameters

prefab	IEntity prefab
offsets	Offsets when multiple instances of the preview entity are to be spawned
initTransform	Transformation matrix on which the preview entity will be created (optional)

Returns

Created preview entity

Definition at line 918 of file SCR_PreviewEntityEditorComponent.c.

CreatePreview() [2/2]

SCR_BasePreviewEntity SCR_PreviewEntityEditorComponent::CreatePreview ( SCR_EditableEntityComponent pivot, set< SCR_EditableEntityComponent > entities )

inlineprotected

Create preview from existing entities.

Parameters

pivot	Directly edited entity
entities	List of edited entities

Returns

Created preview entity

Definition at line 867 of file SCR_PreviewEntityEditorComponent.c.

CreateWaitingPreview()

SCR_BasePreviewEntity SCR_PreviewEntityEditorComponent::CreateWaitingPreview ( )

inlineprotected

Duplicate the preview to indicate waiting.

Definition at line 1030 of file SCR_PreviewEntityEditorComponent.c.

DeletePreview()

void SCR_PreviewEntityEditorComponent::DeletePreview ( )

inlineprotected

Delete current preview entity.

Definition at line 1002 of file SCR_PreviewEntityEditorComponent.c.

EOnEditorActivate()

override void SCR_PreviewEntityEditorComponent::EOnEditorActivate ( )

inlineprotected

Definition at line 1098 of file SCR_PreviewEntityEditorComponent.c.

EOnEditorDeactivate()

override void SCR_PreviewEntityEditorComponent::EOnEditorDeactivate ( )

inlineprotected

Definition at line 1118 of file SCR_PreviewEntityEditorComponent.c.

EOnEditorDebug()

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

inlineprotected

Definition at line 1070 of file SCR_PreviewEntityEditorComponent.c.

EOnEditorInit()

override void SCR_PreviewEntityEditorComponent::EOnEditorInit ( )

inlineprotected

Definition at line 1122 of file SCR_PreviewEntityEditorComponent.c.

EOnFrame()

override void SCR_PreviewEntityEditorComponent::EOnFrame ( IEntity owner, float timeSlice )

inlineprotected

Definition at line 1084 of file SCR_PreviewEntityEditorComponent.c.

GetActionContext()

string SCR_PreviewEntityEditorComponent::GetActionContext ( )

inlineprotected

Get action context activated every frame.

Returns

Action context name

Definition at line 706 of file SCR_PreviewEntityEditorComponent.c.

GetCanAdjustVerticalPosition()

bool SCR_PreviewEntityEditorComponent::GetCanAdjustVerticalPosition ( )

inlineprotected

Definition at line 113 of file SCR_PreviewEntityEditorComponent.c.

GetExcludeArray()

array< IEntity > SCR_PreviewEntityEditorComponent::GetExcludeArray ( )

inlineprotected

Get array of entities to be excluded when checking for GEOMETRY intersection for the preview. Filled only if the preview was created from existing entities and not from a prefab.

Returns

Array of entities

Definition at line 787 of file SCR_PreviewEntityEditorComponent.c.

GetLocalOffset()

vector SCR_PreviewEntityEditorComponent::GetLocalOffset ( )

inlineprotected

Returns

Offset of pivot on which the preview is centered (e.g., when dragging entity by its mesh, not by icon)

Definition at line 337 of file SCR_PreviewEntityEditorComponent.c.

GetOnPreviewChange()

ScriptInvoker SCR_PreviewEntityEditorComponent::GetOnPreviewChange ( )

inlineprotected

Get event called every time preview transformation is updated.

Returns

Script invoker

Definition at line 814 of file SCR_PreviewEntityEditorComponent.c.

GetOnPreviewCreate()

ScriptInvoker SCR_PreviewEntityEditorComponent::GetOnPreviewCreate ( )

inlineprotected

Get event called when a preview is created (e.g., transforming or placing starts).

Returns

Script invoker

Definition at line 798 of file SCR_PreviewEntityEditorComponent.c.

GetOnPreviewDelete()

ScriptInvoker SCR_PreviewEntityEditorComponent::GetOnPreviewDelete ( )

inlineprotected

Get event called when a preview is deleted (e.g., transforming or placing ends).

Returns

Script invoker

Definition at line 806 of file SCR_PreviewEntityEditorComponent.c.

GetOnTargetChange()

ScriptInvoker SCR_PreviewEntityEditorComponent::GetOnTargetChange ( )

inlineprotected

Get event called every time preview is snapped or unsapped from a target.

Returns

Script invoker

Definition at line 822 of file SCR_PreviewEntityEditorComponent.c.

GetOnVerticalModeChange()

ScriptInvoker SCR_PreviewEntityEditorComponent::GetOnVerticalModeChange ( )

inlineprotected

Get event called when vertical mode changes.

Returns

Script invoker

Definition at line 838 of file SCR_PreviewEntityEditorComponent.c.

GetOnVerticalSnapChange()

ScriptInvoker SCR_PreviewEntityEditorComponent::GetOnVerticalSnapChange ( )

inlineprotected

Get event called when vertical snapping changes.

Returns

Script invoker

Definition at line 846 of file SCR_PreviewEntityEditorComponent.c.

GetOnWaitingPreviewCreate()

ScriptInvoker SCR_PreviewEntityEditorComponent::GetOnWaitingPreviewCreate ( )

inlineprotected

Get event called when waiting preview is created (e.g., after placing entity on client, while waiting for server callback).

Returns

Script invoker

Definition at line 830 of file SCR_PreviewEntityEditorComponent.c.

GetPreviewEntity()

SCR_EditablePreviewEntity SCR_PreviewEntityEditorComponent::GetPreviewEntity ( )

inlineprotected

Get preview entity.

Returns

Preview entity

Definition at line 689 of file SCR_PreviewEntityEditorComponent.c.

GetPreviewHeightAboveSea()

float SCR_PreviewEntityEditorComponent::GetPreviewHeightAboveSea ( )

inlineprotected

Get preview's height above sea.

Returns

Height

Definition at line 330 of file SCR_PreviewEntityEditorComponent.c.

GetPreviewHeightAboveTerrain()

float SCR_PreviewEntityEditorComponent::GetPreviewHeightAboveTerrain ( )

inlineprotected

Get preview's height above terrain.

Returns

Height

Definition at line 322 of file SCR_PreviewEntityEditorComponent.c.

GetPreviewPrefab()

ResourceName SCR_PreviewEntityEditorComponent::GetPreviewPrefab ( )

inlineprotected

Get preview prefab.

Returns

Preview prefab

Definition at line 697 of file SCR_PreviewEntityEditorComponent.c.

GetPreviewTransform()

bool SCR_PreviewEntityEditorComponent::GetPreviewTransform ( out vector transform[4] )

inlineprotected

Get transformation of the preview entity.

Parameters

transform

Preview transformation

Definition at line 265 of file SCR_PreviewEntityEditorComponent.c.

GetPreviewTransformOrigin()

bool SCR_PreviewEntityEditorComponent::GetPreviewTransformOrigin ( out vector transform[4] )

inlineprotected

Get transformation of the preview entity from when transformation started.

Parameters

transform

Origin preview transformation

Definition at line 277 of file SCR_PreviewEntityEditorComponent.c.

GetSlotPrefab()

ResourceName SCR_PreviewEntityEditorComponent::GetSlotPrefab ( )

inlineprotected

Create slot prfab to which the preview can fit to.

Returns

Prefab resource

Definition at line 746 of file SCR_PreviewEntityEditorComponent.c.

GetSnapBaseHeight()

float SCR_PreviewEntityEditorComponent::GetSnapBaseHeight ( vector pos, EEditorTransformVertical verticalMode )

inlineprotected

Definition at line 436 of file SCR_PreviewEntityEditorComponent.c.

GetTarget()

SCR_EditableEntityComponent SCR_PreviewEntityEditorComponent::GetTarget ( )

inlineprotected

Get target to which the preview is currently snapped to.

Returns

Target editable entity

Definition at line 665 of file SCR_PreviewEntityEditorComponent.c.

GetTargetInteraction()

EEditableEntityInteraction SCR_PreviewEntityEditorComponent::GetTargetInteraction ( )

inlineprotected

Get target interaction type.

Returns

Interaction type

Definition at line 673 of file SCR_PreviewEntityEditorComponent.c.

GetVerticalMode()

EEditorTransformVertical SCR_PreviewEntityEditorComponent::GetVerticalMode ( )

inlineprotected

Get mode which defines which height the preview maintains.

Returns

Mode

Definition at line 358 of file SCR_PreviewEntityEditorComponent.c.

GetVerticalModeReal()

EEditorTransformVertical SCR_PreviewEntityEditorComponent::GetVerticalModeReal ( )

inlineprotected

Get actually used vertical mode (in certain circumstances, the mode defaults to SEA instead of using what user chose)

Returns

Mode

Definition at line 367 of file SCR_PreviewEntityEditorComponent.c.

InitTransform()

void SCR_PreviewEntityEditorComponent::InitTransform ( vector transform[4] )

inlineprotected

Definition at line 851 of file SCR_PreviewEntityEditorComponent.c.

IsChange()

bool SCR_PreviewEntityEditorComponent::IsChange ( )

inlineprotected

Check if the preview changed while editing.

Returns

True if changed

Definition at line 722 of file SCR_PreviewEntityEditorComponent.c.

IsEditing()

bool SCR_PreviewEntityEditorComponent::IsEditing ( )

inlineprotected

Check if editing is currently on.

Returns

True when editing

Definition at line 714 of file SCR_PreviewEntityEditorComponent.c.

IsFixedPosition()

bool SCR_PreviewEntityEditorComponent::IsFixedPosition ( )

inlineprotected

Is the entity fixed to specific position?

Returns

True if the position is fixed

Definition at line 738 of file SCR_PreviewEntityEditorComponent.c.

IsMovingVertically()

bool SCR_PreviewEntityEditorComponent::IsMovingVertically ( )

inlineprotected

Is the entity being moved vertically in this frame?

Returns

True if being moved vertically

Definition at line 762 of file SCR_PreviewEntityEditorComponent.c.

IsRotating()

bool SCR_PreviewEntityEditorComponent::IsRotating ( )

inlineprotected

Is the entity being rotated in this frame?

Returns

True if being rotated

Definition at line 730 of file SCR_PreviewEntityEditorComponent.c.

IsSnappedToTarget()

bool SCR_PreviewEntityEditorComponent::IsSnappedToTarget ( )

inlineprotected

Check if snapped to taregt.

Returns

True if snapped

Definition at line 681 of file SCR_PreviewEntityEditorComponent.c.

IsSnappedVertically()

bool SCR_PreviewEntityEditorComponent::IsSnappedVertically ( )

inlineprotected

Checked if preview entity is snapped according to currently active snapping rules

Returns

True when snapped

Definition at line 410 of file SCR_PreviewEntityEditorComponent.c.

IsUnderwater()

bool SCR_PreviewEntityEditorComponent::IsUnderwater ( )

inlineprotected

Is editing underwater?

Returns

True when currently editing underwater

Definition at line 778 of file SCR_PreviewEntityEditorComponent.c.

IsVerticalSnap()

bool SCR_PreviewEntityEditorComponent::IsVerticalSnap ( )

inlineprotected

Get vertical snapping rules.

Returns

Mode

Definition at line 388 of file SCR_PreviewEntityEditorComponent.c.

LerpAngles()

void SCR_PreviewEntityEditorComponent::LerpAngles ( vector currentAngles, out vector targetAngles, float timeSlice )

inlineprotected

Definition at line 1050 of file SCR_PreviewEntityEditorComponent.c.

LerpTranslation()

vector SCR_PreviewEntityEditorComponent::LerpTranslation ( vector currentPos, vector targetPos, float timeSlice )

inlineprotected

Definition at line 1046 of file SCR_PreviewEntityEditorComponent.c.

OnDelete()

override void SCR_PreviewEntityEditorComponent::OnDelete ( IEntity owner )

inlineprotected

Definition at line 1153 of file SCR_PreviewEntityEditorComponent.c.

OnUserSettingsChanged()

void SCR_PreviewEntityEditorComponent::OnUserSettingsChanged ( )

inlineprotected

Definition at line 1056 of file SCR_PreviewEntityEditorComponent.c.

ResetPreviewHeight()

void SCR_PreviewEntityEditorComponent::ResetPreviewHeight ( )

inlineprotected

Reset entity height back to 0.

Definition at line 313 of file SCR_PreviewEntityEditorComponent.c.

ResetPreviewTransform()

void SCR_PreviewEntityEditorComponent::ResetPreviewTransform ( )

inlineprotected

Reset changes of the preveiw entity and hide it.

Definition at line 244 of file SCR_PreviewEntityEditorComponent.c.

SetIsMovingVertically()

void SCR_PreviewEntityEditorComponent::SetIsMovingVertically ( bool isMovingVertically )

inlineprotected

Set if the entity is being moved vertically this frame.

Parameters

isRotating

True if being moved vertically

Definition at line 754 of file SCR_PreviewEntityEditorComponent.c.

SetIsRotating()

void SCR_PreviewEntityEditorComponent::SetIsRotating ( bool isRotating )

inlineprotected

Set if the entity is being rotated this frame.

Parameters

isRotating

True if being rotated

Definition at line 770 of file SCR_PreviewEntityEditorComponent.c.

SetLastPreviewState()

void SCR_PreviewEntityEditorComponent::SetLastPreviewState ( SCR_EPreviewState state )

inlineprotected

Set the last preview state out of this method. If it's needs restart.

Parameters

SCR_EPreviewState

state - intended state

Definition at line 518 of file SCR_PreviewEntityEditorComponent.c.

SetPreviewHeight()

void SCR_PreviewEntityEditorComponent::SetPreviewHeight ( vector pos )

inlineprotected

Set height in which the preview entity is. Height of the preview is maintained based on specific editing modes (e.g., above terrain or above sea).

Parameters

pos

Definition at line 288 of file SCR_PreviewEntityEditorComponent.c.

SetPreviewState()

void SCR_PreviewEntityEditorComponent::SetPreviewState ( SCR_EPreviewState state )

inlineprotected

Set preview material based on the requested status.

Parameters

state

- desired state.

Definition at line 483 of file SCR_PreviewEntityEditorComponent.c.

SetPreviewTransform()

void SCR_PreviewEntityEditorComponent::SetPreviewTransform ( vector transform[4], float timeSlice = 1, bool instant = false, EEditorTransformVertical verticalMode = EEditorTransformVertical.TERRAIN )

inlineprotected

Set transformation of the preview entity. When editing is confirmed, real entities are moved to where the preview is.

Parameters

transform

Preview transformation

Definition at line 123 of file SCR_PreviewEntityEditorComponent.c.

SetTarget()

bool SCR_PreviewEntityEditorComponent::SetTarget ( SCR_EditableEntityComponent target, bool isDelegate = false )

inlineprotected

Attach preview entity to a target.

Parameters

target

Target

Returns

True if the entity was attached

Definition at line 528 of file SCR_PreviewEntityEditorComponent.c.

SetVerticalMode()

void SCR_PreviewEntityEditorComponent::SetVerticalMode ( EEditorTransformVertical mode )

inlineprotected

Set mode which defines which height the preview maintains.

Parameters

Mode

Definition at line 345 of file SCR_PreviewEntityEditorComponent.c.

SetVerticalSnap()

void SCR_PreviewEntityEditorComponent::SetVerticalSnap ( bool enabled )

inlineprotected

Set vertical snapping rules.

Parameters

Mode

Definition at line 375 of file SCR_PreviewEntityEditorComponent.c.

ShowAsDisabled()

void SCR_PreviewEntityEditorComponent::ShowAsDisabled ( bool disable = true )

inlineprotected

Show preview entity as disabled.

Parameters

disable

True to show as disabled, false to show in normal state

Definition at line 465 of file SCR_PreviewEntityEditorComponent.c.

SnapVertically()

vector SCR_PreviewEntityEditorComponent::SnapVertically ( vector pos )

inlineprotected

Snap position according to currently active snapping rules

Parameters

pos	Unmodified position

Returns

Modified position

Definition at line 397 of file SCR_PreviewEntityEditorComponent.c.

Member Data Documentation

m_bCanAdjustVerticalPosition

bool SCR_PreviewEntityEditorComponent::m_bCanAdjustVerticalPosition

protected

Definition at line 83 of file SCR_PreviewEntityEditorComponent.c.

m_bCanMoveInRoot

bool SCR_PreviewEntityEditorComponent::m_bCanMoveInRoot

protected

Definition at line 82 of file SCR_PreviewEntityEditorComponent.c.

m_HeightIndicatorColor

ref Color SCR_PreviewEntityEditorComponent::m_HeightIndicatorColor

protected

Definition at line 39 of file SCR_PreviewEntityEditorComponent.c.

m_Interaction

ref SCR_EditableEntityInteraction SCR_PreviewEntityEditorComponent::m_Interaction

protected

Definition at line 93 of file SCR_PreviewEntityEditorComponent.c.

m_LayerManager

SCR_LayersEditorComponent SCR_PreviewEntityEditorComponent::m_LayerManager

protected

Definition at line 85 of file SCR_PreviewEntityEditorComponent.c.

m_PreviewEntity

SCR_EditablePreviewEntity SCR_PreviewEntityEditorComponent::m_PreviewEntity

protected

Definition at line 87 of file SCR_PreviewEntityEditorComponent.c.

m_sActionContext

string SCR_PreviewEntityEditorComponent::m_sActionContext

protected

Definition at line 57 of file SCR_PreviewEntityEditorComponent.c.

m_sPreviewPrefab

ResourceName SCR_PreviewEntityEditorComponent::m_sPreviewPrefab

protected

Definition at line 88 of file SCR_PreviewEntityEditorComponent.c.

m_StateManager

SCR_StatesEditorComponent SCR_PreviewEntityEditorComponent::m_StateManager

protected

Definition at line 86 of file SCR_PreviewEntityEditorComponent.c.

VERTICAL_TRACE_OFFSET

const float SCR_PreviewEntityEditorComponent::VERTICAL_TRACE_OFFSET = 0.01

protected

Definition at line 110 of file SCR_PreviewEntityEditorComponent.c.

---

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

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