Unigine::Visualizer Class

Header:

#include <UnigineVisualizer.h>

Controls visualizer-related settings. The visualizer is used to render mesh wireframe, object bounding boxes, and all sorts of visual helpers (such as physical collision shapes, joints, etc.).

Usage Example#

To render a world origin, do the following:

Source code (C++)

// AppWorldLogic.cpp
#include "AppWorldLogic.h"
#include "UnigineVisualizer.h"

using namespace Unigine;
using namespace Math;

int AppWorldLogic::init() {
	/* ... */
	// enable the visualizer
	Visualizer::setEnabled(true);

	return 1;
}

int AppWorldLogic::update() {
	// render world origin
	Visualizer::renderVector(Vec3(0.0f,0.0f,0.1f), Vec3(1.0f,0.0f,0.1f), vec4(1.0f,0.0f,0.0f,1.0f));
	Visualizer::renderVector(Vec3(0.0f,0.0f,0.1f), Vec3(0.0f,1.0f,0.1f), vec4(0.0f,1.0f,0.0f,1.0f));
	Visualizer::renderVector(Vec3(0.0f,0.0f,0.1f), Vec3(0.0f,0.0f,1.1f), vec4(0.0f,0.0f,1.0f,1.0f));

	return 1;
}

To render a trace from the camera movement, use the following:

Source code (C++)

// AppWorldLogic.cpp
#include "AppWorldLogic.h"
#include "UnigineVisualizer.h"
#include "UnigineGame.h"

using namespace Unigine;
using namespace Math;

int AppWorldLogic::init() {
	/* ... */
	// enable the visualizer
	Visualizer::setEnabled(true);

	return 1;
}

int AppWorldLogic::update() {
	
	static auto last_pos = Game::getPlayer()->getWorldPosition();

	// Tracking of camera movement
	const auto current_pos = Game::getPlayer()->getWorldPosition();
	if (length2(current_pos - last_pos) >= 0.1f)
	{
		Visualizer::renderPoint3D(last_pos, 0.05f, vec4::GREEN, false, 2.0f);
		last_pos = current_pos;
	}

	return 1;
}

Methods:

Name	Description View: Sort by:
setEnabled	Enables or disables the visualizer.
isEnabled	Returns a value indicating if the visualizer is enabled.
setSize	Updates the current size of the handler.
getSize	Returns the handler size.
setTextureName	Updates the current name of the texture.
getTextureName	Returns the string with the name of the texture.
clear	Clears all internal primitives created by calls to renderSmth functions.
renderPoint2D	Renders a 2D point of a given size and color.
renderPoint3D	Renders a 3D point of a given size and color.
renderLine2D	Renders a 2D line of a given color.
renderLine3D	Renders a 3D line of a given color.
renderLine2D	Renders a 2D line of a given color by using 3 points.
renderLine3D	Renders a 3D line of a given color.
renderLine2D	Renders a 2D line of a given color.
renderLine3D	Renders a 3D line of a given color.
renderTriangle2D	Renders a 2D triangle of a given color.
renderTriangle3D	Renders a 3D triangle of a given color.
renderQuad2D	Renders a 2D quad of a given color.
renderQuad3D	Renders a 3D quad of a given color.
renderBillboard3D	Renders a 3D billboard of the specified size.
renderVector	Renders a vector of a given color.
renderDirection	Renders a direction vector of a given color.
renderBox	Renders a box of a given color.
renderFrustum	Renders a wireframe frustum of a given color.
renderCircle	Renders a wireframe circle of a given color.
renderSector	Renders a wireframe sector of a given color.
renderCone	Renders a wireframe cone of a given color.
renderSphere	Renders a wireframe sphere of a given color.
renderCapsule	Renders a wireframe capsule (capped cylinder) of a given color.
renderCylinder	Renders a wireframe cylinder of a given color.
renderEllipse	Renders a wireframe ellipse of a given color.
renderSolidBox	Renders a solid box of a given color.
renderSolidSphere	Renders a solid sphere of a given color.
renderSolidCapsule	Renders a solid capsule af a given color.
renderSolidCylinder	Renders a solid cylinder of a given color.
renderSolidEllipse	Renders a solid ellipse of a given color.
renderRectangle	Renders a 2D wireframe rectangle of a given color.
renderBoundBox	Renders the bounding box of a given color.
renderBoundSphere	Renders the bounding sphere of a given color.
renderNodeBoundBox	Renders an axis-aligned bound box of a given node.
renderNodeBoundSphere	Renders a bound sphere of a given node.
renderObjectSurfaceBoundBox	Renders a bound box of a given object surface.
renderObjectSurfaceBoundSphere	Renders a bound sphere of a given object surface.
renderNodeHandler	Renders a handler for the specified node.
renderObject	Renders an object wireframe.
renderObjectSurface	Renders borders of a given object surface.
renderSolidObject	Renders a solid-colored object.
renderSolidObjectSurface	Renders a solid-colored surface of a given object.
renderMessage2D	Renders a message in a given color.
renderMessage3D	Renders a message in a given color.
setMode	Sets a new Visualizer mode to be used.
getMode	Returns the current Visualizer mode.

Visualizer Class

Enums

MODE#

Visualizer mode. Controls the way all visual helpers are displayed.

Name	Description
MODE_DISABLED = 0	Do not display the Visualizer at all.
MODE_ENABLED_DEPTH_TEST_ENABLED = 1	Display the Visualizer with depth testing enabled.
MODE_ENABLED_DEPTH_TEST_DISABLED = 2	Display the Visualizer without depth testing.

Members

void setEnabled ( bool enabled ) #

Enables or disables the visualizer.

Arguments

bool enabled - true to enable the visualizer, false to disable it.

bool isEnabled ( ) #

Returns a value indicating if the visualizer is enabled.

Return value

1 if the visualizer is enabled; otherwise, 0.

void setSize ( int size ) #

Updates the current size of the handler. All handlers have the same size.

Arguments

int size - A new handler size in pixels.

int getSize ( ) #

Returns the handler size. All handlers have the same size.

Return value

The current size of the handler in pixels.

void setTextureName ( const char * name ) #

Updates the current name of the texture.

Arguments

const char * name - A new name of the texture.

const char * getTextureName ( ) #

Returns the string with the name of the texture.

Return value

The name of the texture.

void clear ( ) #

Clears all internal primitives created by calls to renderSmth functions. These primitives are accumulated in the internal buffer and then rendered together.

Notice

This method can be used to render several viewports with visualizer.

void renderPoint2D ( const Math::vec2 & v, float size, const Math::vec4 & color, float order = 0.0f, float duration = 0.0f ) const#

Renders a 2D point of a given size and color. 2D points are rendered in the screen plane; coordinates of the upper left corner are (0; 0), of the lower right corner—(1; 1).

Arguments

const Math::vec2 & v - Point coordinates.
float size - Point size in range [0;1]. The point size is set in proportion to the screen resolution.
const Math::vec4 & color - Point color.
float order - Z-order value for the rendered element. An element having a lower order shall be rendered over the one having a higher one.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderPoint3D ( const Math::Vec3 & v, float size, const Math::vec4 & color, bool screen_space = false, float duration = 0.0f, bool depth_test = true ) const#

Renders a 3D point of a given size and color. 3D points are rendered in the world space.

Arguments

const Math::Vec3 & v - Point coordinates.
float size - Point size in range [0;1]. The point size is set in proportion to the screen resolution.
const Math::vec4 & color - Point color.
bool screen_space - Flag indicating the type of dimensions to be used:
- false - use the world space dimensions
- true - use the screen space dimensions
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderLine2D ( const Math::vec2 & v0, const Math::vec2 & v1, const Math::vec4 & color, float order = 0.0f, float duration = 0.0f ) #

Renders a 2D line of a given color. 2D lines are rendered in the screen plane; coordinates of the upper left corner are (0; 0), of the lower right corner — (1; 1).

Arguments

const Math::vec2 & v0 - Starting point of the line.
const Math::vec2 & v1 - Ending point of the line.
const Math::vec4 & color - Line color.
float order - Z-order value for the rendered element. An element having a lower order shall be rendered over the one having a higher one.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderLine3D ( const Math::Vec3 & v0, const Math::Vec3 & v1, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) #

Renders a 3D line of a given color. 3D lines are rendered in the world space.

Arguments

const Math::Vec3 & v0 - Starting point of the line.
const Math::Vec3 & v1 - Ending point of the line.
const Math::vec4 & color - Line color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderLine2D ( const Math::vec2 & v0, const Math::vec2 & v1, const Math::vec2 & v2, const Math::vec4 & color, float order = 0.0f, float duration = 0.0f ) #

Renders a 2D line of a given color by using 3 points. 2D lines are rendered in the screen plane; coordinates of the upper left corner are (0; 0), of the lower right corner — (1; 1).

Arguments

const Math::vec2 & v0 - Coordinates of the starting point of the line.
const Math::vec2 & v1 - Coordinates of the intermediate point of the line.
const Math::vec2 & v2 - Coordinates of the ending point of the line.
const Math::vec4 & color - Line color.
float order - Z-order value for the rendered element. An element having a lower order shall be rendered over the one having a higher one.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderLine3D ( const Math::Vec3 & v0, const Math::Vec3 & v1, const Math::Vec3 & v2, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) #

Renders a 3D line of a given color. 3D lines are rendered in the world space.

Arguments

const Math::Vec3 & v0 - Coordinates of the starting point of the line.
const Math::Vec3 & v1 - Coordinates of the intermediate point of the line.
const Math::Vec3 & v2 - Coordinates of the ending point of the line.
const Math::vec4 & color - Line color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderLine2D ( const Math::vec2 & v0, const Math::vec2 & v1, const Math::vec2 & v2, const Math::vec2 & v3, const Math::vec4 & color, float order = 0.0f, float duration = 0.0f ) #

Renders a 2D line of a given color. 2D lines are rendered in the screen plane; coordinates of the upper left corner are (0; 0), of the lower right corner — (1; 1).

Arguments

const Math::vec2 & v0 - Coordinates of the starting point of the line.
const Math::vec2 & v1 - Coordinates of the first intermediate point of the line.
const Math::vec2 & v2 - Coordinates of the second intermediate point of the line.
const Math::vec2 & v3 - Coordinates of the ending point of the line.
const Math::vec4 & color - Color, in which the line will be rendered.
float order - Z-order value for the rendered element. An element having a lower order shall be rendered over the one having a higher one.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderLine3D ( const Math::Vec3 & v0, const Math::Vec3 & v1, const Math::Vec3 & v2, const Math::Vec3 & v3, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) #

Renders a 3D line of a given color. 3D lines are rendered in the world space.

Arguments

const Math::Vec3 & v0 - Coordinates of the starting point of the line.
const Math::Vec3 & v1 - Coordinates of the first intermediate point of the line.
const Math::Vec3 & v2 - Coordinates of the second intermediate point of the line.
const Math::Vec3 & v3 - Coordinates of the ending point of the line.
const Math::vec4 & color - Color, in which the line will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderTriangle2D ( const Math::vec2 & v0, const Math::vec2 & v1, const Math::vec2 & v2, const Math::vec4 & color, float order = 0.0f, float duration = 0.0f ) const#

Renders a 2D triangle of a given color. 2D triangles are rendered in the screen plane; coordinates of the upper left corner are (0; 0), of the lower right corner—(1; 1).

Arguments

const Math::vec2 & v0 - Coordinates of the first vertex.
const Math::vec2 & v1 - Coordinates of the second vertex.
const Math::vec2 & v2 - Coordinates of the third vertex.
const Math::vec4 & color - Triangle color.
float order - Z-order value for the rendered element. An element having a lower order shall be rendered over the one having a higher one.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderTriangle3D ( const Math::Vec3 & v0, const Math::Vec3 & v1, const Math::Vec3 & v2, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a 3D triangle of a given color. 3D triangles are rendered in the world space.

Arguments

const Math::Vec3 & v0 - Coordinates of the first vertex.
const Math::Vec3 & v1 - Coordinates of the second vertex.
const Math::Vec3 & v2 - Coordinates of the third vertex.
const Math::vec4 & color - Triangle color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderQuad2D ( const Math::vec2 & v0, const Math::vec2 & v1, const Math::vec2 & v2, const Math::vec2 & v3, const Math::vec4 & color, float order = 0.0f, float duration = 0.0f ) const#

Renders a 2D quad of a given color. 2D quads are rendered in the screen plane; coordinates of the upper left corner are (0; 0), of the lower right corner—(1; 1).

Arguments

const Math::vec2 & v0 - Coordinates of the first vertex.
const Math::vec2 & v1 - Coordinates of the second vertex.
const Math::vec2 & v2 - Coordinates of the third vertex.
const Math::vec2 & v3 - Coordinates of the fourth vertex.
const Math::vec4 & color - Color, in which the quad will be rendered.
float order - Z-order value for the rendered element. An element having a lower order shall be rendered over the one having a higher one.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderQuad3D ( const Math::Vec3 & v0, const Math::Vec3 & v1, const Math::Vec3 & v2, const Math::Vec3 & v3, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a 3D quad of a given color. 3D quads are rendered in the world space.

Arguments

const Math::Vec3 & v0 - Coordinates of the first vertex.
const Math::Vec3 & v1 - Coordinates of the second vertex.
const Math::Vec3 & v2 - Coordinates of the third vertex.
const Math::Vec3 & v3 - Coordinates of the fourth vertex.
const Math::vec4 & color - Color, in which the quad will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderBillboard3D ( const Math::Vec3 & v, float size, const Math::vec4 & texcoord, bool screen_space = false, float duration = 0.0f, bool depth_test = true ) const#

Renders a 3D billboard of the specified size.

Arguments

const Math::Vec3 & v - Coordinates of the billboard.
float size - The billboard size.
const Math::vec4 & texcoord - The billboard texture coordinates.
bool screen_space - Flag indicating the type of dimensions to be used:
- false - use the world space dimensions
- true - use the screen space dimensions
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderVector ( const Math::Vec3 & position_start, const Math::Vec3 & position_end, const Math::vec4 & color, float arrow_size = 0.25f, bool screen_space = false, float duration = 0.0f, bool depth_test = true ) const#

Renders a vector of a given color.

Arguments

const Math::Vec3 & position_start - Coordinates of the vector origin.
const Math::Vec3 & position_end - Coordinates of the vector target.
const Math::vec4 & color - Vector color.
float arrow_size - Arrow size.
bool screen_space - Flag indicating the type of dimensions to be used:
- false - use the world space dimensions
- true - use the screen space dimensions
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderDirection ( const Math::Vec3 & position, const Math::vec3 & direction, const Math::vec4 & color, float arrow_size = 0.25f, bool screen_space = true, float duration = 0.0f, bool depth_test = true ) const#

Renders a direction vector of a given color.

Arguments

const Math::Vec3 & position - Coordinates of the vector origin.
const Math::vec3 & direction - Target vector direction.
const Math::vec4 & color - Vector color.
float arrow_size - Arrow size.
bool screen_space - Flag indicating the type of dimensions to be used:
- false - use the world space dimensions
- true - use the screen space dimensions
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderBox ( const Math::vec3 & size, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a box of a given color.

Arguments

const Math::vec3 & size - Dimensions of the box.
const Math::Mat4 & transform - Transformation matrix, which is used to position the box.
const Math::vec4 & color - Color, in which the box will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderFrustum ( const Math::mat4 & projection, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a wireframe frustum of a given color.

Arguments

const Math::mat4 & projection - Projection matrix used to transform the coordinates.
const Math::Mat4 & transform - Transformation matrix used to position the frustum.
const Math::vec4 & color - Color, in which the frustum will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderCircle ( float radius, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a wireframe circle of a given color.

Arguments

float radius - Radius of the circle.
const Math::Mat4 & transform - Transformation matrix used to position the circle.
const Math::vec4 & color - Circle color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderSector ( float radius, float angle, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a wireframe sector of a given color.

Arguments

float radius - Radius of the circle from which a sector is cut.
float angle - Angle of the sector.
const Math::Mat4 & transform - Transformation matrix used to position the sector.
const Math::vec4 & color - Sector color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderCone ( float radius, float angle, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a wireframe cone of a given color.

Arguments

float radius - Radius of the cone.
float angle - Angle of the cone.
const Math::Mat4 & transform - Transformation matrix used to position the cone.
const Math::vec4 & color - Color, in which the cone will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderSphere ( float radius, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a wireframe sphere of a given color.

Arguments

float radius - Radius of the sphere.
const Math::Mat4 & transform - Transformation matrix used to position the sphere.
const Math::vec4 & color - Sphere color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderCapsule ( float radius, float height, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a wireframe capsule (capped cylinder) of a given color.

Arguments

float radius - Radius of the capsule.
float height - Height of the capsule.
const Math::Mat4 & transform - Transformation matrix used to position the capsule.
const Math::vec4 & color - Capsule color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderCylinder ( float radius, float height, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a wireframe cylinder of a given color.

Arguments

float radius - Radius of the cylinder.
float height - Height of the cylinder.
const Math::Mat4 & transform - Transformation matrix used to position the cylinder.
const Math::vec4 & color - Cylinder color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderEllipse ( const Math::vec3 & radius, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a wireframe ellipse of a given color.

Arguments

const Math::vec3 & radius - Ellipse radius values along three axes.
const Math::Mat4 & transform - Transformation matrix for the ellipse.
const Math::vec4 & color - Ellipse color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderSolidBox ( const Math::vec3 & size, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a solid box of a given color.

Arguments

const Math::vec3 & size - Size of the solid box.
const Math::Mat4 & transform - Transformation matrix used to position the solid box.
const Math::vec4 & color - Box color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderSolidSphere ( float radius, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a solid sphere of a given color.

Arguments

float radius - Radius of the solid sphere.
const Math::Mat4 & transform - Transformation matrix used to position the solid sphere.
const Math::vec4 & color - Sphere color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderSolidCapsule ( float radius, float height, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a solid capsule af a given color.

Arguments

float radius - Radius of the capsule.
float height - Height of the capsule.
const Math::Mat4 & transform - Transformation matrix used to position the capsule.
const Math::vec4 & color - Capsule color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderSolidCylinder ( float radius, float height, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a solid cylinder of a given color.

Arguments

float radius - Radius of the cylinder.
float height - Height of the cylinder.
const Math::Mat4 & transform - Transformation matrix used to position the cylinder.
const Math::vec4 & color - Cylinder color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderSolidEllipse ( const Math::vec3 & radius, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) const#

Renders a solid ellipse of a given color.

Arguments

const Math::vec3 & radius - Ellipse radius values along three axes.
const Math::Mat4 & transform - Transformation matrix used to position the ellipse.
const Math::vec4 & color - Ellipse color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderRectangle ( const Math::vec4 & rectangle, const Math::vec4 & color, float duration = 0.0f ) #

Renders a 2D wireframe rectangle of a given color.

Arguments

const Math::vec4 & rectangle - Four-component vector containing the coordinates of the upper-left (first two components) and bottom-right (second two components) corners of the rectangle.
const Math::vec4 & color - Rectangle color.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderBoundBox ( const BoundBox & bb, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) #

Renders the bounding box of a given color.

Arguments

const BoundBox & bb - The bounding box.
const Math::Mat4 & transform - Transformation matrix for the bounding box.
const Math::vec4 & color - Color, in which the box will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderBoundSphere ( const BoundSphere & bs, const Math::Mat4 & transform, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) #

Renders the bounding sphere of a given color.

Arguments

const BoundSphere & bs - The bounding sphere.
const Math::Mat4 & transform - Transformation matrix for the bounding sphere.
const Math::vec4 & color - Color, in which the sphere will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderNodeBoundBox ( const Ptr<Node> & node, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) #

Renders an axis-aligned bound box of a given node.

Arguments

const Ptr<Node> & node - Node, for which the bound box is rendered.
const Math::vec4 & color - Color, in which the box will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderNodeBoundSphere ( const Ptr<Node> & node, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) #

Renders a bound sphere of a given node.

Arguments

const Ptr<Node> & node - Node, for which the bound sphere is rendered.
const Math::vec4 & color - Color, in which the sphere will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderObjectSurfaceBoundBox ( const Ptr<Object> & object, int surface, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) #

Renders a bound box of a given object surface.

Arguments

const Ptr<Object> & object - Object, which contains the target surface.
int surface - The number of the target surface in the object.
const Math::vec4 & color - Color, in which the box will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderObjectSurfaceBoundSphere ( const Ptr<Object> & object, int surface, const Math::vec4 & color, float duration = 0.0f, bool depth_test = true ) #

Renders a bound sphere of a given object surface.

Arguments

const Ptr<Object> & object - Object, which contains the target surface.
int surface - The number of the target surface in the object.
const Math::vec4 & color - Color, in which the sphere will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.
bool depth_test - true to enable depth testing for the element (if it should be obscured by elements closer to the camera); false — to disable it.

void renderNodeHandler ( const Ptr<Node> & node, float duration = 0.0f ) const#

Renders a handler for the specified node.

Arguments

const Ptr<Node> & node - Node, for which the handler is to be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderObject ( const Ptr<Object> & object, const Math::vec4 & color, float duration = 0.0f ) const#

Renders an object wireframe.

Arguments

const Ptr<Object> & object - Object, which wireframe will be rendered.
const Math::vec4 & color - Color, in which the wireframe will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderObjectSurface ( const Ptr<Object> & object, int surface, const Math::vec4 & color, float duration = 0.0f ) const#

Renders borders of a given object surface.

Arguments

const Ptr<Object> & object - Object, which contains the target surface.
int surface - The number of the target surface in the object.
const Math::vec4 & color - Color, in which the borders will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderSolidObject ( const Ptr<Object> & object, const Math::vec4 & color, float duration = 0.0f ) const#

Renders a solid-colored object.

Arguments

const Ptr<Object> & object - Object smart pointer.
const Math::vec4 & color - Color in which the object will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderSolidObjectSurface ( const Ptr<Object> & object, int surface, const Math::vec4 & color, float duration = 0.0f ) const#

Renders a solid-colored surface of a given object.

Arguments

const Ptr<Object> & object - Object smart pointer.
int surface - The number of the object's surface.
const Math::vec4 & color - Color, in which the object's surface will be rendered.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderMessage2D ( const Math::vec3 & position, const Math::vec3 & center, const char * str, const Math::vec4 & color, int outline, float duration = 0.0f ) #

Renders a message in a given color. Message position is specified in screen coordinates.

Arguments

const Math::vec3 & position - Coordinates of the anchor point of the message, each in [0;1] range.
const Math::vec3 & center - Message alignment. The first two values in the vector set the offset, the third one is ignored. For example, vec3(-1,-1,0) sets the offset of the center of the message to its upper left edge. vec3(1,1,0) - to the lower right corner.
const char * str - Message text to display.
const Math::vec4 & color - Color, in which the message will be rendered.
int outline - 1 to use font outlining, 0 not to use.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void renderMessage3D ( const Math::Vec3 & position, const Math::vec3 & center, const char * str, const Math::vec4 & color, int outline, float duration = 0.0f ) #

Renders a message in a given color. Message position is specified in world coordinates.

Arguments

const Math::Vec3 & position - Coordinates of the anchor point of the message (in world coordinates).
const Math::vec3 & center - Message alignment. The first two values in the vector set the offset, the third one is ignored. For example, vec3(-1,-1,0) sets the offset of the center of the message to its upper left edge. vec3(1,1,0) - to the lower right corner.
const char * str - Message text to display.
const Math::vec4 & color - Color, in which the message will be rendered.
int outline - 1 to use font outlining, 0 not to use.
float duration - Time period (in seconds) during which the rendered element shall be displayed. The default value of 0 means that the visualizer is rendered for 1 frame only.

void setMode ( Visualizer::MODE mode ) #

Sets a new Visualizer mode to be used. You can choose to display Visualizer with or without depth testing, or turn it off completely.

Arguments

Visualizer::MODE mode - New Visualizer mode to be set.

Visualizer::MODE getMode ( ) #

Returns the current Visualizer mode.

Last update: 2020-08-25

Help improve this article

Was this article helpful?

Report a problem related to this article

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