imgui.extension.imguizmo

Class ImGuizmo

java.lang.Object

imgui.extension.imguizmo.ImGuizmo

public final class ImGuizmo
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static void	allowAxisFlip(boolean value) Allow axis to flip.
static void	beginFrame() Call BeginFrame right after ImGui_XXXX_NewFrame();
static void	decomposeMatrixToComponents(float[] matrix, float[] translation, float[] rotation, float[] scale) Helper function for manually editing Translation/Rotation/Scale with an input float.
static void	drawCubes(float[] view, float[] projection, float[]... matrices) Drawing an arbitrary cube in the world.
static void	drawCubes(float[] view, float[] projection, float[] matrices) Drawing an arbitrary cube in the world.
static void	drawCubes(float[] view, float[] projection, float[] matrices, int matrixCount) Drawing an arbitrary cube in the world.
static void	drawGrid(float[] view, float[] projection, float[] matrix, float gridSize) Drawing a grid to the world (should only be used for debugging purposes).
static void	enable(boolean enable) Enable/disable the gizmo.
static boolean	isOver() Return true if mouse cursor is over any gizmo control (axis, plan or screen component)
static boolean	isOver(int operation) Return true if the cursor is over the operation's gizmo
static boolean	isUsing() Return true if mouse IsOver or if the gizmo is in moving state
static void	manipulate(float[] view, float[] projection, int operation, int mode, float[] matrix) Manipulating the given model matrix with delta matrix
static void	manipulate(float[] view, float[] projection, int operation, int mode, float[] matrix, float[] deltaMatrix) Manipulating the given model matrix with delta matrix
static void	manipulate(float[] view, float[] projection, int operation, int mode, float[] matrix, float[] deltaMatrix, float[] snap) Manipulating the given model matrix with delta matrix
static void	manipulate(float[] view, float[] projection, int operation, int mode, float[] matrix, float[] deltaMatrix, float[] snap, float[] localBounds) Manipulating the given model matrix with delta matrix
static void	manipulate(float[] view, float[] projection, int operation, int mode, float[] matrix, float[] deltaMatrix, float[] snap, float[] localBounds, float[] boundsSnap) Manipulating the given model matrix with delta matrix
static void	recomposeMatrixFromComponents(float[] translation, float[] rotation, float[] scale, float[] matrix) Helper function for manually editing Translation/Rotation/Scale with an input float.
static void	setDrawList() Call inside your own window and before Manipulate() in order to draw gizmo to that window.
static void	setDrawList(ImDrawList drawList) Call inside your own window and before Manipulate() in order to draw gizmo to that window.
static void	setGizmoSizeClipSpace(float value)
static void	setID(int id) This will update the current id
static void	setImGuiContext(ImGuiContext ctx) This is necessary because when imguizmo is compiled into a dll, and imgui into another Globals are not shared between them.
static void	setOrthographic(boolean isOrthographic) Making sure if we're set to ortho or not.
static void	setRect(float x, float y, float width, float height) This will set the rect position.
static void	viewManipulate(float[] view, float length, float positionX, float positionY, float sizeX, float sizeY, int backgroundColor) Manipulating the view
static void	viewManipulate(float[] view, float length, ImVec2 position, ImVec2 size, int backgroundColor) Manipulating the view

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setDrawList

public static void setDrawList()

Call inside your own window and before Manipulate() in order to draw gizmo to that window. Or pass a specific ImDrawList to draw to (e.g. ImGui::GetForegroundDrawList()).

setDrawList

public static void setDrawList(ImDrawList drawList)

Call inside your own window and before Manipulate() in order to draw gizmo to that window. Or pass a specific ImDrawList to draw to (e.g. ImGui::GetForegroundDrawList()).

beginFrame

public static void beginFrame()

Call BeginFrame right after ImGui_XXXX_NewFrame();

setImGuiContext

public static void setImGuiContext(ImGuiContext ctx)

This is necessary because when imguizmo is compiled into a dll, and imgui into another Globals are not shared between them. More details at https://stackoverflow.com/questions/19373061/what-happens-to-global-and-static-variables-in-a-shared-library-when-it-is-dynam Expose method to set imgui context

isOver

public static boolean isOver()

Return true if mouse cursor is over any gizmo control (axis, plan or screen component)

isUsing

public static boolean isUsing()

Return true if mouse IsOver or if the gizmo is in moving state

enable

public static void enable(boolean enable)

Enable/disable the gizmo. Stay in the state until next call to Enable. Gizmo is rendered with gray half transparent color when disabled

decomposeMatrixToComponents

public static void decomposeMatrixToComponents(float[] matrix,
                                               float[] translation,
                                               float[] rotation,
                                               float[] scale)

Helper function for manually editing Translation/Rotation/Scale with an input float. Translation, Rotation and Scale float points to 3 floats each. Angles are in degrees (more suitable for human editing).

Parameters:

matrix - the model matrix

translation - the model translation

rotation - the model rotation

scale - the model scale

See Also:

Reference Page

recomposeMatrixFromComponents

public static void recomposeMatrixFromComponents(float[] translation,
                                                 float[] rotation,
                                                 float[] scale,
                                                 float[] matrix)

Helper function for manually editing Translation/Rotation/Scale with an input float. Translation, Rotation and Scale float points to 3 floats each. Angles are in degrees (more suitable for human editing).

Parameters:

translation - the model translation

rotation - the model rotation

scale - the model scale

matrix - the model matrix

See Also:

Reference Page

setRect

public static void setRect(float x,
                           float y,
                           float width,
                           float height)

This will set the rect position.

Parameters:

x - x coordinate of the rectangle

y - y coordinate of the rectangle

width - width of the rectangle

height - height of the rectangle

setOrthographic

public static void setOrthographic(boolean isOrthographic)

Making sure if we're set to ortho or not.

drawCubes

public static void drawCubes(float[] view,
                             float[] projection,
                             float[] matrices)

Drawing an arbitrary cube in the world.

Parameters:

view - target camera view

projection - target camera projection

matrices - cube matrices (max. 4 cubes allowed)

drawCubes

public static void drawCubes(float[] view,
                             float[] projection,
                             float[] matrices,
                             int matrixCount)

Drawing an arbitrary cube in the world.

Parameters:

view - target camera view

projection - target camera projection

matrices - cube matrices (max. 4 cubes allowed)

matrixCount - number of matrices

drawCubes

public static void drawCubes(float[] view,
                             float[] projection,
                             float[]... matrices)

Drawing an arbitrary cube in the world.

Parameters:

view - target camera view

projection - target camera projection

matrices - cube matrices (max. 4 cubes allowed)

drawGrid

public static void drawGrid(float[] view,
                            float[] projection,
                            float[] matrix,
                            float gridSize)

Drawing a grid to the world (should only be used for debugging purposes).

Parameters:

view - target camera view

projection - target camera projection

matrix - grid matrix

gridSize - grid size

manipulate

public static void manipulate(float[] view,
                              float[] projection,
                              int operation,
                              int mode,
                              float[] matrix)

Manipulating the given model matrix with delta matrix

Parameters:

view - target camera view

projection - target camera projection

operation - target operation

mode - target mode

matrix - model matrix

manipulate

public static void manipulate(float[] view,
                              float[] projection,
                              int operation,
                              int mode,
                              float[] matrix,
                              float[] deltaMatrix)

Manipulating the given model matrix with delta matrix

Parameters:

view - target camera view

projection - target camera projection

operation - target operation

mode - target mode

matrix - model matrix

deltaMatrix - delta matrix

manipulate

public static void manipulate(float[] view,
                              float[] projection,
                              int operation,
                              int mode,
                              float[] matrix,
                              float[] deltaMatrix,
                              float[] snap)

Manipulating the given model matrix with delta matrix

Parameters:

view - target camera view

projection - target camera projection

operation - target operation

mode - target mode

matrix - model matrix

deltaMatrix - delta matrix

snap - snap value

manipulate

public static void manipulate(float[] view,
                              float[] projection,
                              int operation,
                              int mode,
                              float[] matrix,
                              float[] deltaMatrix,
                              float[] snap,
                              float[] localBounds)

Manipulating the given model matrix with delta matrix

Parameters:

view - target camera view

projection - target camera projection

operation - target operation

mode - target mode

matrix - model matrix

deltaMatrix - delta matrix

snap - snap value

localBounds - bounds value

manipulate

public static void manipulate(float[] view,
                              float[] projection,
                              int operation,
                              int mode,
                              float[] matrix,
                              float[] deltaMatrix,
                              float[] snap,
                              float[] localBounds,
                              float[] boundsSnap)

Manipulating the given model matrix with delta matrix

Parameters:

view - target camera view

projection - target camera projection

operation - target operation

mode - target mode

matrix - model matrix

deltaMatrix - delta matrix

snap - snap value

localBounds - bounds value

boundsSnap - bounds snap value

viewManipulate

public static void viewManipulate(float[] view,
                                  float length,
                                  ImVec2 position,
                                  ImVec2 size,
                                  int backgroundColor)

Manipulating the view

Parameters:

view - target camera view

length - camera distance/length

viewManipulate

public static void viewManipulate(float[] view,
                                  float length,
                                  float positionX,
                                  float positionY,
                                  float sizeX,
                                  float sizeY,
                                  int backgroundColor)

Manipulating the view

Parameters:

view - target camera view

length - camera distance/length

setID

public static void setID(int id)

This will update the current id

isOver

public static boolean isOver(int operation)

Return true if the cursor is over the operation's gizmo

setGizmoSizeClipSpace

public static void setGizmoSizeClipSpace(float value)

allowAxisFlip

public static void allowAxisFlip(boolean value)

Allow axis to flip. When true (default), the guizmo axis flip for better visibility. When false, they always stay along the positive world/local axis.