Debug utilities

Topics
	Diag menu API definition

Classes
interface	DbgUI
	Immediate mode debug UI API. More...
interface	Debug
interface	DebugText
	Used for creating on screen texts in world. More...
interface	DebugTextScreenSpace
interface	DebugTextWorldSpace
interface	DiagMenu
	Check EDiagMenu enum for 'id' values. More...
interface	Shape
	Instance of created debug visualizer. More...
interface	ShapeUtils

Enumerations
enum	DebugTextFlags {   DebugTextFlags.DEFAULT , DebugTextFlags.CENTER , DebugTextFlags.FACE_CAMERA , DebugTextFlags.ONCE ,   DebugTextFlags.IN_WORLD , DebugTextFlags.DONT_SCALE_POS , DebugTextFlags.DONT_SCALE }
enum	LogLevel {   LogLevel.SPAM , LogLevel.VERBOSE , LogLevel.DEBUG , LogLevel.NORMAL ,   LogLevel.WARNING , LogLevel.ERROR , LogLevel.FATAL }
	Enum with severity of the logging message. More...
enum	ShapeFlags {   ShapeFlags.DEFAULT , ShapeFlags.NOZBUFFER , ShapeFlags.NOZWRITE , ShapeFlags.WIREFRAME ,   ShapeFlags.TRANSP , ShapeFlags.DOUBLESIDE , ShapeFlags.ONCE , ShapeFlags.NOOUTLINE ,   ShapeFlags.BACKFACE , ShapeFlags.NOCULL , ShapeFlags.VISIBLE , ShapeFlags.ADDITIVE ,   ShapeFlags.DEPTH_DITHER , ShapeFlags.CULL_FAR , ShapeFlags.SHOW_ERRORS , ShapeFlags.NOINSERT ,   ShapeFlags.FLAT , ShapeFlags.SVF_NORMAL , ShapeFlags.SVF_COLOR }
enum	ShapeType {   ShapeType.NONE , ShapeType.BBOX , ShapeType.LINE , ShapeType.BRUSH ,   ShapeType.PIVOT , ShapeType.POINT , ShapeType.MESH , ShapeType.POLYGON ,   ShapeType.INDEXEDMESH , ShapeType.SPHERE , ShapeType.CYLINDER , ShapeType.DIAMOND ,   ShapeType.PYRAMID , ShapeType.ARROW , ShapeType.LINE_LIST , ShapeType.LINE_STRIP }

Functions
proto void	Print (void var, LogLevel level=LogLevel.NORMAL)
	Prints content of variable to console/log.
proto void	PrintFormat (string fmt, void param1=NULL, void param2=NULL, void param3=NULL, void param4=NULL, void param5=NULL, void param6=NULL, void param7=NULL, void param8=NULL, void param9=NULL, LogLevel level=LogLevel.NORMAL)
	Prints formated text to console/log.

Detailed Description

Enumeration Type Documentation

DebugTextFlags

enum DebugTextFlags

Enumerator
DEFAULT
CENTER
FACE_CAMERA
ONCE
IN_WORLD
DONT_SCALE_POS	disable automatic position scaling, always present on world-space debug texts
DONT_SCALE	disable both automatic position and size scaling

LogLevel

enum LogLevel

Enum with severity of the logging message.

Enumerator
SPAM
VERBOSE
DEBUG
NORMAL
WARNING
ERROR
FATAL

ShapeFlags

enum ShapeFlags

Enumerator
DEFAULT
NOZBUFFER	Do not compare z-buffer when render.
NOZWRITE	Do not update z-buffer when render.
WIREFRAME	Render just wire-frame outline. No solid faces.
TRANSP	Is translucent.
DOUBLESIDE	Double-sided (do not cull back-faces)
ONCE	Rendered just once and then it's automatically destroyed. Do not keep pointer to these!!
NOOUTLINE	Render just solid faces. No wire-frame outline.
BACKFACE	Render just back faces.
NOCULL	Do not cull shapes by view frustum.
VISIBLE	Make it visible. Set by default.
ADDITIVE	Additive blending (works with SS_TRANSP)
DEPTH_DITHER	dither according depth
CULL_FAR	More aggressive culling of far shapes with this flag.
SHOW_ERRORS	Draw double sided, highlighting backfaces to visualize vertex winding order errors.
NOINSERT	Do not insert it to shape-collection.
FLAT	Flat shading (no vertex normals are required)
SVF_NORMAL
SVF_COLOR

ShapeType

enum ShapeType

Enumerator
NONE	When Shape is created and not initialized yet.
BBOX	Just box.
LINE	One lines.
BRUSH	Not implemented.
PIVOT	3D orientation visualizer
POINT	Not implemented.
MESH	Triangle mesh. Just triangle list, no tri-fan/tri-strip.
POLYGON	Polygon.
INDEXEDMESH	Triangle mesh. Just triangle list, no tri-fan/tri-strip.
SPHERE	Sphere represented by triangle mesh.
CYLINDER	Cylinder represented by triangle mesh.
DIAMOND	Eight faced pyramid. Defined by bound-box, where middle part is equal to horizontal extents of box and top/bottom apogees lies on top/bottom side of box.
PYRAMID	Four sided pyramid. Defined by bound-box, where base is equal to bottom side of box.
ARROW	Arrow pointing down.
LINE_LIST	List of multiple lines.
LINE_STRIP	Multiple lines in a single winding.

Function Documentation

Print()

proto void Print	(	void	var,
		LogLevel	level = LogLevel.NORMAL )

Prints content of variable to console/log.

PrintFormat()

proto void PrintFormat	(	string	fmt,
		void	param1 = NULL,
		void	param2 = NULL,
		void	param3 = NULL,
		void	param4 = NULL,
		void	param5 = NULL,
		void	param6 = NULL,
		void	param7 = NULL,
		void	param8 = NULL,
		void	param9 = NULL,
		LogLevel	level = LogLevel.NORMAL )

Prints formated text to console/log.

string c = "Peter";
PrintFormat("Hello %1, how are you?", c); // prints "Hello 'Peter', how are you?"