SCR_PlacingEditorUIComponent Interface Reference

Inheritance diagram for SCR_PlacingEditorUIComponent:

Public Member Functions
override void	OnHoverChange (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)
override void	OnEditorTransformRotationModifierUp (float value, EActionTrigger reason)
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
override void	HandlerAttached (Widget w)

Protected Member Functions
void	OnEditorPlace (float value, EActionTrigger reason)
void	OnEditorPlaceAndCancel (float value, EActionTrigger reason)
void	OnEditorPlacePlayer (float value, EActionTrigger reason)
void	OnEditorPlacePlayerAndCancel (float value, EActionTrigger reason)
void	Place (bool cancelAfterwards, bool canBePlayer=false)
void	OnEditorCancelPlacingUp (float value, EActionTrigger reason)
void	CancelPlacing ()
void	EnablePlacing ()
bool	CanClick ()
bool	IsChildOf (Widget widget, Widget parent)
void	OnSelectedPrefabChange (ResourceName prefab, ResourceName prefabPrev)
void	OnMenuUpdate (float tDelta)
void	OnMenuFocusGained ()
void	OnMenuFocusLost ()
override SCR_EPreviewState	GetPreviewStateToShow ()
Protected Member Functions inherited from SCR_PreviewEntityEditorUIComponent
void	OnPreviewCreate ()
void	OnPreviewDelete ()
void	OnEditorTransformSnapToSurface ()
void	OnEditorTransformRotationModifierDown (float value, EActionTrigger reason)
void	OnEditorTransformMoveVerticalModifierDown (float value, EActionTrigger reason)
void	OnEditorTransformMoveVerticalModifierUp (float value, EActionTrigger reason)
void	SetRotationPivot ()
void	SetClickPos (vector clickPos)
bool	HasMouseMoved ()
void	GetCursorPos (out vector cameraPos, out vector cursorDir)
float	GetTraceDis (vector pos, vector dir, float cameraHeight)
void	UpdateDirIndicator (vector previewTransform[4])
void	MoveHorizontalTowardsCursor (float tDelta, out vector transform[4], out bool canTransform, out EEditorTransformVertical verticalMode)
bool	MoveVertical (float tDelta, out vector transform[4], float moveVertical, EEditorTransformVertical verticalMode)
void	MoveVerticalTowardsCursor (float tDelta, out vector transform[4])
void	Rotate (float tDelta, out vector transform[4], float rotationValue)
bool	RotateInSlot (SCR_EditableEntityComponent slot, float rotationValue, out vector angles, out bool freeRotation)
void	RotateTowardsCursor (float tDelta, out vector transform[4])
bool	GetPreviewPosAboveGeometry (vector cameraPos, vector cursorDir, out vector worldPos, out EEditorTransformVertical verticalMode)
bool	GetPreviewPosAboveTerrain (vector cameraPos, vector cursorDir, out vector worldPos, out EEditorTransformVertical verticalMode)
bool	GetPreviewPosAboveSea (vector cameraPos, vector cursorDir, out vector worldPos, out EEditorTransformVertical verticalMode)
void	ProcessInput (float tDelta)
void	ActivatePreviewContext ()
Protected Member Functions inherited from SCR_BaseEditorUIComponent
vector	OnCancelDown ()
bool	OnCancelUp ()
void	OnCancelExpired ()
Protected Member Functions inherited from MenuRootSubComponent
bool	IsUnique ()
	Is the component to exist only in one instance?

Static Protected Attributes
static const float	MAX_PREVIEW_DIS = 50
Static Protected Attributes inherited from SCR_PreviewEntityEditorUIComponent
static const int	MIN_CURSOR_DIS_TO_TRANSFORM = 10
static const float	TRACE_DIS = 2000

Additional Inherited Members
Static Public Attributes inherited from SCR_BaseEditorUIComponent
const int	CANCEL_CLICK_MAX_DIS = 5
const int	CANCEL_CLICK_MAX_TIME = 500
Protected Attributes inherited from SCR_PreviewEntityEditorUIComponent
float	m_fMoveVerticalCoef
float	m_fRotationCoef
float	m_fRotationInertia
float	m_fUnsnapDuration
float	m_fMinAngleWall
float	m_fMinAngleCeiling
float	m_fMinCameraVerticalOffset
ResourceName	m_DirIndicatorPrefab
InputManager	m_InputManagerBase
SCR_PreviewEntityEditorComponent	m_PreviewEntityManager
SCR_CameraEditorComponent	m_CameraManagerBase
SCR_PlacingEditorComponent	m_PlacingManager
SCR_CursorEditorUIComponent	m_CursorComponentBase
SCR_HoverEditableEntityFilter	m_HoverFilter
BaseWorld	m_World
vector	m_vClickTransformBase [4]
vector	m_vClickPosBase
vector	m_vClickPosWorldBase
bool	m_bMouseMoved
bool	m_bIsRotatingTowardsCursor
SCR_EditableEntityComponent	m_Target
float	m_fTargetYaw
float	m_fUnsnapProgress
vector	m_vTransformOrigin [4]
vector	m_vAnglesOrigin
vector	m_vAnimatedTransform [4]
vector	m_vRotationPivot
bool	m_bIsAnimated
vector	m_vTerrainNormal
EPreviewEntityEditorOperation	m_Operation
IEntity	m_DirIndicator
float	m_fDirIndicatorScale
ref TraceParam	m_RotationTrace
Protected Attributes inherited from SCR_BaseEditorUIComponent
vector	m_vClickPosCancel

Member Function Documentation

CancelPlacing()

void SCR_PlacingEditorUIComponent.CancelPlacing ( )

protected

CanClick()

bool SCR_PlacingEditorUIComponent.CanClick ( )

protected

EnablePlacing()

void SCR_PlacingEditorUIComponent.EnablePlacing ( )

protected

GetPreviewStateToShow()

override SCR_EPreviewState SCR_PlacingEditorUIComponent.GetPreviewStateToShow ( )

protected

Returns

SCR_EPreviewState of the preview according to which the preview color is set. To be overridden by inherited classes.

Implements SCR_PreviewEntityEditorUIComponent.

HandlerAttachedScripted()

override void SCR_PlacingEditorUIComponent.HandlerAttachedScripted

(

Widget

w

)

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implements SCR_PreviewEntityEditorUIComponent.

HandlerDeattached()

override void SCR_PlacingEditorUIComponent.HandlerDeattached

(

Widget

w

)

Implements SCR_PreviewEntityEditorUIComponent.

IsChildOf()

bool SCR_PlacingEditorUIComponent.IsChildOf ( Widget widget, Widget parent )

protected

OnEditorCancelPlacingUp()

void SCR_PlacingEditorUIComponent.OnEditorCancelPlacingUp ( float value, EActionTrigger reason )

protected

OnEditorPlace()

void SCR_PlacingEditorUIComponent.OnEditorPlace ( float value, EActionTrigger reason )

protected

OnEditorPlaceAndCancel()

void SCR_PlacingEditorUIComponent.OnEditorPlaceAndCancel ( float value, EActionTrigger reason )

protected

OnEditorPlacePlayer()

void SCR_PlacingEditorUIComponent.OnEditorPlacePlayer ( float value, EActionTrigger reason )

protected

OnEditorPlacePlayerAndCancel()

void SCR_PlacingEditorUIComponent.OnEditorPlacePlayerAndCancel ( float value, EActionTrigger reason )

protected

OnEditorTransformRotationModifierUp()

override void SCR_PlacingEditorUIComponent.OnEditorTransformRotationModifierUp	(	float	value,
		EActionTrigger	reason )

Implements SCR_PreviewEntityEditorUIComponent.

OnHoverChange()

override void SCR_PlacingEditorUIComponent.OnHoverChange	(	EEditableEntityState	state,
		set< SCR_EditableEntityComponent >	entitiesInsert,
		set< SCR_EditableEntityComponent >	entitiesRemove )

Implements SCR_PreviewEntityEditorUIComponent.

OnMenuFocusGained()

void SCR_PlacingEditorUIComponent.OnMenuFocusGained ( )

protected

OnMenuFocusLost()

void SCR_PlacingEditorUIComponent.OnMenuFocusLost ( )

protected

OnMenuUpdate()

void SCR_PlacingEditorUIComponent.OnMenuUpdate ( float tDelta )

protected

OnSelectedPrefabChange()

void SCR_PlacingEditorUIComponent.OnSelectedPrefabChange ( ResourceName prefab, ResourceName prefabPrev )

protected

Place()

void SCR_PlacingEditorUIComponent.Place ( bool cancelAfterwards, bool canBePlayer = false )

protected

Member Data Documentation

MAX_PREVIEW_DIS

const float SCR_PlacingEditorUIComponent.MAX_PREVIEW_DIS = 50

staticprotected

---

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

• Game/Editor/UI/Components/Common/SCR_PlacingEditorUIComponent.c