Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_PreviewEntityEditorUIComponent Interface Reference
Editor » UI | Editor » UI » UI Components
Inheritance diagram for SCR_PreviewEntityEditorUIComponent:
[legend]

Public Member Functions

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,.
 
void HandlerAttachedScripted (Widget w)
 Event called when subcomponent is initialized.
 
override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 

Protected Member Functions

void OnHoverChange (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)
 
void OnPreviewCreate ()
 
void OnPreviewDelete ()
 
void OnEditorTransformSnapToSurface ()
 
void OnEditorTransformRotationModifierDown (float value, EActionTrigger reason)
 
void OnEditorTransformRotationModifierUp (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])
 
SCR_EPreviewState GetPreviewStateToShow ()
 
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? If so, it will be registered in the list of components and can be searched for.
 

Protected Attributes

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
 

Static Protected Attributes

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
 

Member Function Documentation

◆ ActivatePreviewContext()

void SCR_PreviewEntityEditorUIComponent.ActivatePreviewContext ( )
protected

◆ GetCursorPos()

void SCR_PreviewEntityEditorUIComponent.GetCursorPos ( out vector  cameraPos,
out vector  cursorDir 
)
protected

◆ GetPreviewPosAboveGeometry()

bool SCR_PreviewEntityEditorUIComponent.GetPreviewPosAboveGeometry ( vector  cameraPos,
vector  cursorDir,
out vector  worldPos,
out EEditorTransformVertical  verticalMode 
)
protected

◆ GetPreviewPosAboveSea()

bool SCR_PreviewEntityEditorUIComponent.GetPreviewPosAboveSea ( vector  cameraPos,
vector  cursorDir,
out vector  worldPos,
out EEditorTransformVertical  verticalMode 
)
protected

◆ GetPreviewPosAboveTerrain()

bool SCR_PreviewEntityEditorUIComponent.GetPreviewPosAboveTerrain ( vector  cameraPos,
vector  cursorDir,
out vector  worldPos,
out EEditorTransformVertical  verticalMode 
)
protected

◆ GetPreviewStateToShow()

SCR_EPreviewState SCR_PreviewEntityEditorUIComponent.GetPreviewStateToShow ( )
protected
Returns
SCR_EPreviewState of the preview according to which the preview color is set. To be overridden by inherited classes.

Implemented in SCR_PlacingEditorUIComponent, and SCR_TransformingEditorUIComponent.

◆ GetTraceDis()

float SCR_PreviewEntityEditorUIComponent.GetTraceDis ( vector  pos,
vector  dir,
float  cameraHeight 
)
protected

◆ HandlerAttachedScripted()

override void SCR_PreviewEntityEditorUIComponent.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 MenuRootSubComponent.

Implemented in SCR_PlacingEditorUIComponent, and SCR_TransformingEditorUIComponent.

◆ HandlerDeattached()

override void SCR_PreviewEntityEditorUIComponent.HandlerDeattached ( Widget  w)

Implements MenuRootSubComponent.

Implemented in SCR_PlacingEditorUIComponent, and SCR_TransformingEditorUIComponent.

◆ HasMouseMoved()

bool SCR_PreviewEntityEditorUIComponent.HasMouseMoved ( )
protected

◆ MoveHorizontalTowardsCursor()

void SCR_PreviewEntityEditorUIComponent.MoveHorizontalTowardsCursor ( float  tDelta,
out vector  transform[4],
out bool  canTransform,
out EEditorTransformVertical  verticalMode 
)
protected

◆ MoveVertical()

bool SCR_PreviewEntityEditorUIComponent.MoveVertical ( float  tDelta,
out vector  transform[4],
float  moveVertical,
EEditorTransformVertical  verticalMode 
)
protected

◆ MoveVerticalTowardsCursor()

void SCR_PreviewEntityEditorUIComponent.MoveVerticalTowardsCursor ( float  tDelta,
out vector  transform[4] 
)
protected

◆ OnEditorTransformMoveVerticalModifierDown()

void SCR_PreviewEntityEditorUIComponent.OnEditorTransformMoveVerticalModifierDown ( float  value,
EActionTrigger  reason 
)
protected

◆ OnEditorTransformMoveVerticalModifierUp()

void SCR_PreviewEntityEditorUIComponent.OnEditorTransformMoveVerticalModifierUp ( float  value,
EActionTrigger  reason 
)
protected

◆ OnEditorTransformRotationModifierDown()

void SCR_PreviewEntityEditorUIComponent.OnEditorTransformRotationModifierDown ( float  value,
EActionTrigger  reason 
)
protected

◆ OnEditorTransformRotationModifierUp()

void SCR_PreviewEntityEditorUIComponent.OnEditorTransformRotationModifierUp ( float  value,
EActionTrigger  reason 
)
protected

Implemented in SCR_PlacingEditorUIComponent, and SCR_TransformingEditorUIComponent.

◆ OnEditorTransformSnapToSurface()

void SCR_PreviewEntityEditorUIComponent.OnEditorTransformSnapToSurface ( )
protected

◆ OnHoverChange()

void SCR_PreviewEntityEditorUIComponent.OnHoverChange ( EEditableEntityState  state,
set< SCR_EditableEntityComponent >  entitiesInsert,
set< SCR_EditableEntityComponent >  entitiesRemove 
)
protected

Implemented in SCR_PlacingEditorUIComponent, and SCR_TransformingEditorUIComponent.

◆ OnPreviewCreate()

void SCR_PreviewEntityEditorUIComponent.OnPreviewCreate ( )
protected

◆ OnPreviewDelete()

void SCR_PreviewEntityEditorUIComponent.OnPreviewDelete ( )
protected

◆ ProcessInput()

void SCR_PreviewEntityEditorUIComponent.ProcessInput ( float  tDelta)
protected

◆ Rotate()

void SCR_PreviewEntityEditorUIComponent.Rotate ( float  tDelta,
out vector  transform[4],
float  rotationValue 
)
protected

◆ RotateInSlot()

bool SCR_PreviewEntityEditorUIComponent.RotateInSlot ( SCR_EditableEntityComponent  slot,
float  rotationValue,
out vector  angles,
out bool  freeRotation 
)
protected

◆ RotateTowardsCursor()

void SCR_PreviewEntityEditorUIComponent.RotateTowardsCursor ( float  tDelta,
out vector  transform[4] 
)
protected

◆ SetClickPos()

void SCR_PreviewEntityEditorUIComponent.SetClickPos ( vector  clickPos)
protected

◆ SetRotationPivot()

void SCR_PreviewEntityEditorUIComponent.SetRotationPivot ( )
protected

◆ UpdateDirIndicator()

void SCR_PreviewEntityEditorUIComponent.UpdateDirIndicator ( vector  previewTransform[4])
protected

Member Data Documentation

◆ m_bIsAnimated

bool SCR_PreviewEntityEditorUIComponent.m_bIsAnimated
protected

◆ m_bIsRotatingTowardsCursor

bool SCR_PreviewEntityEditorUIComponent.m_bIsRotatingTowardsCursor
protected

◆ m_bMouseMoved

bool SCR_PreviewEntityEditorUIComponent.m_bMouseMoved
protected

◆ m_CameraManagerBase

SCR_CameraEditorComponent SCR_PreviewEntityEditorUIComponent.m_CameraManagerBase
protected

◆ m_CursorComponentBase

SCR_CursorEditorUIComponent SCR_PreviewEntityEditorUIComponent.m_CursorComponentBase
protected

◆ m_DirIndicator

IEntity SCR_PreviewEntityEditorUIComponent.m_DirIndicator
protected

◆ m_DirIndicatorPrefab

ResourceName SCR_PreviewEntityEditorUIComponent.m_DirIndicatorPrefab
protected

◆ m_fDirIndicatorScale

float SCR_PreviewEntityEditorUIComponent.m_fDirIndicatorScale
protected

◆ m_fMinAngleCeiling

float SCR_PreviewEntityEditorUIComponent.m_fMinAngleCeiling
protected

◆ m_fMinAngleWall

float SCR_PreviewEntityEditorUIComponent.m_fMinAngleWall
protected

◆ m_fMinCameraVerticalOffset

float SCR_PreviewEntityEditorUIComponent.m_fMinCameraVerticalOffset
protected

◆ m_fMoveVerticalCoef

float SCR_PreviewEntityEditorUIComponent.m_fMoveVerticalCoef
protected

◆ m_fRotationCoef

float SCR_PreviewEntityEditorUIComponent.m_fRotationCoef
protected

◆ m_fRotationInertia

float SCR_PreviewEntityEditorUIComponent.m_fRotationInertia
protected

◆ m_fTargetYaw

float SCR_PreviewEntityEditorUIComponent.m_fTargetYaw
protected

◆ m_fUnsnapDuration

float SCR_PreviewEntityEditorUIComponent.m_fUnsnapDuration
protected

◆ m_fUnsnapProgress

float SCR_PreviewEntityEditorUIComponent.m_fUnsnapProgress
protected

◆ m_HoverFilter

SCR_HoverEditableEntityFilter SCR_PreviewEntityEditorUIComponent.m_HoverFilter
protected

◆ m_InputManagerBase

InputManager SCR_PreviewEntityEditorUIComponent.m_InputManagerBase
protected

◆ m_Operation

EPreviewEntityEditorOperation SCR_PreviewEntityEditorUIComponent.m_Operation
protected

◆ m_PlacingManager

SCR_PlacingEditorComponent SCR_PreviewEntityEditorUIComponent.m_PlacingManager
protected

◆ m_PreviewEntityManager

SCR_PreviewEntityEditorComponent SCR_PreviewEntityEditorUIComponent.m_PreviewEntityManager
protected

◆ m_RotationTrace

ref TraceParam SCR_PreviewEntityEditorUIComponent.m_RotationTrace
protected

◆ m_Target

SCR_EditableEntityComponent SCR_PreviewEntityEditorUIComponent.m_Target
protected

◆ m_vAnglesOrigin

vector SCR_PreviewEntityEditorUIComponent.m_vAnglesOrigin
protected

◆ m_vAnimatedTransform

vector SCR_PreviewEntityEditorUIComponent.m_vAnimatedTransform[4]
protected

◆ m_vClickPosBase

vector SCR_PreviewEntityEditorUIComponent.m_vClickPosBase
protected

◆ m_vClickPosWorldBase

vector SCR_PreviewEntityEditorUIComponent.m_vClickPosWorldBase
protected

◆ m_vClickTransformBase

vector SCR_PreviewEntityEditorUIComponent.m_vClickTransformBase[4]
protected

◆ m_vRotationPivot

vector SCR_PreviewEntityEditorUIComponent.m_vRotationPivot
protected

◆ m_vTerrainNormal

vector SCR_PreviewEntityEditorUIComponent.m_vTerrainNormal
protected

◆ m_vTransformOrigin

vector SCR_PreviewEntityEditorUIComponent.m_vTransformOrigin[4]
protected

◆ m_World

BaseWorld SCR_PreviewEntityEditorUIComponent.m_World
protected

◆ MIN_CURSOR_DIS_TO_TRANSFORM

const int SCR_PreviewEntityEditorUIComponent.MIN_CURSOR_DIS_TO_TRANSFORM = 10
staticprotected

◆ TRACE_DIS

const float SCR_PreviewEntityEditorUIComponent.TRACE_DIS = 2000
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6