Gizmo API

editor.setAxisGizmoTransform(matrix, scale)
Parameters:
  • matrix (MatrixF) – the world transform matrix of the gizmo
  • scale (Point3F) – of the gizmo, so to avoid non uniform scale decomposition problems

Set the axis gizmo’s transform, used for custom editing of object parts or other visual handles.

editor.getAxisGizmoTransform()

Return the axis gizmo current matrix transform as a MatrixF object

editor.getAxisGizmoScale()

Return the axis gizmo current scale as a Point3F object

editor.updateAxisGizmo(onStartGizmoDragFunc, onEndGizmoDragFunc, onGizmoDraggingFunc)
Parameters:
  • onStartGizmoDragFunc – this function is called when the gizmo axes/handles are starting to being dragged (no args)
  • onEndGizmoDragFunc – this function is called when the gizmo axes/handles ended being dragged (no args)
  • onGizmoDraggingFunc – this function is called when the gizmo axes/handles are currently being dragged (no args)

Updates the axis gizmo internals, checking mouse manipulation events and so on.

editor.drawAxisGizmo()

Draw the axis gizmo with its current transform and mode.

editor.setAxisGizmoMode(mode)
Parameters:mode

the mode of the axis gizmo to be set:

  • editor.AxisGizmoMode_Translate
  • editor.AxisGizmoMode_Rotate
  • editor.AxisGizmoMode_Scale

Set the current axis gizmo mode. Usually called when the edit mode is activated.

editor.setAxisGizmoAlignment(alignment)
Parameters:alignment

the alignment of the axis gizmo to be set:

  • editor.AxisGizmoAlignment_World - the gizmo is aligned with the world axes
  • editor.AxisGizmoAlignment_Local - the gizmo is aligned with the local axes of the gizmo transform

Set the current axis gizmo alignment. Usually called when the edit mode is activated.

editor.getAxisGizmoMode()

Return the axis gizmo mode. See editor.setAxisGizmoMode.

editor.getAxisGizmoAlignment()

Return the axis gizmo alignment. See editor.setAxisGizmoAlignment.

editor.isAxisGizmoHovered()

Return true if the axis gizmo has any hovered elements (axes).

editor.getAxisGizmoSelectedElement()

Return the axis gizmo selected element (axis).

worldEditorCppApi.setAxisGizmoRenderPlane(renderEnable) [TEMPORARY]
Parameters:renderEnable – if true, render the selected plane
worldEditorCppApi.setAxisGizmoRenderPlaneHashes(renderEnable) [TEMPORARY]
Parameters:renderEnable – if true, render the selected plane hashes
worldEditorCppApi.setAxisGizmoRenderMoveGrid(renderEnable) [TEMPORARY]
Parameters:renderEnable – if true, render the selected move grid when translating
worldEditorCppApi.getAxisGizmoRenderPlane() [TEMPORARY]

Return true if render plane is enabled.

worldEditorCppApi.getAxisGizmoRenderPlaneHashes() [TEMPORARY]

Return true if render plane hashes is enabled.

worldEditorCppApi.getAxisGizmoRenderMoveGrid() [TEMPORARY]

Return true if render move plane is enabled.