KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SHAPE_SEGMENT Class Reference

#include <shape_segment.h>

Inheritance diagram for SHAPE_SEGMENT:
SHAPE SHAPE_BASE

Public Member Functions

 SHAPE_SEGMENT ()
 
 SHAPE_SEGMENT (const VECTOR2I &aA, const VECTOR2I &aB, int aWidth=0)
 
 SHAPE_SEGMENT (const SEG &aSeg, int aWidth=0)
 
 ~SHAPE_SEGMENT ()
 
SHAPEClone () const override
 Return a dynamically allocated copy of the shape.
 
const BOX2I BBox (int aClearance=0) const override
 Compute a bounding box of the shape, with a margin of aClearance a collision.
 
bool Collide (const SHAPE *aShape, int aClearance, VECTOR2I *aMTV) const override
 Check if the boundary of shape (this) lies closer to the shape aShape than aClearance, indicating a collision.
 
bool Collide (const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
 
bool Collide (const SEG &aSeg, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
 Check if the boundary of shape (this) lies closer to the segment aSeg than aClearance, indicating a collision.
 
bool Collide (const VECTOR2I &aP, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
 Check if the boundary of shape (this) lies closer to the point aP than aClearance, indicating a collision.
 
void SetSeg (const SEG &aSeg)
 
const SEGGetSeg () const
 
VECTOR2I GetStart () const override
 
VECTOR2I GetEnd () const override
 
void SetWidth (int aWidth) override
 
int GetWidth () const override
 
int GetTotalLength () const
 Get the total length of the segment, from tip to tip.
 
VECTOR2I GetCenter () const
 
EDA_ANGLE GetAngle () const
 
bool IsSolid () const override
 
void Rotate (const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
 
void Move (const VECTOR2I &aVector) override
 
bool Is45Degree (EDA_ANGLE aTollerance=EDA_ANGLE(1.0, DEGREES_T)) const
 
virtual const std::string Format (bool aCplusPlus=true) const override
 
void TransformToPolygon (SHAPE_POLY_SET &aBuffer, int aError, ERROR_LOC aErrorLoc) const override
 Fills a SHAPE_POLY_SET with a polygon representation of this shape.
 
int GetClearance (const SHAPE *aOther) const
 Return the actual minimum distance between two shapes.
 
bool IsNull () const
 Return true if the shape is a null shape.
 
virtual VECTOR2I Centre () const
 Compute a center-of-mass of the shape.
 
virtual int Distance (const VECTOR2I &aP) const
 Returns the minimum distance from a given point to this shape.
 
virtual SEG::ecoord SquaredDistance (const VECTOR2I &aP, bool aOutlineOnly=false) const
 
bool NearestPoints (const SHAPE *aOther, VECTOR2I &aPtThis, VECTOR2I &aPtOther) const
 Return the two points that mark the closest distance between this shape and aOther.
 
virtual bool PointInside (const VECTOR2I &aPt, int aAccuracy=0, bool aUseBBoxCache=false) const
 Check if point aP lies inside a closed shape.
 
virtual bool Parse (std::stringstream &aStream)
 
FACETNewFacet ()
 
SGNODECalcShape (SGNODE *aParent, SGNODE *aColor, WRL1_ORDER aVertexOrder, float aCreaseLimit=0.74317, bool isVRML2=false)
 
SHAPE_TYPE Type () const
 Return the type of the shape.
 
wxString TypeName () const
 
virtual bool HasIndexableSubshapes () const
 
virtual size_t GetIndexableSubshapeCount () const
 
virtual void GetIndexableSubshapes (std::vector< const SHAPE * > &aSubshapes) const
 

Static Public Member Functions

static SHAPE_SEGMENT BySizeAndCenter (const VECTOR2I &aSize, const VECTOR2I &aCenter, const EDA_ANGLE &aRotation)
 

Static Public Attributes

static const int MIN_PRECISION_IU = 4
 This is the minimum precision for all the points in a shape.
 

Protected Types

typedef VECTOR2I::extended_type ecoord
 

Protected Attributes

SHAPE_TYPE m_type
 < type of our shape
 

Private Attributes

SEG m_seg
 
int m_width
 
std::list< FACET * > facets
 

Detailed Description

Definition at line 37 of file shape_segment.h.

Member Typedef Documentation

◆ ecoord

typedef VECTOR2I::extended_type SHAPE::ecoord
protectedinherited

Definition at line 301 of file shape.h.

Constructor & Destructor Documentation

◆ SHAPE_SEGMENT() [1/3]

SHAPE_SEGMENT::SHAPE_SEGMENT ( )
inline

Definition at line 40 of file shape_segment.h.

References m_width, SH_SEGMENT, and SHAPE::SHAPE().

Referenced by BySizeAndCenter(), and Clone().

◆ SHAPE_SEGMENT() [2/3]

SHAPE_SEGMENT::SHAPE_SEGMENT ( const VECTOR2I & aA,
const VECTOR2I & aB,
int aWidth = 0 )
inline

Definition at line 45 of file shape_segment.h.

References m_seg, m_width, SH_SEGMENT, and SHAPE::SHAPE().

◆ SHAPE_SEGMENT() [3/3]

SHAPE_SEGMENT::SHAPE_SEGMENT ( const SEG & aSeg,
int aWidth = 0 )
inline

Definition at line 51 of file shape_segment.h.

References m_seg, m_width, SH_SEGMENT, and SHAPE::SHAPE().

◆ ~SHAPE_SEGMENT()

SHAPE_SEGMENT::~SHAPE_SEGMENT ( )
inline

Definition at line 59 of file shape_segment.h.

Member Function Documentation

◆ BBox()

const BOX2I SHAPE_SEGMENT::BBox ( int aClearance = 0) const
inlineoverridevirtual

Compute a bounding box of the shape, with a margin of aClearance a collision.

Parameters
aClearancehow much the bounding box is expanded wrs to the minimum enclosing rectangle for the shape.
Returns
the bounding box.

Implements SHAPE.

Definition at line 66 of file shape_segment.h.

References BOX2< Vec >::Inflate(), m_seg, and m_width.

◆ BySizeAndCenter()

SHAPE_SEGMENT SHAPE_SEGMENT::BySizeAndCenter ( const VECTOR2I & aSize,
const VECTOR2I & aCenter,
const EDA_ANGLE & aRotation )
static

◆ CalcShape()

◆ Centre()

virtual VECTOR2I SHAPE::Centre ( ) const
inlinevirtualinherited

Compute a center-of-mass of the shape.

Returns
the center-of-mass point

Definition at line 232 of file shape.h.

References BBox(), and BOX2< Vec >::Centre().

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), PNS::TOPOLOGY::AssembleDiffPair(), Collide(), and pickSegment().

◆ Clone()

SHAPE * SHAPE_SEGMENT::Clone ( ) const
inlineoverridevirtual

Return a dynamically allocated copy of the shape.

Return values
copyof the shape

Reimplemented from SHAPE.

Definition at line 61 of file shape_segment.h.

References m_seg, m_width, SHAPE::SHAPE(), and SHAPE_SEGMENT().

Referenced by PNS_KICAD_IFACE_BASE::syncPad().

◆ Collide() [1/4]

bool SHAPE_SEGMENT::Collide ( const SEG & aSeg,
int aClearance = 0,
int * aActual = nullptr,
VECTOR2I * aLocation = nullptr ) const
inlineoverridevirtual

Check if the boundary of shape (this) lies closer to the segment aSeg than aClearance, indicating a collision.

Parameters
aActual[out] an optional pointer to an int to be updated with the actual distance int the event of a collision.
aLocation[out] an option pointer to a point to store a nearby location in the event of a collision.
Returns
true, if there is a collision.

Implements SHAPE.

Definition at line 82 of file shape_segment.h.

References SEG::A, SEG::B, Collide(), m_seg, m_width, and SEG::Square().

◆ Collide() [2/4]

bool SHAPE_SEGMENT::Collide ( const SHAPE * aShape,
int aClearance,
VECTOR2I * aMTV ) const
inlineoverridevirtual

Check if the boundary of shape (this) lies closer to the shape aShape than aClearance, indicating a collision.

Parameters
aShapeshape to check collision against
aClearanceminimum clearance
aMTV[out] minimum translation vector
aActual[out] an optional pointer to an int to store the actual distance in the event of a collision.
aLocation[out] an option pointer to a point to store a nearby location in the event of a collision.
Returns
true, if there is a collision.

Reimplemented from SHAPE.

Definition at line 71 of file shape_segment.h.

References SHAPE::Collide(), and SHAPE::SHAPE().

Referenced by Collide(), Collide(), PAD::HitTest(), and PAD::HitTest().

◆ Collide() [3/4]

bool SHAPE_SEGMENT::Collide ( const SHAPE * aShape,
int aClearance = 0,
int * aActual = nullptr,
VECTOR2I * aLocation = nullptr ) const
inlineoverridevirtual

Reimplemented from SHAPE.

Definition at line 76 of file shape_segment.h.

References SHAPE::Collide(), and SHAPE::SHAPE().

◆ Collide() [4/4]

bool SHAPE_SEGMENT::Collide ( const VECTOR2I & aP,
int aClearance = 0,
int * aActual = nullptr,
VECTOR2I * aLocation = nullptr ) const
inlineoverridevirtual

Check if the boundary of shape (this) lies closer to the point aP than aClearance, indicating a collision.

Parameters
aActual[out] an optional pointer to an int to store the actual distance in the event of a collision.
aLocation[out] an option pointer to a point to store a nearby location in the event of a collision.
Returns
true, if there is a collision.

Reimplemented from SHAPE.

Definition at line 105 of file shape_segment.h.

References m_seg, m_width, and SEG::Square().

◆ Distance()

int SHAPE::Distance ( const VECTOR2I & aP) const
virtualinherited

Returns the minimum distance from a given point to this shape.

Always returns zero if the point is inside a closed shape and aOutlineOnly is false.

Parameters
aPis the point to test
Returns
the distance from the shape to aP

Reimplemented in SHAPE_COMPOUND, and SHAPE_LINE_CHAIN.

Definition at line 109 of file shape.cpp.

References SquaredDistance().

◆ Format()

const std::string SHAPE_SEGMENT::Format ( bool aCplusPlus = true) const
overridevirtual

Reimplemented from SHAPE.

Definition at line 57 of file shape_segment.cpp.

References SHAPE::Format(), m_seg, and m_width.

◆ GetAngle()

EDA_ANGLE SHAPE_SEGMENT::GetAngle ( ) const
inline

Definition at line 161 of file shape_segment.h.

References m_seg.

Referenced by KIGEOM::GetOvalKeyPoints().

◆ GetCenter()

VECTOR2I SHAPE_SEGMENT::GetCenter ( ) const
inline

Definition at line 156 of file shape_segment.h.

References m_seg.

Referenced by KIGEOM::GetOvalKeyPoints().

◆ GetClearance()

int SHAPE::GetClearance ( const SHAPE * aOther) const
inherited

Return the actual minimum distance between two shapes.

Return values
distancein IU

POLY_SETs contain a bunch of polygons that are triangulated. But there are way more triangles than necessary for collision detection. Triangles check three vertices each but for the outline, we only need one. These are also fractured, so we don't need to worry about holes

Definition at line 55 of file shape.cpp.

References SHAPE_POLY_SET::COutline(), SHAPE_BASE::GetIndexableSubshapeCount(), SHAPE_BASE::GetIndexableSubshapes(), SHAPE_POLY_SET::OutlineCount(), SH_POLY_SET, SHAPE(), and SHAPE_BASE::Type().

◆ GetEnd()

VECTOR2I SHAPE_SEGMENT::GetEnd ( ) const
inlineoverridevirtual

Reimplemented from SHAPE.

Definition at line 136 of file shape_segment.h.

References m_seg.

◆ GetIndexableSubshapeCount()

virtual size_t SHAPE_BASE::GetIndexableSubshapeCount ( ) const
inlinevirtualinherited

Reimplemented in SHAPE_COMPOUND, and SHAPE_POLY_SET.

Definition at line 113 of file shape.h.

Referenced by SHAPE::GetClearance().

◆ GetIndexableSubshapes()

virtual void SHAPE_BASE::GetIndexableSubshapes ( std::vector< const SHAPE * > & aSubshapes) const
inlinevirtualinherited

Reimplemented in SHAPE_COMPOUND, and SHAPE_POLY_SET.

Definition at line 115 of file shape.h.

Referenced by SHAPE_COMPOUND::AddShape(), and SHAPE::GetClearance().

◆ GetSeg()

◆ GetStart()

VECTOR2I SHAPE_SEGMENT::GetStart ( ) const
inlineoverridevirtual

Reimplemented from SHAPE.

Definition at line 135 of file shape_segment.h.

References m_seg.

◆ GetTotalLength()

int SHAPE_SEGMENT::GetTotalLength ( ) const
inline

Get the total length of the segment, from tip to tip.

Definition at line 151 of file shape_segment.h.

References m_seg, and m_width.

Referenced by KIGEOM::GetOvalKeyPoints().

◆ GetWidth()

◆ HasIndexableSubshapes()

virtual bool SHAPE_BASE::HasIndexableSubshapes ( ) const
inlinevirtualinherited

Reimplemented in SHAPE_COMPOUND, and SHAPE_POLY_SET.

Definition at line 108 of file shape.h.

◆ Is45Degree()

bool SHAPE_SEGMENT::Is45Degree ( EDA_ANGLE aTollerance = EDA_ANGLE( 1.0, DEGREES_T )) const

Definition at line 125 of file shape_segment.cpp.

References EDA_ANGLE::AsDegrees(), m_seg, and EDA_ANGLE::Normalize180().

◆ IsNull()

bool SHAPE::IsNull ( ) const
inlineinherited

Return true if the shape is a null shape.

Return values
trueif null :-)

Definition at line 166 of file shape.h.

References SHAPE_BASE::m_type, and SH_NULL.

◆ IsSolid()

bool SHAPE_SEGMENT::IsSolid ( ) const
inlineoverridevirtual

Implements SHAPE.

Definition at line 166 of file shape_segment.h.

◆ Move()

void SHAPE_SEGMENT::Move ( const VECTOR2I & aVector)
inlineoverridevirtual

Implements SHAPE.

Definition at line 177 of file shape_segment.h.

References m_seg.

◆ NearestPoints()

bool SHAPE::NearestPoints ( const SHAPE * aOther,
VECTOR2I & aPtThis,
VECTOR2I & aPtOther ) const
inherited

Return the two points that mark the closest distance between this shape and aOther.

Public interface for finding nearest points between two shapes.

If the shapes are overlapping, the points will be the same.

Parameters
aOtherthe other shape to compare with
aPtThis[out] the point on this shape closest to aOther
aPtOther[out] the point on aOther closest to this shape
Returns
true if the points were found
Parameters
aAfirst shape
aBsecond shape
aPtA[out] nearest point on first shape
aPtB[out] nearest point on second shape
Returns
true if nearest points were found, false otherwise

Definition at line 911 of file shape_nearest_points.cpp.

References nearestPoints(), and SHAPE().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ NewFacet()

FACET * SHAPE::NewFacet ( )
inherited

◆ Parse()

bool SHAPE::Parse ( std::stringstream & aStream)
virtualinherited

Reimplemented in SHAPE_LINE_CHAIN, and SHAPE_POLY_SET.

Definition at line 40 of file shape.cpp.

◆ PointInside()

bool SHAPE::PointInside ( const VECTOR2I & aPt,
int aAccuracy = 0,
bool aUseBBoxCache = false ) const
virtualinherited

Check if point aP lies inside a closed shape.

Always returns false if this shape is not closed.

Parameters
aPtpoint to check
aUseBBoxCachegives better performance if the bounding box caches have been generated.
Returns
true if the point is inside the shape (edge is not treated as being inside).

Reimplemented in SHAPE_LINE_CHAIN_BASE, and SHAPE_POLY_SET.

Definition at line 127 of file shape.cpp.

References SHAPE_POLY_SET::COutline(), ERROR_INSIDE, SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN_BASE::PointInside(), and TransformToPolygon().

◆ Rotate()

void SHAPE_SEGMENT::Rotate ( const EDA_ANGLE & aAngle,
const VECTOR2I & aCenter = { 0, 0 } )
inlineoverridevirtual
Parameters
aCenteris the rotation center.
aAnglerotation angle.

Implements SHAPE.

Definition at line 171 of file shape_segment.h.

◆ SetSeg()

void SHAPE_SEGMENT::SetSeg ( const SEG & aSeg)
inline

Definition at line 125 of file shape_segment.h.

References m_seg.

◆ SetWidth()

void SHAPE_SEGMENT::SetWidth ( int aWidth)
inlineoverridevirtual

Reimplemented from SHAPE.

Definition at line 138 of file shape_segment.h.

References m_width.

◆ SquaredDistance()

SEG::ecoord SHAPE::SquaredDistance ( const VECTOR2I & aP,
bool aOutlineOnly = false ) const
virtualinherited

◆ TransformToPolygon()

void SHAPE_SEGMENT::TransformToPolygon ( SHAPE_POLY_SET & aBuffer,
int aError,
ERROR_LOC aErrorLoc ) const
overridevirtual

Fills a SHAPE_POLY_SET with a polygon representation of this shape.

Parameters
aBuffer[out] will be filled with the polygonal representation of this shape.
aErrorcontrols the maximum allowed deviation when converting rounded shapes to segments
aErrorLoccontrols where the error is placed when approximating rounded shapes

Implements SHAPE.

Definition at line 141 of file shape_segment.cpp.

References m_seg, m_width, and TransformOvalToPolygon().

Referenced by EXPORTER_STEP::buildGraphic3DShape(), FABMASTER::createBoardItems(), and BOARD_ADAPTER::createLayers().

◆ Type()

◆ TypeName()

wxString SHAPE_BASE::TypeName ( ) const
inlineinherited

Definition at line 103 of file shape.h.

References m_type, and SHAPE_TYPE_asString().

Referenced by Collide(), Collide(), Collide(), Collide(), Collide(), Collide(), Collide(), and Collide().

Member Data Documentation

◆ facets

std::list< FACET* > SHAPE::facets
privateinherited

Definition at line 143 of file wrlfacet.h.

Referenced by CalcShape(), and NewFacet().

◆ m_seg

◆ m_type

SHAPE_TYPE SHAPE_BASE::m_type
protectedinherited

< type of our shape

Definition at line 119 of file shape.h.

Referenced by SHAPE::Format(), SHAPE::IsNull(), SHAPE_BASE(), Type(), and TypeName().

◆ m_width

int SHAPE_SEGMENT::m_width
private

◆ MIN_PRECISION_IU

const int SHAPE::MIN_PRECISION_IU = 4
staticinherited

This is the minimum precision for all the points in a shape.

Definition at line 131 of file shape.h.

Referenced by DIRECTION_45::BuildInitialTrace(), CompareLength(), CIRCLE::Contains(), EDIT_TOOL::FilletTracks(), CIRCLE::IntersectLine(), and LINE_FILLET_ROUTINE::ProcessLinePair().


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