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	beginFrame() Starts the next frame for the Gizmo.
static void	decomposeMatrixToComponents(float[] modelMatrix, 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[]... cubeMatrices) Drawing an arbitrary cube in the world.
static void	drawGrid(float[] view, float[] projection, float[] matrix, int gridSize) Drawing a grid to the world (should only be used for debugging purposes).
static boolean	isOver() Checks to see if we're over the Gizmo.
static boolean	isOver(int operation) Checks if we're over the current operation.
static boolean	isUsing() Checks to see if we're using the Gizmo.
static void	manipulate(float[] view, float[] projection, float[] modelMatrix, float[] deltaMatrix, int operation, int mode, float[] snap, float[] bounds, float[] boundsSnap) Manipulating the given model matrix with delta matrix
static void	manipulate(float[] view, float[] projection, float[] modelMatrix, int operation, int mode) Manipulating the given model matrix.
static void	manipulate(float[] view, float[] projection, float[] modelMatrix, int operation, int mode, float[] snap) Manipulating the given model matrix with snap feature enabled!
static void	manipulate(float[] view, float[] projection, float[] modelMatrix, int operation, int mode, float[] snap, float[] bounds) Manipulating the given model matrix with snap and bounds feature enabled!
static void	manipulate(float[] view, float[] projection, float[] modelMatrix, int operation, int mode, float[] snap, float[] bounds, float[] boundsSnap) Manipulating the given model matrix with snap and bounds(snap) feature enabled!
static void	nSetRect(float x, float y, float width, float height)
static void	recomposeMatrixFromComponents(float[] modelMatrix, float[] translation, float[] rotation, float[] scale) Helper function for manually editing Translation/Rotation/Scale with an input float.
static void	setAllowAxisFlip(boolean value) This will update the current axis flip value
static void	setDrawList() Setting the default window drawlist.
static void	setDrawList(ImDrawList drawList) Setting the draw list of the given Gizmo.
static void	setEnabled(boolean isEnabled) Enable/Disable the gizmo.
static void	setId(int id) This will update the current id
static void	setOrthographic(boolean ortho) 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[] position, float[] size, int color) Manipulating the view

Methods inherited from class java.lang.Object

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

Method Detail

setEnabled

public static void setEnabled(boolean isEnabled)

Enable/Disable the gizmo.

isUsing

public static boolean isUsing()

Checks to see if we're using the Gizmo.

isOver

public static boolean isOver()

Checks to see if we're over the Gizmo.

setDrawList

public static void setDrawList(ImDrawList drawList)

Setting the draw list of the given Gizmo.

Parameters:

drawList - the target drawlist

setDrawList

public static void setDrawList()

Setting the default window drawlist.

beginFrame

public static void beginFrame()

Starts the next frame for the Gizmo. Call this after you've called ImGui.beginFrame().

decomposeMatrixToComponents

public static void decomposeMatrixToComponents(float[] modelMatrix,
                                               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:

modelMatrix - 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[] modelMatrix,
                                                 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:

modelMatrix - the model matrix

translation - the model translation

rotation - the model rotation

scale - the model scale

See Also:

Reference Page

nSetRect

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

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 ortho)

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

drawCubes

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

Drawing an arbitrary cube in the world.

Parameters:

view - target camera view

projection - target camera projection

cubeMatrices - cube matrices (max. 4 cubes allowed)

drawGrid

public static void drawGrid(float[] view,
                            float[] projection,
                            float[] matrix,
                            int 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,
                              float[] modelMatrix,
                              int operation,
                              int mode)

Manipulating the given model matrix.

Parameters:

view - target camera view

projection - target camera projection

modelMatrix - model matrix

operation - target operation

mode - target mode

manipulate

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

Manipulating the given model matrix with snap feature enabled!

Parameters:

view - target camera view

projection - target camera projection

modelMatrix - model matrix

operation - target operation

mode - target mode

snap - snap value

manipulate

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

Manipulating the given model matrix with snap and bounds feature enabled!

Parameters:

view - target camera view

projection - target camera projection

modelMatrix - model matrix

operation - target operation

mode - target mode

snap - snap value

bounds - bounds value

manipulate

public static void manipulate(float[] view,
                              float[] projection,
                              float[] modelMatrix,
                              int operation,
                              int mode,
                              float[] snap,
                              float[] bounds,
                              float[] boundsSnap)

Manipulating the given model matrix with snap and bounds(snap) feature enabled!

Parameters:

view - target camera view

projection - target camera projection

modelMatrix - model matrix

operation - target operation

mode - target mode

snap - snap value

bounds - bounds value

boundsSnap - bounds snap value

manipulate

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

Manipulating the given model matrix with delta matrix

Parameters:

view - target camera view

projection - target camera projection

modelMatrix - model matrix

deltaMatrix - delta matrix

operation - target operation

mode - target mode

snap - snap value

bounds - bounds value

boundsSnap - bounds snap value

viewManipulate

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

Manipulating the view

Parameters:

view - target camera view

length - camera distance/length

position - position

size - size

color - color

setId

public static void setId(int id)

This will update the current id

isOver

public static boolean isOver(int operation)

Checks if we're over the current operation. One of Operation.

Parameters:

operation - target

setAllowAxisFlip

public static void setAllowAxisFlip(boolean value)

This will update the current axis flip value