SHAPE_SIMPLE Class Reference

Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments. More...

#include <shape_simple.h>

Inheritance diagram for SHAPE_SIMPLE:

Public Member Functions
	SHAPE_SIMPLE ()
	Create an empty polygon. More...
	SHAPE_SIMPLE (const SHAPE_LINE_CHAIN &aPoly)
	SHAPE_SIMPLE (const SHAPE_SIMPLE &aOther)
SHAPE *	Clone () const override
	Return a dynamically allocated copy of the shape. More...
void	Clear ()
	Remove all points from the polygon. More...
const BOX2I	BBox (int aClearance=0) const override
	Compute a bounding box of the shape, with a margin of aClearance a collision. More...
int	PointCount () const
	Return the number of points (vertices) in this polygon. More...
const VECTOR2I &	CPoint (int aIndex) const
	Return a const reference to a given point in the polygon. More...
const VECTOR2D	CDPoint (int aIndex) const
	Return a given point as a vector with elements of type double. More...
const SHAPE_LINE_CHAIN &	Vertices () const
	Return the list of vertices defining this simple polygon. More...
void	Append (int aX, int aY)
	Append a new point at the end of the polygon. More...
void	Append (const VECTOR2I &aP)
	Append a new point at the end of the polygon. More...
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 point aP than aClearance, indicating a collision. More...
void	Rotate (double aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
void	Move (const VECTOR2I &aVector) override
bool	IsSolid () const override
virtual const VECTOR2I	GetPoint (int aIndex) const override
virtual const SEG	GetSegment (int aIndex) const override
virtual size_t	GetPointCount () const override
virtual size_t	GetSegmentCount () const override
bool	IsClosed () const override
virtual bool	Collide (const VECTOR2I &aP, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
	Check if point aP lies closer to us than aClearance. More...
virtual bool	Collide (const SHAPE *aShape, int aClearance, VECTOR2I *aMTV) const
	Check if the boundary of shape (this) lies closer to the shape aShape than aClearance, indicating a collision. More...
virtual bool	Collide (const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const
SEG::ecoord	SquaredDistance (const VECTOR2I &aP, bool aOutlineOnly=false) const
bool	PointInside (const VECTOR2I &aPt, int aAccuracy=0, bool aUseBBoxCache=false) const
	Check if point aP lies inside a polygon (any type) defined by the line chain. More...
bool	PointOnEdge (const VECTOR2I &aP, int aAccuracy=0) const
	Check if point aP lies on an edge or vertex of the line chain. More...
int	EdgeContainingPoint (const VECTOR2I &aP, int aAccuracy=0) const
	Check if point aP lies on an edge or vertex of the line chain. More...
virtual BOX2I *	GetCachedBBox () const
bool	IsNull () const
	Return true if the shape is a null shape. More...
virtual VECTOR2I	Centre () const
	Compute a center-of-mass of the shape. More...
virtual bool	Parse (std::stringstream &aStream)
virtual const std::string	Format () const
FACET *	NewFacet ()
SGNODE *	CalcShape (SGNODE *aParent, SGNODE *aColor, WRL1_ORDER aVertexOrder, float aCreaseLimit=0.74317, bool isVRML2=false)
SHAPE_TYPE	Type () const
	Return the type of the shape. More...
virtual bool	HasIndexableSubshapes () const
virtual size_t	GetIndexableSubshapeCount () const
virtual void	GetIndexableSubshapes (std::vector< SHAPE * > &aSubshapes)

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

Protected Types
typedef VECTOR2I::extended_type	ecoord

Protected Attributes
SHAPE_TYPE	m_type
	< type of our shape More...

Private Attributes
SHAPE_LINE_CHAIN	m_points

Detailed Description

Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments.

Internally the vertices are held in a SHAPE_LINE_CHAIN, please note that there is a "virtual" line segment between the last and first vertex.

Definition at line 41 of file shape_simple.h.

Member Typedef Documentation

ecoord

typedef VECTOR2I::extended_type SHAPE::ecoord

protectedinherited

Definition at line 236 of file shape.h.

Constructor & Destructor Documentation

SHAPE_SIMPLE() [1/3]

SHAPE_SIMPLE::SHAPE_SIMPLE ( )

inline

Create an empty polygon.

Definition at line 47 of file shape_simple.h.

 :
 SHAPE_LINE_CHAIN_BASE( SH_SIMPLE )
 {
 m_points.SetClosed( true );
 }

References m_points, and SHAPE_LINE_CHAIN::SetClosed().

Referenced by Clone().

SHAPE_SIMPLE() [2/3]

SHAPE_SIMPLE::SHAPE_SIMPLE ( const SHAPE_LINE_CHAIN &  aPoly )

inline

Definition at line 53 of file shape_simple.h.

 :
 SHAPE_LINE_CHAIN_BASE( SH_SIMPLE ),
 m_points( aPoly )
 {
 m_points.SetClosed( true );
 }

References m_points, and SHAPE_LINE_CHAIN::SetClosed().

SHAPE_SIMPLE() [3/3]

SHAPE_SIMPLE::SHAPE_SIMPLE ( const SHAPE_SIMPLE &  aOther )

inline

Definition at line 60 of file shape_simple.h.

 :
 SHAPE_LINE_CHAIN_BASE( SH_SIMPLE ), m_points( aOther.m_points )
 {}

Member Function Documentation

Append() [1/2]

void SHAPE_SIMPLE::Append ( int  aX, int  aY  )

inline

Append a new point at the end of the polygon.

Parameters

aX	is X coordinate of the new point.
aY	is Y coordinate of the new point.

Definition at line 135 of file shape_simple.h.

 {
 VECTOR2I v( aX, aY );
 Append( v );
 }

Referenced by PNS_KICAD_IFACE_BASE::syncZone().

Append() [2/2]

void SHAPE_SIMPLE::Append ( const VECTOR2I &  aP )

inline

Append a new point at the end of the polygon.

Parameters

aP	is the new point.

Definition at line 146 of file shape_simple.h.

 {
 m_points.Append( aP );
 }

References SHAPE_LINE_CHAIN::Append(), and m_points.

BBox()

const BOX2I SHAPE_SIMPLE::BBox ( int  aClearance = 0 ) const

inlineoverridevirtual

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

Parameters

aClearance

how much the bounding box is expanded wrs to the minimum enclosing rectangle for the shape.

Returns

the bounding box.

Implements SHAPE.

Definition at line 78 of file shape_simple.h.

 {
 return m_points.BBox( aClearance );
 }

References SHAPE_LINE_CHAIN::BBox(), and m_points.

Referenced by PNS::ConvexHull(), and PNS::OPTIMIZER::customBreakouts().

CalcShape()

SGNODE * SHAPE::CalcShape ( SGNODE *  aParent, SGNODE *  aColor, WRL1_ORDER  aVertexOrder, float  aCreaseLimit = 0.74317, bool  isVRML2 = false  )

inherited

Definition at line 703 of file wrlfacet.cpp.

{
 if( facets.empty() || !facets.front()->HasMinPoints() )
 return nullptr;

 std::vector< std::list< FACET* > > flist;

 // determine the max. index and size flist as appropriate
 std::list< FACET* >::iterator sF = facets.begin();
 std::list< FACET* >::iterator eF = facets.end();

 int maxIdx = 0;
 int tmi;
 float maxV = 0.0;
 float tV = 0.0;

 while( sF != eF )
 {
 tV = ( *sF )->CalcFaceNormal();
 tmi = ( *sF )->GetMaxIndex();

 if( tmi > maxIdx )
 maxIdx = tmi;

 if( tV > maxV )
 maxV = tV;

 ++sF;
 }

 ++maxIdx;

 if( maxIdx < 3 )
 return nullptr;

 flist.resize( maxIdx );

 // create the lists of facets common to indices
 sF = facets.begin();

 while( sF != eF )
 {
 ( *sF )->Renormalize( tV );
 ( *sF )->CollectVertices( flist );
 ++sF;
 }

 // calculate the normals
 size_t vs = flist.size();

 for( size_t i = 0; i < vs; ++i )
 {
 sF = flist[i].begin();
 eF = flist[i].end();

 while( sF != eF )
 {
 ( *sF )->CalcVertexNormal( static_cast<int>( i ), flist[i], aCreaseLimit );
 ++sF;
 }
 }

 std::vector< WRLVEC3F > vertices;
 std::vector< WRLVEC3F > normals;
 std::vector< SGCOLOR > colors;

 // push the facet data to the final output list
 sF = facets.begin();
 eF = facets.end();

 while( sF != eF )
 {
 ( *sF )->GetData( vertices, normals, colors, aVertexOrder );
 ++sF;
 }

 flist.clear();

 if( vertices.size() < 3 )
 return nullptr;

 IFSG_SHAPE shapeNode( false );

 if( !isVRML2 )
 {
 shapeNode.NewNode( aParent );

 if( aColor )
 {
 if( nullptr == S3D::GetSGNodeParent( aColor ) )
 shapeNode.AddChildNode( aColor );
 else
 shapeNode.AddRefNode( aColor );
 }
 }

 std::vector< SGPOINT > lCPts; // vertex points in SGPOINT (double) format
 std::vector< SGVECTOR > lCNorm; // per-vertex normals
 vs = vertices.size();

 for( size_t i = 0; i < vs; ++i )
 {
 SGPOINT pt;
 pt.x = vertices[i].x;
 pt.y = vertices[i].y;
 pt.z = vertices[i].z;
 lCPts.push_back( pt );
 lCNorm.emplace_back( normals[i].x, normals[i].y, normals[i].z );
 }

 vertices.clear();
 normals.clear();

 IFSG_FACESET fsNode( false );

 if( !isVRML2 )
 fsNode.NewNode( shapeNode );
 else
 fsNode.NewNode( aParent );

 IFSG_COORDS cpNode( fsNode );
 cpNode.SetCoordsList( lCPts.size(), &lCPts[0] );
 IFSG_COORDINDEX ciNode( fsNode );

 for( int i = 0; i < (int)lCPts.size(); ++i )
 ciNode.AddIndex( i );

 IFSG_NORMALS nmNode( fsNode );
 nmNode.SetNormalList( lCNorm.size(), &lCNorm[0] );

 if( !colors.empty() )
 {
 IFSG_COLORS nmColor( fsNode );
 nmColor.SetColorList( colors.size(), &colors[0] );
 colors.clear();
 }

 if( !isVRML2 )
 return shapeNode.GetRawPtr();

 return fsNode.GetRawPtr();
}

References IFSG_NODE::AddChildNode(), IFSG_INDEX::AddIndex(), IFSG_NODE::AddRefNode(), SHAPE::facets, IFSG_NODE::GetRawPtr(), S3D::GetSGNodeParent(), IFSG_FACESET::NewNode(), IFSG_SHAPE::NewNode(), IFSG_COLORS::SetColorList(), IFSG_COORDS::SetCoordsList(), IFSG_NORMALS::SetNormalList(), SGPOINT::x, SGPOINT::y, and SGPOINT::z.

Referenced by WRL1FACESET::TranslateToSG(), WRL2FACESET::TranslateToSG(), and X3DIFACESET::TranslateToSG().

CDPoint()

const VECTOR2D SHAPE_SIMPLE::CDPoint ( int  aIndex ) const

inline

Return a given point as a vector with elements of type double.

Parameters

aIndex

is the index of the point.

Returns

the point with elements of type double.

Definition at line 113 of file shape_simple.h.

 {
 const VECTOR2I& v = CPoint( aIndex );
 return VECTOR2D( v.x, v.y );
 }

References CPoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ROUTER_PREVIEW_ITEM::drawShape().

Centre()

virtual VECTOR2I SHAPE::Centre ( ) const

inlinevirtualinherited

Compute a center-of-mass of the shape.

Returns

the center-of-mass point

Definition at line 216 of file shape.h.

 {
 return BBox( 0 ).Centre(); // if nothing better is available....
 }

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

Referenced by Collide().

Clear()

void SHAPE_SIMPLE::Clear ( )

inline

Remove all points from the polygon.

Definition at line 72 of file shape_simple.h.

 {
 m_points.Clear();
 }

References SHAPE_LINE_CHAIN::Clear(), and m_points.

Clone()

SHAPE* SHAPE_SIMPLE::Clone ( ) const

inlineoverridevirtual

Return a dynamically allocated copy of the shape.

Return values

copy	of the shape

Reimplemented from SHAPE.

Definition at line 64 of file shape_simple.h.

 {
 return new SHAPE_SIMPLE( *this );
 }

References SHAPE_SIMPLE().

Collide() [1/4]

bool SHAPE_SIMPLE::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 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_LINE_CHAIN_BASE.

Definition at line 152 of file shape_simple.h.

 {
 return m_points.Collide( aSeg, aClearance, aActual, aLocation );
 }

References SHAPE_LINE_CHAIN::Collide(), and m_points.

Collide() [2/4]

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

virtualinherited

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

Parameters

aShape	shape to check collision against
aClearance	minimum clearance
aMTV	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 in SHAPE_RECT, SHAPE_SEGMENT, and SHAPE_COMPOUND.

Definition at line 1103 of file shape_collisions.cpp.

{
 return collideShapes( this, aShape, aClearance, nullptr, nullptr, aMTV );
}

References collideShapes().

Collide() [3/4]

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

virtualinherited

Reimplemented in SHAPE_POLY_SET, SHAPE_ARC, SHAPE_RECT, SHAPE_SEGMENT, and SHAPE_COMPOUND.

Definition at line 1109 of file shape_collisions.cpp.

{
 return collideShapes( this, aShape, aClearance, aActual, aLocation, nullptr );
}

References collideShapes().

Collide() [4/4]

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

overridevirtualinherited

Check if point aP lies closer to us than aClearance.

Parameters

aP	the point to check for collisions with
aClearance	minimum distance that does not qualify as a collision.
aActual	an optional pointer to an int to store the actual distance in the event of a collision.

Returns

true, when a collision has been found

Reimplemented from SHAPE.

Reimplemented in SHAPE_LINE_CHAIN.

Definition at line 302 of file shape_line_chain.cpp.

{
 if( IsClosed() && PointInside( aP, aClearance ) )
 {
 if( aLocation )
 *aLocation = aP;

 if( aActual )
 *aActual = 0;

 return true;
 }

 SEG::ecoord closest_dist_sq = VECTOR2I::ECOORD_MAX;
 SEG::ecoord clearance_sq = SEG::Square( aClearance );
 VECTOR2I nearest;

 for( size_t i = 0; i < GetSegmentCount(); i++ )
 {
 const SEG& s = GetSegment( i );
 VECTOR2I pn = s.NearestPoint( aP );
 SEG::ecoord dist_sq = ( pn - aP ).SquaredEuclideanNorm();

 if( dist_sq < closest_dist_sq )
 {
 nearest = pn;
 closest_dist_sq = dist_sq;

 if( closest_dist_sq == 0 )
 break;

 // If we're not looking for aActual then any collision will do
 if( closest_dist_sq < clearance_sq && !aActual )
 break;
 }
 }

 if( closest_dist_sq == 0 || closest_dist_sq < clearance_sq )
 {
 if( aLocation )
 *aLocation = nearest;

 if( aActual )
 *aActual = sqrt( closest_dist_sq );

 return true;
 }

 return false;
}

References VECTOR2< T >::ECOORD_MAX, SHAPE_LINE_CHAIN_BASE::GetSegment(), SHAPE_LINE_CHAIN_BASE::GetSegmentCount(), SHAPE_LINE_CHAIN_BASE::IsClosed(), SEG::NearestPoint(), SHAPE_LINE_CHAIN_BASE::PointInside(), and SEG::Square().

Referenced by Collide().

CPoint()

const VECTOR2I& SHAPE_SIMPLE::CPoint ( int  aIndex ) const

inline

Return a const reference to a given point in the polygon.

Negative indices count from the end of the point list, e.g. -1 means "last point", -2 means "second to last point" and so on.

Parameters

aIndex

is the index of the point.

Returns

the const reference to the point.

Definition at line 102 of file shape_simple.h.

 {
 return m_points.CPoint( aIndex );
 }

References SHAPE_LINE_CHAIN::CPoint(), and m_points.

Referenced by CDPoint(), and KIGFX::PCB_PAINTER::draw().

EdgeContainingPoint()

int SHAPE_LINE_CHAIN_BASE::EdgeContainingPoint ( const VECTOR2I &  aP, int  aAccuracy = 0  ) const

inherited

Check if point aP lies on an edge or vertex of the line chain.

Parameters

aP	point to check

Returns

index of the first edge containing the point, otherwise negative

Definition at line 1593 of file shape_line_chain.cpp.

{
 if( !GetPointCount() )
 {
 return -1;
 }
 else if( GetPointCount() == 1 )
 {
 VECTOR2I dist = GetPoint(0) - aPt;
 return ( hypot( dist.x, dist.y ) <= aAccuracy + 1 ) ? 0 : -1;
 }

 for( size_t i = 0; i < GetSegmentCount(); i++ )
 {
 const SEG s = GetSegment( i );

 if( s.A == aPt || s.B == aPt )
 return i;

 if( s.Distance( aPt ) <= aAccuracy + 1 )
 return i;
 }

 return -1;
}

References SEG::A, SEG::B, SEG::Distance(), SHAPE_LINE_CHAIN_BASE::GetPoint(), SHAPE_LINE_CHAIN_BASE::GetPointCount(), SHAPE_LINE_CHAIN_BASE::GetSegment(), SHAPE_LINE_CHAIN_BASE::GetSegmentCount(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SHAPE_LINE_CHAIN_BASE::PointOnEdge().

Format()

const std::string SHAPE::Format ( ) const

virtualinherited

Reimplemented in SHAPE_POLY_SET, SHAPE_LINE_CHAIN, SHAPE_RECT, SHAPE_SEGMENT, and SHAPE_COMPOUND.

Definition at line 35 of file shape.cpp.

{
 assert( false );
 return std::string( "" );
}

Referenced by SHAPE_FILE_IO::Write().

GetCachedBBox()

virtual BOX2I* SHAPE_LINE_CHAIN_BASE::GetCachedBBox ( ) const

inlinevirtualinherited

Reimplemented in SHAPE_LINE_CHAIN.

Definition at line 312 of file shape.h.

{ return nullptr; }

Referenced by SHAPE_LINE_CHAIN_BASE::PointInside().

GetIndexableSubshapeCount()

virtual size_t SHAPE_BASE::GetIndexableSubshapeCount ( ) const

inlinevirtualinherited

Reimplemented in SHAPE_POLY_SET, and SHAPE_COMPOUND.

Definition at line 104 of file shape.h.

{ return 0; }

GetIndexableSubshapes()

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

inlinevirtualinherited

Reimplemented in SHAPE_POLY_SET, and SHAPE_COMPOUND.

Definition at line 106 of file shape.h.

{ }

Referenced by SHAPE_COMPOUND::AddShape(), and ROUTER_PREVIEW_ITEM::ViewDraw().

GetPoint()

virtual const VECTOR2I SHAPE_SIMPLE::GetPoint ( int  aIndex ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 173 of file shape_simple.h.

{ return m_points.CPoint(aIndex); }

References SHAPE_LINE_CHAIN::CPoint(), and m_points.

GetPointCount()

virtual size_t SHAPE_SIMPLE::GetPointCount ( ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 175 of file shape_simple.h.

{ return m_points.PointCount(); }

References m_points, and SHAPE_LINE_CHAIN::PointCount().

GetSegment()

virtual const SEG SHAPE_SIMPLE::GetSegment ( int  aIndex ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 174 of file shape_simple.h.

{ return m_points.CSegment(aIndex); }

References SHAPE_LINE_CHAIN::CSegment(), and m_points.

Referenced by PCB_GRID_HELPER::computeAnchors(), and KIGFX::PCB_PAINTER::draw().

GetSegmentCount()

virtual size_t SHAPE_SIMPLE::GetSegmentCount ( ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 176 of file shape_simple.h.

{ return m_points.SegmentCount(); }

References m_points, and SHAPE_LINE_CHAIN::SegmentCount().

Referenced by PCB_GRID_HELPER::computeAnchors(), and KIGFX::PCB_PAINTER::draw().

HasIndexableSubshapes()

virtual bool SHAPE_BASE::HasIndexableSubshapes ( ) const

inlinevirtualinherited

Reimplemented in SHAPE_POLY_SET, and SHAPE_COMPOUND.

Definition at line 99 of file shape.h.

 {
 return false;
 }

Referenced by SHAPE_COMPOUND::AddShape(), and ROUTER_PREVIEW_ITEM::ViewDraw().

IsClosed()

bool SHAPE_SIMPLE::IsClosed ( ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 178 of file shape_simple.h.

 {
 return true;
 }

IsNull()

bool SHAPE::IsNull ( ) const

inlineinherited

Return true if the shape is a null shape.

Return values

true	if null :-)

Definition at line 150 of file shape.h.

 {
 return m_type == SH_NULL;
 }

References SHAPE_BASE::m_type, and SH_NULL.

IsSolid()

bool SHAPE_SIMPLE::IsSolid ( ) const

inlineoverridevirtual

Implements SHAPE.

Definition at line 168 of file shape_simple.h.

 {
 return true;
 }

Move()

void SHAPE_SIMPLE::Move ( const VECTOR2I &  aVector )

inlineoverridevirtual

Implements SHAPE.

Definition at line 163 of file shape_simple.h.

 {
 m_points.Move( aVector );
 }

References m_points, and SHAPE_LINE_CHAIN::Move().

NewFacet()

FACET * SHAPE::NewFacet ( )

inherited

Definition at line 695 of file wrlfacet.cpp.

{
 FACET* fp = new FACET;
 facets.push_back( fp );
 return fp;
}

References SHAPE::facets.

Referenced by WRL1FACESET::TranslateToSG(), WRL2FACESET::TranslateToSG(), and X3DIFACESET::TranslateToSG().

Parse()

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

virtualinherited

Reimplemented in SHAPE_POLY_SET, and SHAPE_LINE_CHAIN.

Definition at line 28 of file shape.cpp.

{
 assert( false );
 return false;
}

PointCount()

int SHAPE_SIMPLE::PointCount ( ) const

inline

Return the number of points (vertices) in this polygon.

Returns

number of points.

Definition at line 88 of file shape_simple.h.

 {
 return m_points.PointCount();
 }

References m_points, and SHAPE_LINE_CHAIN::PointCount().

Referenced by KIGFX::PCB_PAINTER::draw(), and ROUTER_PREVIEW_ITEM::drawShape().

PointInside()

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

inherited

Check if point aP lies inside a polygon (any type) defined by the line chain.

For closed shapes only.

Parameters

aPt	point to check
aUseBBoxCache	gives 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).

Definition at line 1535 of file shape_line_chain.cpp.

{
 /*
 * Don't check the bounding box unless it's cached. Building it is about the same speed as
 * the rigorous test below and so just slows things down by doing potentially two tests.
 */
 if( aUseBBoxCache && GetCachedBBox() && !GetCachedBBox()->Contains( aPt ) )
 return false;

 if( !IsClosed() || GetPointCount() < 3 )
 return false;

 bool inside = false;

 /*
 * To check for interior points, we draw a line in the positive x direction from
 * the point. If it intersects an even number of segments, the point is outside the
 * line chain (it had to first enter and then exit). Otherwise, it is inside the chain.
 *
 * Note: slope might be denormal here in the case of a horizontal line but we require our
 * y to move from above to below the point (or vice versa)
 *
 * Note: we open-code CPoint() here so that we don't end up calculating the size of the
 * vector number-of-points times. This has a non-trivial impact on zone fill times.
 */
 int pointCount = GetPointCount();

 for( int i = 0; i < pointCount; )
 {
 const auto p1 = GetPoint( i++ );
 const auto p2 = GetPoint( i == pointCount ? 0 : i );
 const auto diff = p2 - p1;

 if( diff.y != 0 )
 {
 const int d = rescale( diff.x, ( aPt.y - p1.y ), diff.y );

 if( ( ( p1.y > aPt.y ) != ( p2.y > aPt.y ) ) && ( aPt.x - p1.x < d ) )
 inside = !inside;
 }
 }

 // If accuracy is <= 1 (nm) then we skip the accuracy test for performance. Otherwise
 // we use "OnEdge(accuracy)" as a proxy for "Inside(accuracy)".
 if( aAccuracy <= 1 )
 return inside;
 else
 return inside || PointOnEdge( aPt, aAccuracy );
}

References SHAPE_LINE_CHAIN_BASE::GetCachedBBox(), SHAPE_LINE_CHAIN_BASE::GetPoint(), SHAPE_LINE_CHAIN_BASE::GetPointCount(), SHAPE_LINE_CHAIN_BASE::IsClosed(), SHAPE_LINE_CHAIN_BASE::PointOnEdge(), rescale(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Collide(), SHAPE_LINE_CHAIN::Collide(), SHAPE_LINE_CHAIN_BASE::Collide(), POLY_GRID_PARTITION::containsPoint(), SHAPE_POLY_SET::containsSingle(), ZONE::HitTestCutout(), MARKER_BASE::HitTestMarker(), SHAPE_LINE_CHAIN_BASE::SquaredDistance(), and PNS::LINE::Walkaround().

PointOnEdge()

bool SHAPE_LINE_CHAIN_BASE::PointOnEdge ( const VECTOR2I &  aP, int  aAccuracy = 0  ) const

inherited

Check if point aP lies on an edge or vertex of the line chain.

Parameters

aP	point to check

Returns

true if the point lies on the edge.

Definition at line 1587 of file shape_line_chain.cpp.

{
 return EdgeContainingPoint( aPt, aAccuracy ) >= 0;
}

References SHAPE_LINE_CHAIN_BASE::EdgeContainingPoint().

Referenced by FABMASTER::loadZones(), SHAPE_LINE_CHAIN_BASE::PointInside(), and PNS::LINE::Walkaround().

Rotate()

void SHAPE_SIMPLE::Rotate ( double  aAngle, const VECTOR2I &  aCenter = { 0, 0 }  )

inlineoverridevirtual

Parameters

aCenter	is the rotation center.
aAngle	rotation angle in radians.

Implements SHAPE.

Definition at line 158 of file shape_simple.h.

 { 0, 0 } ) override
 {
 m_points.Rotate( aAngle, aCenter );
 }

SquaredDistance()

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

inherited

Definition at line 805 of file shape_line_chain.cpp.

{
 ecoord d = VECTOR2I::ECOORD_MAX;

 if( IsClosed() && PointInside( aP ) && !aOutlineOnly )
 return 0;

 for( size_t s = 0; s < GetSegmentCount(); s++ )
 d = std::min( d, GetSegment( s ).SquaredDistance( aP ) );

 return d;
}

References VECTOR2< T >::ECOORD_MAX, SHAPE_LINE_CHAIN_BASE::GetSegment(), SHAPE_LINE_CHAIN_BASE::GetSegmentCount(), SHAPE_LINE_CHAIN_BASE::IsClosed(), SHAPE_LINE_CHAIN_BASE::PointInside(), and SEG::SquaredDistance().

Referenced by SHAPE_LINE_CHAIN::Distance().

Type()

SHAPE_TYPE SHAPE_BASE::Type ( ) const

inlineinherited

Return the type of the shape.

Return values

the

type

Definition at line 94 of file shape.h.

 {
 return m_type;
 }

References SHAPE_BASE::m_type.

Referenced by PNS::DP_GATEWAYS::BuildFromPrimitivePair(), PNS::buildHullForPrimitiveShape(), Collide(), SHAPE_POLY_SET::Collide(), collideShapes(), collideSingleShapes(), PNS::OPTIMIZER::computeBreakouts(), ROUTER_PREVIEW_ITEM::drawShape(), PNS::SOLID::HoleHull(), PNS::SOLID::Hull(), and SHAPE_FILE_IO::Write().

Vertices()

const SHAPE_LINE_CHAIN& SHAPE_SIMPLE::Vertices ( ) const

inline

Return the list of vertices defining this simple polygon.

Returns

the list of vertices defining this simple polygon.

Definition at line 124 of file shape_simple.h.

 {
 return m_points;
 }

References m_points.

Referenced by PNS::ConvexHull(), PNS::OPTIMIZER::customBreakouts(), and KIGFX::PCB_PAINTER::draw().

Member Data Documentation

m_points

SHAPE_LINE_CHAIN SHAPE_SIMPLE::m_points

private

Definition at line 185 of file shape_simple.h.

Referenced by Append(), BBox(), Clear(), Collide(), CPoint(), GetPoint(), GetPointCount(), GetSegment(), GetSegmentCount(), Move(), PointCount(), SHAPE_SIMPLE(), and Vertices().

m_type

SHAPE_TYPE SHAPE_BASE::m_type

protectedinherited

< type of our shape

Definition at line 110 of file shape.h.

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

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 122 of file shape.h.

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

---

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

• shape_simple.h