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

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

#include <config_2d.h>

Inheritance diagram for DebugDraw2DConfig:

Public Types

enum  BlockPosition : int {
  POSITION_LEFT_TOP = 0 ,
  POSITION_RIGHT_TOP = 1 ,
  POSITION_LEFT_BOTTOM = 2 ,
  POSITION_RIGHT_BOTTOM = 3
}
 

Public Member Functions

void set_graphs_base_offset (const Vector2i &_offset)
 
Vector2i get_graphs_base_offset () const
 
void set_text_block_position (BlockPosition _position)
 
BlockPosition get_text_block_position () const
 
void set_text_block_offset (const Vector2i &_offset)
 
Vector2i get_text_block_offset () const
 
void set_text_padding (const Vector2i &_padding)
 
Vector2i get_text_padding () const
 
void set_text_default_duration (const real_t &_duration)
 
real_t get_text_default_duration () const
 
void set_text_default_size (const int &_size)
 
int get_text_default_size () const
 
void set_text_foreground_color (const Color &_new_color)
 
Color get_text_foreground_color () const
 
void set_text_background_color (const Color &_new_color)
 
Color get_text_background_color () const
 
void set_text_custom_font (const Ref< Font > &_custom_font)
 
Ref< Font > get_text_custom_font () const
 

Detailed Description

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

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

Member Enumeration Documentation

◆ BlockPosition

Available positions for placing text blocks.

Member Function Documentation

◆ set_graphs_base_offset()

void DebugDraw2DConfig::set_graphs_base_offset ( const Vector2i & _offset)

Base offset for all graphs

◆ set_text_block_position()

void DebugDraw2DConfig::set_text_block_position ( BlockPosition _position)

Position of the text block

◆ set_text_block_offset()

void DebugDraw2DConfig::set_text_block_offset ( const Vector2i & _offset)

Offset from the corner selected in 'set_text_block_position'

◆ set_text_padding()

void DebugDraw2DConfig::set_text_padding ( const Vector2i & _padding)

Text padding for each line

◆ set_text_default_duration()

void DebugDraw2DConfig::set_text_default_duration ( const real_t & _duration)

How long the text remains visible after creation.

◆ set_text_default_size()

void DebugDraw2DConfig::set_text_default_size ( const int & _size)

Default text size

◆ set_text_foreground_color()

void DebugDraw2DConfig::set_text_foreground_color ( const Color & _new_color)

Default color of the text

◆ set_text_background_color()

void DebugDraw2DConfig::set_text_background_color ( const Color & _new_color)

Background color of the text

◆ set_text_custom_font()

void DebugDraw2DConfig::set_text_custom_font ( const Ref< Font > & _custom_font)

Custom text Font


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