CryEngine.Debugging.DebugDraw

CryEngine.Debugging.DebugDraw

Helper class for drawing debug information. More...

Static Public Member Functions

static void Sphere (Vector3 position, float radius, Color color, float timeout)
Draw a sphere with a radius and color at a position for a set amount of time. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called. More...
static void Direction (Vector3 position, float radius, Vector3 direction, Color color, float timeout)
Draw a ray with a radius and color at a position in a direction for a set amount of time. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called. More...
static void Line (Vector3 start, Vector3 end, Color color, float timeout)
Draw a line with a color at a position up to the end position for a set amount of time. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called. More...
static void BBox (Vector3 min, Vector3 max, Color color, float timeout)
Draw a box with a color for a set amount of time. The size and position can be defined by setting the min and max. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called. More...
static void BBox (AABB bbox, Color color, float timeout)
Draw a box with a color for a set amount of time. The size and position can be defined by setting it in the bbox. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called. More...
static void Text (Vector3 position, string text, float size, Color color, float timeout)
Draw text at a position in the world with a color and a size. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called. More...
static void Text (Vector2 screenPosition, string text, float size, Color color, float timeout)
Draw text at a position the screen with a color and a size. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called. More...
static void Clear ()
Clears all objects drawn with DebugDrawn. More...

Detailed Description

Helper class for drawing debug information.

Member Function Documentation

◆ BBox() [1/2]

static void CryEngine.Debugging.DebugDraw.BBox ( Vector3 min,
Vector3 max,
Color color,
float timeout
)
inline
static

Draw a box with a color for a set amount of time. The size and position can be defined by setting the min and max. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called.

Parameters
min
max
color
timeout

◆ BBox() [2/2]

static void CryEngine.Debugging.DebugDraw.BBox ( AABB bbox,
Color color,
float timeout
)
inline
static

Draw a box with a color for a set amount of time. The size and position can be defined by setting it in the bbox. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called.

Parameters
bbox
color
timeout

◆ Clear()

static void CryEngine.Debugging.DebugDraw.Clear ( )
inline
static

Clears all objects drawn with DebugDrawn.

◆ Direction()

static void CryEngine.Debugging.DebugDraw.Direction ( Vector3 position,
float radius,
Vector3 direction,
Color color,
float timeout
)
inline
static

Draw a ray with a radius and color at a position in a direction for a set amount of time. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called.

Parameters
position
radius

///

Parameters
direction
color
timeout

◆ Line()

static void CryEngine.Debugging.DebugDraw.Line ( Vector3 start,
Vector3 end,
Color color,
float timeout
)
inline
static

Draw a line with a color at a position up to the end position for a set amount of time. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called.

Parameters
start
end
color
timeout

◆ Sphere()

static void CryEngine.Debugging.DebugDraw.Sphere ( Vector3 position,
float radius,
Color color,
float timeout
)
inline
static

Draw a sphere with a radius and color at a position for a set amount of time. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called.

Parameters
position
radius
color
timeout

◆ Text() [1/2]

static void CryEngine.Debugging.DebugDraw.Text ( Vector3 position,
string text,
float size,
Color color,
float timeout
)
inline
static

Draw text at a position in the world with a color and a size. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called.

Parameters
position
text
size
color
timeout

◆ Text() [2/2]

static void CryEngine.Debugging.DebugDraw.Text ( Vector2 screenPosition,
string text,
float size,
Color color,
float timeout
)
inline
static

Draw text at a position the screen with a color and a size. If timeout is smaller or equal to 0, it will be drawn forever until Clear is called.

Parameters
screenPosition
text
size
color
timeout