KiCad PCB EDA Suite
arc_assistant.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2017 Kicad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
25 
28 
30 #include <view/view.h>
31 
32 #include <common.h>
33 #include <base_units.h>
34 
35 using namespace KIGFX::PREVIEW;
36 
38  : EDA_ITEM( NOT_USED ), m_constructMan( aManager ), m_units( aUnits )
39 {
40 }
41 
42 
44 {
45  BOX2I tmp;
46 
47  // no bounding box when no graphic shown
48  if( m_constructMan.IsReset() )
49  return tmp;
50 
51  // just enclose the whle circular area
52  auto origin = m_constructMan.GetOrigin();
53  auto radius = m_constructMan.GetRadius();
54  VECTOR2D rVec( radius, radius );
55 
56  tmp.SetOrigin( origin + rVec );
57  tmp.SetEnd( origin - rVec );
58  tmp.Normalize();
59  return tmp;
60 }
61 
62 
69 double getNormDeciDegFromRad( double aRadians )
70 {
71  double degs = RAD2DECIDEG( aRadians );
72 
73  // normalise to +/- 360
74  while( degs < -3600.0 )
75  degs += 3600.0;
76 
77  while( degs > 3600.0 )
78  degs -= 3600.0;
79 
80  return degs;
81 }
82 
83 
84 void ARC_ASSISTANT::ViewDraw( int aLayer, KIGFX::VIEW* aView ) const
85 {
86  auto& gal = *aView->GetGAL();
87 
88  // not in a position to draw anything
89  if( m_constructMan.IsReset() )
90  return;
91 
92  gal.ResetTextAttributes();
93 
94  // constant text size on screen
95  SetConstantGlyphHeight( gal, 12.0 );
96 
97  // angle reference arc size
98  const double innerRad = 12.0 / gal.GetWorldScale();
99 
100  const auto origin = m_constructMan.GetOrigin();
101 
102  KIGFX::PREVIEW::DRAW_CONTEXT preview_ctx( *aView );
103 
104  // draw first radius line
105  bool dimFirstLine = m_constructMan.GetStep() > ARC_GEOM_MANAGER::SET_START;
106 
107  preview_ctx.DrawLineWithAngleHighlight(
108  origin, m_constructMan.GetStartRadiusEnd(), dimFirstLine );
109 
110  std::vector<wxString> cursorStrings;
111 
113  {
114  // haven't started the angle selection phase yet
115 
116  double initAngle = m_constructMan.GetStartAngle();
117 
118  const auto angleRefLineEnd = m_constructMan.GetOrigin() + VECTOR2D( innerRad * 1.5, 0.0 );
119 
120  // draw the short reference baseline
121  preview_ctx.DrawLine( origin, angleRefLineEnd, false );
122 
123  // draw the angle reference arc
124  preview_ctx.DrawArcWithAngleHighlight( origin, innerRad, initAngle, 0.0 );
125 
126  // draw the radius guide circle
127  preview_ctx.DrawCircle( origin, m_constructMan.GetRadius(), true );
128 
129  double degs = getNormDeciDegFromRad( initAngle );
130 
131  cursorStrings.push_back( DimensionLabel( "r", m_constructMan.GetRadius(), m_units ) );
132  cursorStrings.push_back(
133  DimensionLabel( wxString::FromUTF8( "θ" ), degs, EDA_UNITS::DEGREES ) );
134  }
135  else
136  {
137  preview_ctx.DrawLineWithAngleHighlight( origin, m_constructMan.GetEndRadiusEnd(), false );
138 
139  auto start = m_constructMan.GetStartAngle();
140  auto subtended = m_constructMan.GetSubtended();
141 
142  preview_ctx.DrawArcWithAngleHighlight( origin, innerRad, start, start + subtended );
143 
144  double subtendedDeg = getNormDeciDegFromRad( subtended );
145  double endAngleDeg = getNormDeciDegFromRad( start + subtended );
146 
147  // draw dimmed extender line to cursor
148  preview_ctx.DrawLineWithAngleHighlight( origin, m_constructMan.GetLastPoint(), true );
149 
150  cursorStrings.push_back(
151  DimensionLabel( wxString::FromUTF8( "Δθ" ), subtendedDeg, EDA_UNITS::DEGREES ) );
152  cursorStrings.push_back(
153  DimensionLabel( wxString::FromUTF8( "θ" ), endAngleDeg, EDA_UNITS::DEGREES ) );
154  }
155 
156  // place the text next to cursor, on opposite side from radius
158  origin - m_constructMan.GetLastPoint(),
159  cursorStrings );
160 }
EDA_UNITS
Definition: common.h:198
void ViewDraw(int aLayer, KIGFX::VIEW *aView) const override final
Draw the assistance (with reference to the contstruction manager.
ARC_ASSISTANT(const ARC_GEOM_MANAGER &aManager, EDA_UNITS aUnits)
VECTOR2I GetEndRadiusEnd() const
Get the coordinates of the arc end point
wxString DimensionLabel(const wxString &prefix, double aVal, EDA_UNITS aUnits)
Get a formatted string showing a dimension to a sane precision with an optional prefix and unit suffi...
Implementation of conversion functions that require both schematic and board internal units.
the 3d code uses this value
Definition: typeinfo.h:80
double RAD2DECIDEG(double rad)
Definition: trigo.h:219
GAL * GetGAL() const
Function GetGAL() Returns the GAL this view is using to draw graphical primitives.
Definition: view.h:180
VECTOR2I GetStartRadiusEnd() const
Get the coordinates of the arc start
const ARC_GEOM_MANAGER & m_constructMan
Definition: arc_assistant.h:68
double GetStartAngle() const
Get the angle of the vector leading to the start point (valid if step >= SET_START)
double GetSubtended() const
Get the angle of the vector leading to the end point (valid if step >= SET_ANGLE)
void DrawLineWithAngleHighlight(const VECTOR2I &aStart, const VECTOR2I &aEnd, bool aDeEmphasised)
Draw a straight line on the current layer, with a special highlight when the line angle is a multiple...
void DrawLine(const VECTOR2I &aStart, const VECTOR2I &aEnd, bool aDeEmphasised)
Draw a simple line on the current layer.
void ResetTextAttributes()
Reset text attributes to default styling.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
Waiting to lock in origin point
VECTOR2I GetOrigin() const
Get the centre point of the arc (valid when state > SET_ORIGIN)
BOX2< Vec > & Normalize()
Function Normalize ensures that the height ant width are positive.
Definition: box2.h:129
double GetRadius() const
Get the radius of the arc (valid if step >= SET_START)
void DrawTextNextToCursor(KIGFX::VIEW *aView, const VECTOR2D &aCursorPos, const VECTOR2D &aTextQuadrant, const std::vector< wxString > &aStrings)
Draw strings next to the cursor.
void DrawCircle(const VECTOR2I &aOrigin, double aRad, bool aDeEmphasised)
Draw a preview circle on the current layer.
A KIGFX::PREVIEW::DRAW_CONTEXT is a wrapper around a GAL and some other settings that makes it easy t...
Definition: draw_context.h:44
void SetEnd(coord_type x, coord_type y)
Definition: box2.h:225
VECTOR2I GetLastPoint() const
Gets the last point added (locked in or not).
const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
double getNormDeciDegFromRad(double aRadians)
Get deci-degrees from radians, normalised to +/- 360.
ARC_STEPS GetStep() const
Get the current step the mananger is on (useful when drawing something depends on the current state)
void SetConstantGlyphHeight(KIGFX::GAL &aGal, double aHeight)
Set the GAL glyph height to a constant scaled value, so that it always looks the same on screen.
void SetOrigin(const Vec &pos)
Definition: box2.h:210
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:159
The common library.
VIEW.
Definition: view.h:61
void DrawArcWithAngleHighlight(const VECTOR2I &aOrigin, double aRad, double aStartAngle, double aEndAngle)
Draw an arc on the current layer, with a special highlight when the line angle is a multiple of 45 de...