Module vrRuler

[frames] | no frames]

Module vrRuler

Functions

bool

getRulerEnabled()
Returns whether the ruler is enabled.

bool

getRulerFixAxes()
Returns whether the ruler scale markings and the grid should adapt to the camera distance.

bool

getRulerGridEnabled()
Returns whether the grid is shown.

bool

getRulerManipulatorEnabled()
Returns whether the manipulator is shown.

Pnt3f

getRulerPosition()
Returns the current position of the ruler.

Vec3f

getRulerRotation()
Returns the current rotation of the ruler as Euler angles.

resetRuler()
Resets the position and rotation of the ruler.

setRulerFixAxes(state)
Sets whether the ruler scale markings and the grid should adapt to the camera distance.

setRulerPosition(x, y, z)
Sets the position of the ruler.

setRulerRotation(rotationX, rotationY, rotationZ)
Sets the rotation of the ruler with Euler rotation angles.

showRuler(state)
Shows or hides the Ruler.

showRulerGrid(state)
Shows/hides the ruler grid.

showRulerManipulator(state)
Shows/hides the ruler manipulator.

Function Details

getRulerEnabled()

Returns whether the ruler is enabled.

Returns: bool: a bool flag.

getRulerFixAxes()

Returns whether the ruler scale markings and the grid should adapt to the camera distance.

Returns: bool: a bool flag.

getRulerGridEnabled()

Returns whether the grid is shown.

Returns: bool: a bool flag.

getRulerManipulatorEnabled()

Returns whether the manipulator is shown.

Returns: bool: a bool flag.

getRulerPosition()

Returns the current position of the ruler.

Returns: Pnt3f: A point with x, y and z coordinates.

getRulerRotation()

Returns the current rotation of the ruler as Euler angles.

Returns: Vec3f: A vector with x, y and z Euler angles in degrees.

setRulerFixAxes(state)

Sets whether the ruler scale markings and the grid should adapt to the camera distance.

If 'Fix Axes' is disabled (default), ruler scale markings and the grid adapt to the distance of the camera to the ruler origin. If 'Fix Axes' is activated, the scale and grid will remain static during camera movement.

Parameters:

state (bool) - Enable/Disable.

setRulerPosition(x, y, z)

Sets the position of the ruler.

Parameters:

x (float) - The x coordinate.
y (float) - The y coordinate.
z (float) - The z coordinate.

setRulerRotation(rotationX, rotationY, rotationZ)

Sets the rotation of the ruler with Euler rotation angles.

Parameters:

rotationX (float) - Euler rotation angle x in degrees.
rotationY (float) - Euler rotation angle y in degrees.
rotationZ (float) - Euler rotation angle z in degrees.

showRuler(state)

Shows or hides the Ruler.

Parameters:

state (bool) - Show (true) / hide (false).

showRulerGrid(state)

Shows/hides the ruler grid.

Parameters:

state (bool) - Show (true) / hide (false).

showRulerManipulator(state)

Shows/hides the ruler manipulator.

Parameters:

state (bool) - Show (true) / hide (false).