SHAPE_CIRCLE Class Reference

#include <shape_circle.h>

Inheritance diagram for SHAPE_CIRCLE:

Public Member Functions
	SHAPE_CIRCLE ()
	SHAPE_CIRCLE (const VECTOR2I &aCenter, int aRadius)
	SHAPE_CIRCLE (const CIRCLE &aCircle)
	SHAPE_CIRCLE (const SHAPE_CIRCLE &aOther)
	~SHAPE_CIRCLE ()
SHAPE *	Clone () const override
	Return a dynamically allocated copy of the shape. More...
SHAPE_CIRCLE &	operator= (const SHAPE_CIRCLE &)=default
const BOX2I	BBox (int aClearance=0) const override
	Compute a bounding box of the shape, with a margin of aClearance a collision. 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 segment aSeg than aClearance, indicating a collision. More...
void	SetRadius (int aRadius)
void	SetCenter (const VECTOR2I &aCenter)
int	GetRadius () const
const VECTOR2I	GetCenter () const
const CIRCLE	GetCircle () const
void	Move (const VECTOR2I &aVector) override
void	Rotate (double aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
bool	IsSolid () const override
bool	IsNull () const
	Return true if the shape is a null shape. More...
virtual bool	Collide (const VECTOR2I &aP, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const
	Check if the boundary of shape (this) lies closer to the point aP than aClearance, indicating a collision. 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
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
CIRCLE	m_circle

Detailed Description

Definition at line 36 of file shape_circle.h.

Member Typedef Documentation

ecoord

typedef VECTOR2I::extended_type SHAPE::ecoord

protectedinherited

Definition at line 236 of file shape.h.

Constructor & Destructor Documentation

SHAPE_CIRCLE() [1/4]

SHAPE_CIRCLE::SHAPE_CIRCLE ( )

inline

Definition at line 39 of file shape_circle.h.

 :
 SHAPE( SH_CIRCLE ),
 m_circle()
 {}

Referenced by Clone().

SHAPE_CIRCLE() [2/4]

SHAPE_CIRCLE::SHAPE_CIRCLE ( const VECTOR2I &  aCenter, int  aRadius  )

inline

Definition at line 44 of file shape_circle.h.

 :
 SHAPE( SH_CIRCLE ),
 m_circle( aCenter, aRadius )
 {}

SHAPE_CIRCLE() [3/4]

SHAPE_CIRCLE::SHAPE_CIRCLE ( const CIRCLE &  aCircle )

inline

Definition at line 49 of file shape_circle.h.

 :
 SHAPE( SH_CIRCLE ),
 m_circle( aCircle )
 {}

SHAPE_CIRCLE() [4/4]

SHAPE_CIRCLE::SHAPE_CIRCLE ( const SHAPE_CIRCLE &  aOther )

inline

Definition at line 54 of file shape_circle.h.

 :
 SHAPE( SH_CIRCLE ),
 m_circle( aOther.m_circle )
 {};

~SHAPE_CIRCLE()

SHAPE_CIRCLE::~SHAPE_CIRCLE ( )

inline

Definition at line 59 of file shape_circle.h.

 {}

Member Function Documentation

BBox()

const BOX2I SHAPE_CIRCLE::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 69 of file shape_circle.h.

 {
 const VECTOR2I rc( m_circle.Radius + aClearance, m_circle.Radius + aClearance );

 return BOX2I( m_circle.Center - rc, rc * 2 );
 }

References CIRCLE::Center, m_circle, and CIRCLE::Radius.

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_SHAPE::NewNode(), IFSG_FACESET::NewNode(), IFSG_COLORS::SetColorList(), IFSG_COORDS::SetCoordsList(), IFSG_NORMALS::SetNormalList(), SGPOINT::x, SGPOINT::y, and SGPOINT::z.

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

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().

Clone()

SHAPE* SHAPE_CIRCLE::Clone ( ) const

inlineoverridevirtual

Return a dynamically allocated copy of the shape.

Return values

copy	of the shape

Reimplemented from SHAPE.

Definition at line 62 of file shape_circle.h.

 {
 return new SHAPE_CIRCLE( *this );
 }

References SHAPE_CIRCLE().

Collide() [1/4]

bool SHAPE_CIRCLE::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 76 of file shape_circle.h.

 {
 int minDist = aClearance + m_circle.Radius;
 VECTOR2I pn = aSeg.NearestPoint( m_circle.Center );
 ecoord dist_sq = ( pn - m_circle.Center ).SquaredEuclideanNorm();

 if( dist_sq == 0 || dist_sq < SEG::Square( minDist ) )
 {
 if( aLocation )
 *aLocation = pn;

 if( aActual )
 *aActual = std::max( 0, (int) sqrt( dist_sq ) - m_circle.Radius );

 return true;
 }

 return false;
 }

References CIRCLE::Center, m_circle, SEG::NearestPoint(), CIRCLE::Radius, and SEG::Square().

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

Collide() [2/4]

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

inlinevirtualinherited

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 in SHAPE_POLY_SET, SHAPE_LINE_CHAIN_BASE, SHAPE_LINE_CHAIN, SHAPE_ARC, and SHAPE_SEGMENT.

Definition at line 165 of file shape.h.

 {
 return Collide( SEG( aP, aP ), aClearance, aActual, aLocation );
 }

Referenced by BOOST_AUTO_TEST_CASE(), DRC_RTREE::CheckColliding(), SHAPE_COMPOUND::Collide(), SHAPE_SEGMENT::Collide(), SHAPE_RECT::Collide(), collide(), SHAPE_ARC::Collide(), SHAPE_POLY_SET::Collide(), PNS::ITEM::collideSimple(), PNS::SHOVE::onCollidingVia(), PNS::HIT_VISITOR::operator()(), DRC_RTREE::QueryColliding(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PNS::OPTIMIZER::smartPadsSingle(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem().

Collide() [3/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() [4/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().

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().

GetCenter()

const VECTOR2I SHAPE_CIRCLE::GetCenter ( ) const

inline

Definition at line 112 of file shape_circle.h.

 {
 return m_circle.Center;
 }

References CIRCLE::Center, and m_circle.

Referenced by PNS::buildHullForPrimitiveShape(), PNS::OPTIMIZER::circleBreakouts(), Collide(), SHAPE_POLY_SET::Collide(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createPadWithClearance(), KIGFX::PCB_PAINTER::draw(), ROUTER_PREVIEW_ITEM::drawShape(), SCH_JUNCTION::Print(), pushoutForce(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), and PCB_DIMENSION_BASE::TransformShapeWithClearanceToPolygon().

GetCircle()

const CIRCLE SHAPE_CIRCLE::GetCircle ( ) const

inline

Definition at line 117 of file shape_circle.h.

 {
 return m_circle;
 }

References m_circle.

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().

GetRadius()

int SHAPE_CIRCLE::GetRadius ( ) const

inline

Definition at line 107 of file shape_circle.h.

 {
 return m_circle.Radius;
 }

References m_circle, and CIRCLE::Radius.

Referenced by PNS::buildHullForPrimitiveShape(), PNS::OPTIMIZER::circleBreakouts(), Collide(), SHAPE_POLY_SET::Collide(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createPadWithClearance(), KIGFX::PCB_PAINTER::draw(), ROUTER_PREVIEW_ITEM::drawShape(), SCH_JUNCTION::GetEffectiveDiameter(), SCH_JUNCTION::Print(), pushoutForce(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), and PCB_DIMENSION_BASE::TransformShapeWithClearanceToPolygon().

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().

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_CIRCLE::IsSolid ( ) const

inlineoverridevirtual

Implements SHAPE.

Definition at line 134 of file shape_circle.h.

 {
 return true;
 }

Move()

void SHAPE_CIRCLE::Move ( const VECTOR2I &  aVector )

inlineoverridevirtual

Implements SHAPE.

Definition at line 122 of file shape_circle.h.

 {
 m_circle.Center += aVector;
 }

References CIRCLE::Center, and m_circle.

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(), X3DIFACESET::TranslateToSG(), and WRL2FACESET::TranslateToSG().

operator=()

SHAPE_CIRCLE& SHAPE_CIRCLE::operator= ( const SHAPE_CIRCLE &  )

default

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;
}

Rotate()

void SHAPE_CIRCLE::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 127 of file shape_circle.h.

 { 0, 0 } ) override
 {
 m_circle.Center -= aCenter;
 m_circle.Center = m_circle.Center.Rotate( aAngle );
 m_circle.Center += aCenter;
 }

SetCenter()

void SHAPE_CIRCLE::SetCenter ( const VECTOR2I &  aCenter )

inline

Definition at line 102 of file shape_circle.h.

 {
 m_circle.Center = aCenter;
 }

References CIRCLE::Center, and m_circle.

Referenced by Collide(), and PNS::VIA::SetPos().

SetRadius()

void SHAPE_CIRCLE::SetRadius ( int  aRadius )

inline

Definition at line 97 of file shape_circle.h.

 {
 m_circle.Radius = aRadius;
 }

References m_circle, and CIRCLE::Radius.

Referenced by PNS::VIA::SetDiameter(), and PNS::VIA::SetDrill().

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().

Member Data Documentation

m_circle

CIRCLE SHAPE_CIRCLE::m_circle

private

Definition at line 140 of file shape_circle.h.

Referenced by BBox(), Collide(), GetCenter(), GetCircle(), GetRadius(), Move(), SetCenter(), and SetRadius().

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_circle.h