Unigine.Visualizer Class

// AppWorldLogic.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Unigine;

namespace UnigineApp
{
	class AppWorldLogic : WorldLogic
	{

	public override bool Init()
		{
			/* ... */
			// enable the visualizer
			Visualizer.Enabled = true;

			return true;
		}


		public override bool Update()
		{
			// render world origin
			Visualizer.RenderVector(new dvec3(0.0f, 0.0f, 0.1f), new dvec3(1.0f, 0.0f, 0.1f), new vec4(1.0f, 0.0f, 0.0f, 1.0f));
			Visualizer.RenderVector(new dvec3(0.0f, 0.0f, 0.1f), new dvec3(0.0f, 1.0f, 0.1f), new vec4(0.0f, 1.0f, 0.0f, 1.0f));
			Visualizer.RenderVector(new dvec3(0.0f, 0.0f, 0.1f), new dvec3(0.0f, 0.0f, 1.1f), new vec4(0.0f, 0.0f, 1.0f, 1.0f));

			return true;
		}
	}
}

Visualizer Class

Enums

MODE#

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

Name	Description
DISABLED = 0	Do not display the Visualizer at all.
ENABLED_DEPTH_TEST_ENABLED = 1	Display the Visualizer with depth testing enabled.
ENABLED_DEPTH_TEST_DISABLED = 2	Display the Visualizer without depth testing.

Properties

string TextureName#

int Size#

bool IsEnabled#

Visualizer.MODE Mode#

Members

---

void Clear ( ) #

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

void RenderPoint2D ( vec3 v, float size, vec4 color ) #

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

• vec3 v - Point coordinates.
• float size - Point size.
• vec4 color - Color, in which the point will be rendered.

void RenderPoint3D ( vec3 v, float size, vec4 color, int screen_space = 0 ) #

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

Arguments

• vec3 v - Point coordinates.
• float size - Point size in range [0;1]. The point size is set in proportion to the screen resolution.
• vec4 color - Point color.
• int screen_space - A flag indicating the type of dimensions to be used:
  • 0 - use the world space dimensions
  • 1 - use the screen space dimensions

void RenderLine2D ( vec3 v0, vec3 v1, vec4 color ) #

Renders a 2D line of a given color by using 2 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

• vec3 v0 - Starting point of the line.
• vec3 v1 - First intermediate point of the line.
• vec4 color - Second intermediate point of the line.

void RenderLine3D ( vec3 v0, vec3 v1, vec4 color ) #

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

Arguments

• vec3 v0 - Starting point of the line.
• vec3 v1 - First intermediate point of the line.
• vec4 color - Second intermediate point of the line.

void RenderLine2D ( vec3 v0, vec3 v1, vec3 v2, vec4 color ) #

Renders a 2D line of a given color by using 2 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

• vec3 v0 - Starting point of the line.
• vec3 v1 - First intermediate point of the line.
• vec3 v2 - Second intermediate point of the line.
• vec4 color - Ending point of the line.

void RenderLine3D ( vec3 v0, vec3 v1, vec3 v2, vec4 color ) #

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

Arguments

• vec3 v0 - Starting point of the line.
• vec3 v1 - First intermediate point of the line.
• vec3 v2 - Second intermediate point of the line.
• vec4 color - Ending point of the line.

void RenderLine2D ( vec3 v0, vec3 v1, vec3 v2, vec3 v3, vec4 color ) #

Renders a 2D line of a given color by using 2 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

• vec3 v0 - Starting point of the line.
• vec3 v1 - First intermediate point of the line.
• vec3 v2 - Second intermediate point of the line.
• vec3 v3 - Ending point of the line.
• vec4 color - Color, in which the line will be rendered.

void RenderLine3D ( vec3 v0, vec3 v1, vec3 v2, vec3 v3, vec4 color ) #

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

Arguments

• vec3 v0 - Starting point of the line.
• vec3 v1 - First intermediate point of the line.
• vec3 v2 - Second intermediate point of the line.
• vec3 v3 - Ending point of the line.
• vec4 color - Color, in which the line will be rendered.

void RenderTriangle2D ( vec3 v0, vec3 v1, vec3 v2, vec4 color ) #

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

• vec3 v0 - Coordinates of the first vertex.
• vec3 v1 - Coordinates of the second vertex.
• vec3 v2 - Coordinates of the third vertex.
• vec4 color - Color, in which the triangle will be rendered.

void RenderTriangle3D ( vec3 v0, vec3 v1, vec3 v2, vec4 color ) #

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

Arguments

• vec3 v0 - Coordinates of the first vertex.
• vec3 v1 - Coordinates of the second vertex.
• vec3 v2 - Coordinates of the third vertex.
• vec4 color - Color, in which the triangle will be rendered.

void RenderQuad2D ( vec3 v0, vec3 v1, vec3 v2, vec3 v3, vec4 color ) #

Renders a 2D quadrilateral 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

• vec3 v0 - Coordinates of the first vertex.
• vec3 v1 - Coordinates of the second vertex.
• vec3 v2 - Coordinates of the third vertex.
• vec3 v3 - Coordinates of the fourth vertex.
• vec4 color - Color, in which the quad will be rendered.

void RenderQuad3D ( vec3 v0, vec3 v1, vec3 v2, vec3 v3, vec4 color ) #

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

Arguments

• vec3 v0 - Coordinates of the first vertex.
• vec3 v1 - Coordinates of the second vertex.
• vec3 v2 - Coordinates of the third vertex.
• vec3 v3 - Coordinates of the fourth vertex.
• vec4 color - Color, in which the quad will be rendered.

void RenderBillboard3D ( vec3 v, float size, vec4 texcoord, int screen_space = 0 ) #

Renders a 3D billboard of the specified size.

Arguments

• vec3 v - Coordinates of the billboard.
• float size - The billboard size.
• vec4 texcoord - The billboard texture coordinates.
• int screen_space - A flag indicating the type of dimensions to be used:
  • 0 - use the world space dimensions
  • 1 - use the screen space dimensions

void RenderVector ( vec3 position_start, vec3 position_end, vec4 color, float arrow_size = 0.25f, int screen_space = 0 ) #

Renders a vector of a given color.

Arguments

• vec3 position_start - Coordinates of the vector origin.
• vec3 position_end - Coordinates of the vector target.
• vec4 color - Vector color.
• float arrow_size - Arrow size.
• int screen_space - A flag indicating the type of dimensions to be used:
  • 0 - use the world space dimensions
  • 1 - use the screen space dimensions

void RenderDirection ( vec3 position, vec3 direction, vec4 color, float arrow_size = 0.25f, int screen_space = 1 ) #

Renders a direction vector of a given color.

Arguments

• vec3 position - Coordinates of the vector origin.
• vec3 direction - Target vector direction.
• vec4 color - Vector color.
• float arrow_size - Arrow size.
• int screen_space - A flag indicating the type of dimensions to be used:
  • 0 - use the world space dimensions
  • 1 - use the screen space dimensions

void RenderBox ( vec3 size, mat4 transform, vec4 color ) #

Renders a wireframe box of a given color.

Arguments

• vec3 size - Dimensions of the box.
• mat4 transform - Transformation matrix used to position the box.
• vec4 color - Color, in which the box will be rendered.

void RenderFrustum ( mat4 projection, mat4 transform, vec4 color ) #

Renders a wireframe frustum of a given color.

Arguments

• mat4 projection - Projection matrix used to transform the coordinates.
• mat4 transform - Transformation matrix used to position the frustum.
• vec4 color - Color, in which the frustum will be rendered.

void RenderCircle ( float radius, mat4 transform, vec4 color ) #

Renders a wireframe circle of a given color.

Arguments

• float radius - Radius of the circle.
• mat4 transform - Transformation matrix used to position the circle.
• vec4 color - Color, in which the circle will be rendered.

void RenderSector ( float radius, float angle, mat4 transform, vec4 color ) #

Renders a wireframe sector of a given color.

Arguments

• float radius - Radius of the circle from which a sector will be cut.
• float angle - Angle of the sector.
• mat4 transform - Transformation matrix used to position the sector.
• vec4 color - Color, in which the sector will be rendered.

void RenderCone ( float radius, float angle, mat4 transform, vec4 color ) #

Renders a wireframe cone of a given color.

Arguments

• float radius - Radius of the cone.
• float angle - Angle of the cone.
• mat4 transform - Transformation matrix used to position the cone.
• vec4 color - Color, in which the cone will be rendered.

void RenderSphere ( float radius, mat4 transform, vec4 color ) #

Renders a wireframe sphere of a given color.

Arguments

• float radius - Radius of the sphere.
• mat4 transform - Transformation matrix used to position the sphere.
• vec4 color - Color, in which the sphere will be rendered.

void RenderCapsule ( float radius, float height, mat4 transform, vec4 color ) #

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

Arguments

• float radius - Radius of the capsule.
• float height - Height of the capsule.
• mat4 transform - Transformation matrix used to position the capsule.
• vec4 color - Color, in which the capsule will be rendered.

void RenderCylinder ( float radius, float height, mat4 transform, vec4 color ) #

Renders a wireframe cylinder of a given color.

Arguments

• float radius - Radius of the cylinder.
• float height - Height of the cylinder.
• mat4 transform - Transformation matrix used to position the cylinder.
• vec4 color - Color, in which the cylinder will be rendered.

void RenderEllipse ( vec3 radius, mat4 transform, vec4 color ) #

Renders a wireframe ellipse of a given color.

Arguments

• vec3 radius - Ellipse radius values along three axes.
• mat4 transform - Transformation matrix for the ellipse.
• vec4 color - Color, in which the box will be rendered.

void RenderSolidBox ( vec3 size, mat4 transform, vec4 color ) #

Renders a solid box of a given color.

Arguments

• vec3 size - Size of the solid box.
• mat4 transform - Transformation matrix used to position the solid box.
• vec4 color - Color, in which the solid box will be rendered.

void RenderSolidSphere ( float radius, mat4 transform, vec4 color ) #

Renders a solid sphere of a given color.

Arguments

• float radius - Radius of the solid sphere.
• mat4 transform - Transformation matrix used to position the solid sphere.
• vec4 color - Sphere color.

void RenderSolidCapsule ( float radius, float height, mat4 transform, vec4 color ) #

Renders a solid capsule.

Arguments

• float radius - Radius of the capsule.
• float height - Height of the capsule.
• mat4 transform - Transformation matrix used to position the capsule.
• vec4 color - Color, in which the capsule will be rendered.

void RenderSolidCylinder ( float radius, float height, mat4 transform, vec4 color ) #

Renders a solid cylinder of a given color.

Arguments

• float radius - Radius of the cylinder.
• float height - Height of the cylinder.
• mat4 transform - Transformation matrix used to position the cylinder.
• vec4 color - Color, in which the cylinder will be rendered.

void RenderSolidEllipse ( vec3 radius, mat4 transform, vec4 color ) #

Renders a solid ellipse of a given color.

Arguments

• vec3 radius - Ellipse radius values along three axes.
• mat4 transform - Transformation matrix used to position the ellipse.
• vec4 color - Color, in which the ellipse will be rendered.

void RenderBoundBox ( BoundBox bb, mat4 transform, vec4 color ) #

Renders the bounding box in a given color.

Arguments

• BoundBox bb - The bounding box.
• mat4 transform - Transformation matrix for the bounding box.
• vec4 color - Color, in which the box will be rendered.

void RenderBoundSphere ( BoundSphere bs, mat4 transform, vec4 color ) #

Renders the bounding sphere in a given color.

Arguments

• BoundSphere bs - The bounding sphere.
• mat4 transform - Transformation matrix for the bounding sphere.
• vec4 color - Color, in which the sphere will be rendered.

void RenderNodeBoundBox ( Node node, vec4 color ) #

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

Arguments

• Node node - Node, for which the bound box is rendered.
• vec4 color - Color, in which the box will be rendered.

void RenderNodeBoundSphere ( Node node, vec4 color ) #

Renders a bound sphere of a given node.

Arguments

• Node node - Node, for which the bound sphere is rendered.
• vec4 color - Color, in which the sphere will be rendered.

void RenderObjectSurfaceBoundBox ( Object object, int surface, vec4 color ) #

Renders a bound box of a given object surface.

Arguments

• Object object - Object, which contains the target surface.
• int surface - The number of the target surface in the object.
• vec4 color - Color, in which the box will be rendered.

void RenderObjectSurfaceBoundSphere ( Object object, int surface, vec4 color ) #

Renders a bound sphere of a given object surface.

Arguments

• Object object - Object, which contains the target surface.
• int surface - The number of the target surface in the object.
• vec4 color - Color, in which the sphere will be rendered.

void RenderNodeHandler ( Node node ) #

Renders a node handler for the specified node.

Arguments

• Node node - Pointer to the node, for which the handler is to be rendered.

void RenderObject ( Object object, vec4 color ) #

Renders an object wireframe.

Arguments

• Object object - Object, which wireframe will be rendered.
• vec4 color - Color, in which the wireframe will be rendered.

void RenderObjectSurface ( Object object, int surface, vec4 color ) #

Renders borders of a given object surface.

Arguments

• Object object - Object, which contains the target surface.
• int surface - The number of the target surface in the object.
• vec4 color - Color, in which the borders will be rendered.

void RenderSolidObject ( Object object, vec4 color ) #

Renders a solid-colored object.

Arguments

• Object object - Object that will be rendered.
• vec4 color - Color in which the object will be rendered.

void RenderSolidObjectSurface ( Object object, int surface, vec4 color ) #

Renders a solid-colored surface of a given object.

Arguments

• Object object - Object that will be rendered.
• int surface - The number of the object's surface.
• vec4 color - Color, in which the object's surface will be rendered.

void RenderMessage2D ( vec3 position, vec3 center, string str, vec4 color, int outline ) #

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

Arguments

• vec3 position - Coordinates of the anchor point of the message, each in [0;1] range.
• 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.
• string str - Message text to display.
• vec4 color - Color, in which the message will be rendered.
• int outline - 1 to use font outlining, 0 not to use.

void RenderMessage2D ( vec3 position, vec3 center, string str, vec4 color, int outline, int font_size ) #

Renders a message in a given color with the specified font size. Message position is specified in screen coordinates.

Arguments

• vec3 position - Coordinates of the anchor point of the message, each in [0;1] range.
• 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.
• string str - Message text to display.
• vec4 color - Color, in which the message will be rendered.
• int outline - 1 to use font outlining, 0 not to use.
• int font_size - Font size.

void RenderMessage3D ( vec3 position, vec3 center, string str, vec4 color, int outline ) #

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

Arguments

• vec3 position - Coordinates of the anchor point of the message (in world coordinates).
• 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.
• string str - Message text to display.
• vec4 color - Color, in which the message will be rendered.
• int outline - 1 to use font outlining, 0 not to use.

void RenderMessage3D ( vec3 position, vec3 center, string str, vec4 color, int outline, int font_size ) #

Renders a message in a given color with the specified font size. Message position is specified in world coordinates.

Arguments

• vec3 position - Coordinates of the anchor point of the message (in world coordinates).
• 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.
• string str - Message text to display.
• vec4 color - Color, in which the message will be rendered.
• int outline - 1 to use font outlining, 0 not to use.
• int font_size - Font size.

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.