SHAPE_NULL Class Reference

#include <shape_null.h>

Inheritance diagram for SHAPE_NULL:

Public Member Functions
	SHAPE_NULL ()
	SHAPE_NULL (const SHAPE_NULL &aOther)
	~SHAPE_NULL ()
SHAPE *	Clone () const override
	Return a dynamically allocated copy of the shape. More...
SHAPE_NULL &	operator= (const SHAPE_NULL &)=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	Move (const VECTOR2I &aVector) override
void	Rotate (const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
bool	IsSolid () const override
int	GetClearance (const SHAPE *aOther) const
	Return the actual minimum distance between two shapes. More...
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 (bool aCplusPlus=true) 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...
wxString	TypeName () const
virtual bool	HasIndexableSubshapes () const
virtual size_t	GetIndexableSubshapeCount () const
virtual void	GetIndexableSubshapes (std::vector< const SHAPE * > &aSubshapes) const

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
std::list< FACET * >	facets

Detailed Description

Definition at line 34 of file shape_null.h.

Member Typedef Documentation

ecoord

typedef VECTOR2I::extended_type SHAPE::ecoord

protectedinherited

Definition at line 250 of file shape.h.

Constructor & Destructor Documentation

SHAPE_NULL() [1/2]

SHAPE_NULL::SHAPE_NULL ( )

inline

Definition at line 37 of file shape_null.h.

 :
 SHAPE( SH_NULL )
 {}

Referenced by Clone().

SHAPE_NULL() [2/2]

SHAPE_NULL::SHAPE_NULL ( const SHAPE_NULL &  aOther )

inline

Definition at line 41 of file shape_null.h.

 :
 SHAPE( SH_NULL )
 {};

~SHAPE_NULL()

SHAPE_NULL::~SHAPE_NULL ( )

inline

Definition at line 45 of file shape_null.h.

 {}

Member Function Documentation

BBox()

const BOX2I SHAPE_NULL::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 55 of file shape_null.h.

 {
 return BOX2I();
 }

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 WRL2FACESET::TranslateToSG(), X3DIFACESET::TranslateToSG(), and WRL1FACESET::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 230 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_NULL::Clone ( ) const

inlineoverridevirtual

Return a dynamically allocated copy of the shape.

Return values

copy	of the shape

Reimplemented from SHAPE.

Definition at line 48 of file shape_null.h.

 {
 return new SHAPE_NULL( *this );
 }

References SHAPE_NULL().

Collide() [1/4]

bool SHAPE_NULL::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 60 of file shape_null.h.

 {
 return false;
 }

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_COMPOUND, SHAPE_RECT, and SHAPE_SEGMENT.

Definition at line 1109 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_ARC, SHAPE_COMPOUND, SHAPE_POLY_SET, SHAPE_RECT, and SHAPE_SEGMENT.

Definition at line 1115 of file shape_collisions.cpp.

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

References collideShapes().

Collide() [4/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_LINE_CHAIN_BASE, SHAPE_ARC, SHAPE_LINE_CHAIN, SHAPE_POLY_SET, and SHAPE_SEGMENT.

Definition at line 179 of file shape.h.

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

References SHAPE::Collide().

Referenced by BOOST_AUTO_TEST_CASE(), DRC_RTREE::CheckColliding(), FOOTPRINT::CheckShortingPads(), SHAPE_COMPOUND::Collide(), SHAPE_RECT::Collide(), SHAPE_SEGMENT::Collide(), SHAPE_ARC::Collide(), SHAPE_POLY_SET::Collide(), SHAPE::Collide(), CN_ZONE_LAYER::Collide(), collide(), PNS::ITEM::collideSimple(), PNS::SHOVE::onCollidingVia(), PNS::HIT_VISITOR::operator()(), RN_NET::optimizeRNEdges(), PNS::VIA::PushoutForce(), DRC_RTREE::QueryColliding(), PNS::OPTIMIZER::smartPadsSingle(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem().

Format()

const std::string SHAPE::Format ( bool  aCplusPlus = true ) const

virtualinherited

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

Definition at line 41 of file shape.cpp.

{
 std::stringstream ss;
 ss << "shape " << m_type;
 return ss.str();
}

References SHAPE_BASE::m_type.

Referenced by SHAPE_CIRCLE::Format(), SHAPE_SEGMENT::Format(), and SHAPE_FILE_IO::Write().

GetClearance()

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

inherited

Return the actual minimum distance between two shapes.

Return values

distance

in IU

Definition at line 49 of file shape.cpp.

{
 int actual_clearance = std::numeric_limits<int>::max();
 std::vector<const SHAPE*> a_shapes;
 std::vector<const SHAPE*> b_shapes;
 
 GetIndexableSubshapes( a_shapes );
 aOther->GetIndexableSubshapes( b_shapes );
 
 if( GetIndexableSubshapeCount() == 0 )
 a_shapes.push_back( this );
 
 if( aOther->GetIndexableSubshapeCount() == 0 )
 b_shapes.push_back( aOther );
 
 for( const SHAPE* a : a_shapes )
 {
 for( const SHAPE* b : b_shapes )
 {
 int temp_dist = 0;
 a->Collide( b, std::numeric_limits<int>::max() / 2, &temp_dist );
 
 if( temp_dist < actual_clearance )
 actual_clearance = temp_dist;
 }
 }
 
 return actual_clearance;
}

References SHAPE_BASE::GetIndexableSubshapeCount(), and SHAPE_BASE::GetIndexableSubshapes().

GetIndexableSubshapeCount()

virtual size_t SHAPE_BASE::GetIndexableSubshapeCount ( ) const

inlinevirtualinherited

Reimplemented in SHAPE_COMPOUND, and SHAPE_POLY_SET.

Definition at line 111 of file shape.h.

{ return 0; }

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

{ }

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

HasIndexableSubshapes()

virtual bool SHAPE_BASE::HasIndexableSubshapes ( ) const

inlinevirtualinherited

Reimplemented in SHAPE_COMPOUND, and SHAPE_POLY_SET.

Definition at line 106 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 164 of file shape.h.

 {
 return m_type == SH_NULL;
 }

References SHAPE_BASE::m_type, and SH_NULL.

IsSolid()

bool SHAPE_NULL::IsSolid ( ) const

inlineoverridevirtual

Implements SHAPE.

Definition at line 74 of file shape_null.h.

 {
 return false;
 }

Move()

void SHAPE_NULL::Move ( const VECTOR2I &  aVector )

inlineoverridevirtual

Implements SHAPE.

Definition at line 66 of file shape_null.h.

 {
 }

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

operator=()

SHAPE_NULL & SHAPE_NULL::operator= ( const SHAPE_NULL &  )

default

Parse()

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

virtualinherited

Reimplemented in SHAPE_LINE_CHAIN, and SHAPE_POLY_SET.

Definition at line 34 of file shape.cpp.

{
 assert( false );
 return false;
}

Rotate()

void SHAPE_NULL::Rotate ( const EDA_ANGLE &  aAngle, const VECTOR2I &  aCenter = { 0, 0 }  )

inlineoverridevirtual

Parameters

aCenter	is the rotation center.
aAngle	rotation angle.

Implements SHAPE.

Definition at line 70 of file shape_null.h.

 { 0, 0 } ) override
 {
 }

Type()

SHAPE_TYPE SHAPE_BASE::Type ( ) const

inlineinherited

Return the type of the shape.

Return values

the

type

Definition at line 96 of file shape.h.

 {
 return m_type;
 }

References SHAPE_BASE::m_type.

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

TypeName()

wxString SHAPE_BASE::TypeName ( ) const

inlineinherited

Definition at line 101 of file shape.h.

 {
 return SHAPE_TYPE_asString( m_type );
 }

References SHAPE_BASE::m_type, and SHAPE_TYPE_asString().

Referenced by Collide().

Member Data Documentation

facets

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

privateinherited

Definition at line 143 of file wrlfacet.h.

Referenced by SHAPE::CalcShape(), and SHAPE::NewFacet().

m_type

SHAPE_TYPE SHAPE_BASE::m_type

protectedinherited

< type of our shape

Definition at line 117 of file shape.h.

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

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 129 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_null.h