Unigine.WidgetManipulator Class

Inherits from:

This base class creates a draggable 3D manipulator.

Properties:

Name	Description
mat4 Modelview	The current projection matrix of the handler.
mat4 Projection	The current model-view matrix of the handler.
mat4 Transform	The current transformation matrix of the handler.
mat4 Basis	The current basis of the coordinate system for the handler.
vec4 Color	The current color for a manipulator.
int Size	The current handle size of the manipulator.
float Step	A step, which is used to align objects.
int Mask	A mask that hides axis arrows (along X, Y or Z) of the handler.
Gui RenderGui	The current render gui.
bool IsFocusAxis	A value indicating if any axis of the manipulator is currently in focus.
int FocusedAxis	The number of the manipulator axis, that is currently in focus.

Methods:

Name	Description View: Sort by:
WidgetManipulator	WidgetManipulator constructor.

Variables:

Name	Description
MASK_X = 1 << 0	Bit mask for a X axis of the manipulator.
MASK_XYZ = (MASK_X \| MASK_Y \| MASK_Z)	3-bit mask for axes of the manipulator.
MASK_Y = 1 << 1	Bit mask for a Y axis of the manipulator.
MASK_Z = 1 << 2	Bit mask for a Z axis of the manipulator.

WidgetManipulator Class

Properties

mat4 Modelview#

The current projection matrix of the handler.

set

Sets a model-view matrix for the handler.

set value - Model-view matrix.

mat4 Projection#

The current model-view matrix of the handler.

set

Sets a projection matrix for the handler.

set value - Projection matrix.

mat4 Transform#

The current transformation matrix of the handler.

set

Sets a transformation matrix for the handler.

set value - Transformation matrix.

mat4 Basis#

The current basis of the coordinate system for the handler. it can either be the world coordinates (the identity matrix) or coordinates of the parent node if the manipulated node is a child.

set

Sets a basis of the coordinate system for the handler. It can either be the world coordinates (the identity matrix) or coordinates of the parent node if the manipulated node is a child.

set value - Matrix, with columns specifying basis vectors.

vec4 Color#

The current color for a manipulator.

set

Sets the color for a manipulator.

set value - Manipulator color. The provided value is clamped to a range [0;1].

int Size#

The current handle size of the manipulator. depending on the handle shape, this can be a radius or an altitude.

set

Sets a handle size of the manipulator. Depending on the handle shape, this can be a radius or an altitude.

set value - Size in pixels.

float Step#

A step, which is used to align objects.

set

Sets a step, which is used to align objects.

set value - Step in units.

int Mask#

A mask that hides axis arrows (along X, Y or Z) of the handler.

set

Hides axis arrows (along X, Y or Z) of the handler.

set value - 3-bit mask for axes.

Gui RenderGui#

The current render gui.

set

Sets the render GUI.

set value - GUI smart pointer.

bool IsFocusAxis#

A value indicating if any axis of the manipulator is currently in focus.

int FocusedAxis#

The number of the manipulator axis, that is currently in focus.

Members

WidgetManipulator ( Gui gui ) #

WidgetManipulator constructor. Creates a manipulator widget and adds it to the specified GUI.

Arguments

Gui gui - GUI instance.

WidgetManipulator ( ) #

WidgetManipulator constructor. Creates a manipulator widget and adds it to the Engine GUI.

Last update: 2021-04-29

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)