KiCad PCB EDA Suite
Classes | Public Member Functions | Private Attributes | List of all members
PNS::DEBUG_DECORATOR Class Reference

#include <pns_debug_decorator.h>

Inheritance diagram for PNS::DEBUG_DECORATOR:
PNS_PCBNEW_DEBUG_DECORATOR PNS_TEST_DEBUG_DECORATOR

Classes

struct  SRC_LOCATION_INFO
 

Public Member Functions

 DEBUG_DECORATOR ()
 
virtual ~DEBUG_DECORATOR ()
 
void SetDebugEnabled (bool aEnabled)
 
bool IsDebugEnabled () const
 
virtual void SetIteration (int iter)
 
virtual void Message (const wxString &msg, const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void NewStage (const wxString &name, int iter, const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void BeginGroup (const wxString &name, int aLevel=0, const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void EndGroup (const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void AddPoint (const VECTOR2I &aP, const KIGFX::COLOR4D &aColor, int aSize, const wxString &aName=wxT(""), const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void AddItem (const ITEM *aItem, const KIGFX::COLOR4D &aColor, int aOverrideWidth=0, const wxString &aName=wxT(""), const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void AddShape (const SHAPE *aShape, const KIGFX::COLOR4D &aColor, int aOverrideWidth=0, const wxString &aName=wxT(""), const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void AddShape (const BOX2I &aBox, const KIGFX::COLOR4D &aColor, int aOverrideWidth=0, const wxString &aName=wxT(""), const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
void AddShape (const SEG &aSeg, const KIGFX::COLOR4D &aColor, int aOverrideWidth=0, const wxString &aName=wxT(""), const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
 
virtual void Clear ()
 

Private Attributes

bool m_debugEnabled
 

Detailed Description

Definition at line 37 of file pns_debug_decorator.h.

Constructor & Destructor Documentation

◆ DEBUG_DECORATOR()

PNS::DEBUG_DECORATOR::DEBUG_DECORATOR ( )
inline

Definition at line 40 of file pns_debug_decorator.h.

40: m_debugEnabled( false ) {}
PNS::DEBUG_DECORATOR::m_debugEnabled
bool m_debugEnabled
Definition: pns_debug_decorator.h:112

◆ ~DEBUG_DECORATOR()

virtual PNS::DEBUG_DECORATOR::~DEBUG_DECORATOR ( )
inlinevirtual

Definition at line 57 of file pns_debug_decorator.h.

57{}

Member Function Documentation

◆ AddItem()

virtual void PNS::DEBUG_DECORATOR::AddItem ( const ITEM *  aItem,
const KIGFX::COLOR4D &  aColor,
int  aOverrideWidth = 0,
const wxString &  aName = wxT( "" ),
const SRC_LOCATION_INFO &  aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_PCBNEW_DEBUG_DECORATOR, and PNS_TEST_DEBUG_DECORATOR.

Definition at line 79 of file pns_debug_decorator.h.

82 {};

◆ AddPoint()

virtual void PNS::DEBUG_DECORATOR::AddPoint ( const VECTOR2I &  aP,
const KIGFX::COLOR4D &  aColor,
int  aSize,
const wxString &  aName = wxT( "" ),
const SRC_LOCATION_INFO &  aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_PCBNEW_DEBUG_DECORATOR, and PNS_TEST_DEBUG_DECORATOR.

Definition at line 75 of file pns_debug_decorator.h.

77 {};

◆ AddShape() [1/3]

virtual void PNS::DEBUG_DECORATOR::AddShape ( const BOX2I &  aBox,
const KIGFX::COLOR4D &  aColor,
int  aOverrideWidth = 0,
const wxString &  aName = wxT( "" ),
const SRC_LOCATION_INFO &  aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_PCBNEW_DEBUG_DECORATOR.

Definition at line 89 of file pns_debug_decorator.h.

92 {
93 SHAPE_RECT r( aBox );
94 AddShape( &r, aColor, aOverrideWidth, aName, aSrcLoc );
95 }
PNS::DEBUG_DECORATOR::AddShape
virtual void AddShape(const SHAPE *aShape, const KIGFX::COLOR4D &aColor, int aOverrideWidth=0, const wxString &aName=wxT(""), const SRC_LOCATION_INFO &aSrcLoc=SRC_LOCATION_INFO())
Definition: pns_debug_decorator.h:84
SHAPE_RECT
Definition: shape_rect.h:38

References AddShape().

◆ AddShape() [2/3]

void PNS::DEBUG_DECORATOR::AddShape ( const SEG &  aSeg,
const KIGFX::COLOR4D &  aColor,
int  aOverrideWidth = 0,
const wxString &  aName = wxT( "" ),
const SRC_LOCATION_INFO &  aSrcLoc = SRC_LOCATION_INFO() 
)
inline

Definition at line 97 of file pns_debug_decorator.h.

101 {
102 SHAPE_LINE_CHAIN lc;
103 lc.Append( aSeg.A );
104 lc.Append( aSeg.B );
105 AddShape( &lc, aColor, aOverrideWidth, aName, aSrcLoc );
106 }
SEG::A
VECTOR2I A
Definition: seg.h:49
SEG::B
VECTOR2I B
Definition: seg.h:50
SHAPE_LINE_CHAIN
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
Definition: shape_line_chain.h:82
SHAPE_LINE_CHAIN::Append
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
Definition: shape_line_chain.h:497

References SEG::A, AddShape(), SHAPE_LINE_CHAIN::Append(), and SEG::B.

◆ AddShape() [3/3]

virtual void PNS::DEBUG_DECORATOR::AddShape ( const SHAPE *  aShape,
const KIGFX::COLOR4D &  aColor,
int  aOverrideWidth = 0,
const wxString &  aName = wxT( "" ),
const SRC_LOCATION_INFO &  aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_PCBNEW_DEBUG_DECORATOR, and PNS_TEST_DEBUG_DECORATOR.

Definition at line 84 of file pns_debug_decorator.h.

87 {};

Referenced by AddShape().

◆ BeginGroup()

virtual void PNS::DEBUG_DECORATOR::BeginGroup ( const wxString &  name,
int  aLevel = 0,
const SRC_LOCATION_INFO &  aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_TEST_DEBUG_DECORATOR.

Definition at line 70 of file pns_debug_decorator.h.

71 {};

◆ Clear()

virtual void PNS::DEBUG_DECORATOR::Clear ( )
inlinevirtual

Reimplemented in PNS_PCBNEW_DEBUG_DECORATOR, and PNS_TEST_DEBUG_DECORATOR.

Definition at line 108 of file pns_debug_decorator.h.

108{};

Referenced by PNS_KICAD_IFACE::EraseView().

◆ EndGroup()

virtual void PNS::DEBUG_DECORATOR::EndGroup ( const SRC_LOCATION_INFO &  aSrcLoc = SRC_LOCATION_INFO())
inlinevirtual

Reimplemented in PNS_TEST_DEBUG_DECORATOR.

Definition at line 73 of file pns_debug_decorator.h.

73{};

◆ IsDebugEnabled()

bool PNS::DEBUG_DECORATOR::IsDebugEnabled ( ) const
inline

Definition at line 60 of file pns_debug_decorator.h.

60{ return m_debugEnabled; }

References m_debugEnabled.

◆ Message()

virtual void PNS::DEBUG_DECORATOR::Message ( const wxString &  msg,
const SRC_LOCATION_INFO &  aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_TEST_DEBUG_DECORATOR.

Definition at line 64 of file pns_debug_decorator.h.

65 {};

◆ NewStage()

virtual void PNS::DEBUG_DECORATOR::NewStage ( const wxString &  name,
int  iter,
const SRC_LOCATION_INFO &  aSrcLoc = SRC_LOCATION_INFO() 
)
inlinevirtual

Reimplemented in PNS_TEST_DEBUG_DECORATOR.

Definition at line 67 of file pns_debug_decorator.h.

68 {};

◆ SetDebugEnabled()

void PNS::DEBUG_DECORATOR::SetDebugEnabled ( bool  aEnabled)
inline

Definition at line 59 of file pns_debug_decorator.h.

59{ m_debugEnabled = aEnabled;}

References m_debugEnabled.

Referenced by PNS_TEST_DEBUG_DECORATOR::PNS_TEST_DEBUG_DECORATOR(), and PNS_KICAD_IFACE::SetView().

◆ SetIteration()

virtual void PNS::DEBUG_DECORATOR::SetIteration ( int  iter)
inlinevirtual

Reimplemented in PNS_TEST_DEBUG_DECORATOR.

Definition at line 62 of file pns_debug_decorator.h.

62{};

Referenced by PNS::SHOVE::shoveIteration().

Member Data Documentation

◆ m_debugEnabled

bool PNS::DEBUG_DECORATOR::m_debugEnabled
private

Definition at line 112 of file pns_debug_decorator.h.

Referenced by IsDebugEnabled(), and SetDebugEnabled().

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