#include <shape_segment.h>

Inheritance diagram for SHAPE_SEGMENT:

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

SHAPE *	Clone () const override
	Return a dynamically allocated copy of the shape. More...

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 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. More...

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. More...

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. More...

void	SetSeg (const SEG &aSeg)

const SEG &	GetSeg () const

void	SetWidth (int aWidth)

int	GetWidth () const

bool	IsSolid () const override

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

void	Move (const VECTOR2I &aVector) override

virtual const std::string	Format () const override

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)

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
SEG	m_seg

int	m_width

Detailed Description

Definition at line 35 of file shape_segment.h.

Member Typedef Documentation

◆ ecoord

typedef VECTOR2I::extended_type SHAPE::ecoord

protectedinherited

Definition at line 236 of file shape.h.

Constructor & Destructor Documentation

◆ SHAPE_SEGMENT() [1/3]

SHAPE_SEGMENT::SHAPE_SEGMENT ( )

inline

Definition at line 38 of file shape_segment.h.

                     :
         SHAPE( SH_SEGMENT ),
         m_width( 0 )
     {};

Referenced by Clone().

◆ SHAPE_SEGMENT() [2/3]

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

inline

Definition at line 43 of file shape_segment.h.

                                                                             :
         SHAPE( SH_SEGMENT ),
         m_seg( aA, aB ),
         m_width( aWidth )
     {};

◆ SHAPE_SEGMENT() [3/3]

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

inline

Definition at line 49 of file shape_segment.h.

                                                      :
         SHAPE( SH_SEGMENT ),
         m_seg( aSeg ),
         m_width( aWidth )
     {};

◆ ~SHAPE_SEGMENT()

SHAPE_SEGMENT::~SHAPE_SEGMENT ( )

inline

Definition at line 55 of file shape_segment.h.

55 {};

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

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 62 of file shape_segment.h.

     {
         return BOX2I( m_seg.A, m_seg.B - m_seg.A ).Inflate( aClearance + ( m_width + 1 ) / 2 );
     }

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

◆ 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_SEGMENT::Clone ( ) const

inlineoverridevirtual

Return a dynamically allocated copy of the shape.

Return values

copy	of the shape

Reimplemented from SHAPE.

Definition at line 57 of file shape_segment.h.

     {
         return new SHAPE_SEGMENT( m_seg, m_width );
     }

References m_seg, m_width, and SHAPE_SEGMENT().

Referenced by DRC_ENGINE::GetShape(), and PNS_KICAD_IFACE_BASE::syncPad().

◆ Collide() [1/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

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 from SHAPE.

Definition at line 67 of file shape_segment.h.

     {
         return SHAPE::Collide( aShape, aClearance, aMTV );
     }

References SHAPE::Collide().

Referenced by Collide().

◆ Collide() [2/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 72 of file shape_segment.h.

     {
         return SHAPE::Collide( aShape, aClearance, aActual, aLocation );
     }

References SHAPE::Collide().

◆ Collide() [3/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 78 of file shape_segment.h.

     {
         int min_dist = ( m_width + 1 ) / 2 + aClearance;
         ecoord dist_sq = m_seg.SquaredDistance( aSeg );
 
         if( dist_sq == 0 || dist_sq < SEG::Square( min_dist ) )
         {
             if( aLocation )
                 *aLocation = m_seg.NearestPoint( aSeg );
 
             if( aActual )
                 *aActual = std::max( 0, (int) sqrt( dist_sq ) - ( m_width + 1 ) / 2 );
 
             return true;
         }
 
         return false;
     }

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

◆ 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 98 of file shape_segment.h.

     {
         int min_dist = ( m_width + 1 ) / 2 + aClearance;
         ecoord dist_sq = m_seg.SquaredDistance( aP );
 
         if( dist_sq == 0 || dist_sq < SEG::Square( min_dist ) )
         {
             if( aLocation )
                 *aLocation = m_seg.NearestPoint( aP );
 
             if( aActual )
                 *aActual = std::max( 0, (int) sqrt( dist_sq ) - ( m_width + 1 ) / 2 );
 
             return true;
         }
 
         return false;
     }

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

◆ Format()

const std::string SHAPE_SEGMENT::Format ( ) const

overridevirtual

Reimplemented from SHAPE.

Definition at line 29 of file shape_segment.cpp.

 {
     std::stringstream ss;
 
     ss << "SHAPE_SEGMENT( VECTOR2I( ";
     ss << m_seg.A.x;
     ss << ", ";
     ss << m_seg.A.y;
     ss << "), VECTOR2I( ";
     ss << m_seg.B.x;
     ss << ", ";
     ss << m_seg.B.y;
     ss << "), ";
     ss << m_width;
     ss << "); ";
 
     return ss.str();
 }

References SEG::A, SEG::B, m_seg, m_width, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ 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.

104 { 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.

106 { }

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

◆ GetSeg()

const SEG& SHAPE_SEGMENT::GetSeg ( ) const

inline

Definition at line 123 of file shape_segment.h.

     {
         return m_seg;
     }

References m_seg.

Referenced by PNS::SEGMENT::Anchor(), PNS::ApproximateSegmentAsRect(), PNS::SEGMENT::CLine(), Collide(), SHAPE_POLY_SET::Collide(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createPadWithClearance(), BOARD_ADAPTER::createPadWithDrill(), KIGFX::PCB_PAINTER::draw(), ROUTER_PREVIEW_ITEM::drawShape(), DIALOG_PAD_PROPERTIES::padValuesOK(), PlotLayerOutlines(), PNS::SEGMENT::Seg(), PNS::SegmentHull(), PNS::SEGMENT::SwapEnds(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), and PAD::TransformHoleWithClearanceToPolygon().

◆ GetWidth()

int SHAPE_SEGMENT::GetWidth ( ) const

inline

Definition at line 133 of file shape_segment.h.

     {
         return m_width;
     }

References m_width.

Referenced by PNS::ApproximateSegmentAsRect(), Collide(), SHAPE_POLY_SET::Collide(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createPadWithClearance(), BOARD_ADAPTER::createPadWithDrill(), KIGFX::PCB_PAINTER::draw(), ROUTER_PREVIEW_ITEM::drawShape(), DIALOG_PAD_PROPERTIES::padValuesOK(), PlotLayerOutlines(), PNS::SegmentHull(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), PAD::TransformHoleWithClearanceToPolygon(), and PNS::SEGMENT::Width().

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

inlineoverridevirtual

Implements SHAPE.

Definition at line 138 of file shape_segment.h.

     {
         return true;
     }

◆ Move()

void SHAPE_SEGMENT::Move ( const VECTOR2I & aVector )

inlineoverridevirtual

Implements SHAPE.

Definition at line 155 of file shape_segment.h.

     {
         m_seg.A += aVector;
         m_seg.B += aVector;
     }

References SEG::A, SEG::B, and m_seg.

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

◆ 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_SEGMENT::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 143 of file shape_segment.h.

                                                           { 0, 0 } ) override
     {
         m_seg.A -= aCenter;
         m_seg.B -= aCenter;
 
         m_seg.A = m_seg.A.Rotate( aAngle );
         m_seg.B = m_seg.B.Rotate( aAngle );
 
         m_seg.A += aCenter;
         m_seg.B += aCenter;
     }

◆ SetSeg()

void SHAPE_SEGMENT::SetSeg ( const SEG & aSeg )

inline

Definition at line 118 of file shape_segment.h.

     {
         m_seg = aSeg;
     }

References m_seg.

Referenced by PNS::SEGMENT::SetEnds(), and PNS::SEGMENT::SwapEnds().

◆ SetWidth()

void SHAPE_SEGMENT::SetWidth ( int aWidth )

inline

Definition at line 128 of file shape_segment.h.

     {
         m_width = aWidth;
     }

References m_width.

Referenced by PNS::SEGMENT::SetWidth(), and PNS_KICAD_IFACE_BASE::syncPad().

◆ 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_seg

SEG SHAPE_SEGMENT::m_seg

private

Definition at line 164 of file shape_segment.h.

Referenced by BBox(), Clone(), Collide(), Format(), GetSeg(), Move(), and SetSeg().

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

◆ m_width

int SHAPE_SEGMENT::m_width

private

Definition at line 165 of file shape_segment.h.

Referenced by BBox(), Clone(), Collide(), Format(), GetWidth(), and SetWidth().

◆ 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 files:

Public Member Functions

Static Public Attributes

Protected Types

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ecoord

Constructor & Destructor Documentation

◆ SHAPE_SEGMENT() [1/3]

◆ SHAPE_SEGMENT() [2/3]

◆ SHAPE_SEGMENT() [3/3]

◆ ~SHAPE_SEGMENT()

Member Function Documentation

◆ BBox()

◆ CalcShape()

◆ Centre()

◆ Clone()

◆ Collide() [1/4]

◆ Collide() [2/4]

◆ Collide() [3/4]

◆ Collide() [4/4]

◆ Format()

◆ GetIndexableSubshapeCount()

◆ GetIndexableSubshapes()

◆ GetSeg()

◆ GetWidth()

◆ HasIndexableSubshapes()

◆ IsNull()

◆ IsSolid()

◆ Move()

◆ NewFacet()

◆ Parse()

◆ Rotate()

◆ SetSeg()

◆ SetWidth()

◆ Type()

Member Data Documentation

◆ m_seg

◆ m_type

◆ m_width

◆ MIN_PRECISION_IU