Debug Draw 3D (and 2D) 1.5.0
Draw 3D debug graphics and 2D overlays with this add-on.
Loading...
Searching...
No Matches
DebugDraw3DConfig Class Reference

This is a class for storing part of the DebugDraw3D configuration. More...

#include <config_3d.h>

Inheritance diagram for DebugDraw3DConfig:

Public Member Functions

void set_freeze_3d_render (const bool &_state)
 
bool is_freeze_3d_render () const
 
void set_visible_instance_bounds (const bool &_state)
 
bool is_visible_instance_bounds () const
 
void set_use_frustum_culling (const bool &_state)
 
bool is_use_frustum_culling () const
 
void set_frustum_length_scale (const real_t &_distance)
 
real_t get_frustum_length_scale () const
 
void set_force_use_camera_from_scene (const bool &_state)
 
bool is_force_use_camera_from_scene () const
 
void set_geometry_render_layers (const int32_t &_layers)
 
int32_t get_geometry_render_layers () const
 
void set_line_hit_color (const Color &_new_color)
 
Color get_line_hit_color () const
 
void set_line_after_hit_color (const Color &_new_color)
 
Color get_line_after_hit_color () const
 

Detailed Description

This is a class for storing part of the DebugDraw3D configuration.

You can use DebugDraw3D.get_config to get the current instance of the configuration.

Member Function Documentation

◆ set_freeze_3d_render()

void DebugDraw3DConfig::set_freeze_3d_render ( const bool & _state)

Set whether debug 3D graphics rendering is frozen. This means that previously created geometry will not be updated until set to false or until DebugDraw3D.clear_all is called.

◆ set_visible_instance_bounds()

void DebugDraw3DConfig::set_visible_instance_bounds ( const bool & _state)

Set whether the boundaries of instances are displayed. Based on these boundaries, instances are culled if set_use_frustum_culling is activated.

◆ set_use_frustum_culling()

void DebugDraw3DConfig::set_use_frustum_culling ( const bool & _state)

Set whether frustum culling is used.

Note
Enabling or disabling this option does not affect the rough culling based on the camera's AABB of frustum. This option enables more accurate culling based on the camera's frustum planes.

◆ set_frustum_length_scale()

void DebugDraw3DConfig::set_frustum_length_scale ( const real_t & _distance)

Change the distance between the Far and Near Planes of the Viewport's Camera3D.

◆ set_force_use_camera_from_scene()

void DebugDraw3DConfig::set_force_use_camera_from_scene ( const bool & _state)

Set the forced use of the scene camera instead of the editor camera.

◆ set_geometry_render_layers()

void DebugDraw3DConfig::set_geometry_render_layers ( const int32_t & _layers)

Set the visibility layer on which the 3D geometry will be drawn. Similar to using VisualInstance3D.layers.

◆ set_line_hit_color()

void DebugDraw3DConfig::set_line_hit_color ( const Color & _new_color)

Set the default color for the collision point of DebugDraw3D.draw_line_hit.

◆ set_line_after_hit_color()

void DebugDraw3DConfig::set_line_after_hit_color ( const Color & _new_color)

Set the default color for the line after the collision point of DebugDraw3D.draw_line_hit.


The documentation for this class was generated from the following file: