stim::debug_draw_interface struct

Interface for drawing poly-lines for debugging purposes.

Image
Example debug_draw_interface output.

Public functions

auto can_draw(const bounding_box& box) const -> bool pure virtual noexcept
Queries whether a given bounding box can be drawn (in view, internal state OK, etc.)
void draw_line(const vec3& from, const vec3& to) pure virtual noexcept
Draws a single line segment.
void draw_poly_line(const_span<vec3> points) pure virtual noexcept
Draws a poly-line.
void set_colour(uint32_t abgr) pure virtual noexcept
Sets the current draw colour.

Function documentation

bool stim::debug_draw_interface::can_draw(const bounding_box& box) const pure virtual noexcept

Queries whether a given bounding box can be drawn (in view, internal state OK, etc.)

void stim::debug_draw_interface::draw_line(const vec3& from, const vec3& to) pure virtual noexcept

Draws a single line segment.

Parameters
from The line's start position.
to The line's end position.

void stim::debug_draw_interface::draw_poly_line(const_span<vec3> points) pure virtual noexcept

Draws a poly-line.

Parameters
points The points in the poly-line

void stim::debug_draw_interface::set_colour(uint32_t abgr) pure virtual noexcept

Sets the current draw colour.

Parameters
abgr The colour to set.