GEOM_TEST Namespace Reference

Utility functions for testing geometry functions. More...

Enumerations
enum class	QUADRANT { Q1 , Q2 , Q3 , Q4 }
	Geometric quadrants, from top-right, anti-clockwise. More...

Functions
template<typename T >
bool	IsInQuadrant (const VECTOR2< T > &aPoint, QUADRANT aQuadrant)
bool	SegmentCompletelyInQuadrant (const SEG &aSeg, QUADRANT aQuadrant)
bool	SegmentEndsInQuadrant (const SEG &aSeg, QUADRANT aQuadrant)
bool	SegmentCompletelyWithinRadius (const SEG &aSeg, const VECTOR2I &aPt, const int aRadius)
template<typename T >
bool	IsPointAtDistance (const VECTOR2< T > &aPtA, const VECTOR2< T > &aPtB, T aExpDist, T aTol)
	Check that two points are the given distance apart, within the given tolerance. More...
template<typename T >
bool	ArePointsNearCircle (const std::vector< VECTOR2< T > > &aPoints, const VECTOR2< T > &aCentre, T aRad, T aTol)
	Predicate for checking a set of points is within a certain tolerance of a circle. More...
template<typename T >
bool	ArePerpendicular (const VECTOR2< T > &a, const VECTOR2< T > &b, const EDA_ANGLE &aTolerance)
SHAPE_LINE_CHAIN	MakeSquarePolyLine (int aSize, const VECTOR2I &aCentre)
	construct a square polygon of given size width and centre More...
SHAPE_POLY_SET	FilletPolySet (SHAPE_POLY_SET &aPolySet, int aRadius, int aError)
bool	IsOutlineValid (const SHAPE_LINE_CHAIN &aChain)
	Verify that a SHAPE_LINE_CHAIN has been assembled correctly by ensuring that the arc start and end points match points on the chain and that any points inside the arcs actually collide with the arc segments (with an error margin of 5000 IU) More...
bool	IsPolySetValid (const SHAPE_POLY_SET &aSet)
	Verify that a SHAPE_POLY_SET has been assembled correctly by verifying each of the outlines and holes contained within. More...

Detailed Description

Utility functions for testing geometry functions.

Enumeration Type Documentation

QUADRANT

enum class GEOM_TEST::QUADRANT

strong

Geometric quadrants, from top-right, anti-clockwise.

^ y
|

Q2 | Q1 ----—> x Q3 | Q4

Enumerator
Q1
Q2
Q3
Q4

Definition at line 51 of file geom_test_utils.h.

 {
 Q1, Q2, Q3, Q4
};

Function Documentation

ArePerpendicular()

template<typename T >

bool GEOM_TEST::ArePerpendicular	(	const VECTOR2< T > &	a,
		const VECTOR2< T > &	b,
		const EDA_ANGLE &	aTolerance
	)

Definition at line 172 of file geom_test_utils.h.

{
 EDA_ANGLE angle = std::abs( EDA_ANGLE( a ) - EDA_ANGLE( b ) );
 
 // Normalise: angles of 3*pi/2 are also perpendicular
 if (angle > ANGLE_180)
 angle -= ANGLE_180;
 
 return KI_TEST::IsWithin( angle.AsRadians(), ANGLE_90.AsRadians(), aTolerance.AsRadians() );
}

References std::abs(), PNS::angle(), ANGLE_180, ANGLE_90, EDA_ANGLE::AsRadians(), and KI_TEST::IsWithin().

ArePointsNearCircle()

template<typename T >

bool GEOM_TEST::ArePointsNearCircle	(	const std::vector< VECTOR2< T > > &	aPoints,
		const VECTOR2< T > &	aCentre,
		T	aRad,
		T	aTol
	)

Predicate for checking a set of points is within a certain tolerance of a circle.

Parameters

aPoints	the points to check
aCentre	the circle centre
aRad	the circle radius
aTolEnds	the tolerance for the endpoint-centre distance

Returns

true if predicate met

Definition at line 144 of file geom_test_utils.h.

{
 bool ok = true;
 
 for( unsigned i = 0; i < aPoints.size(); ++i )
 {
 if( !IsPointAtDistance( aPoints[i], aCentre, aRad, aTol ) )
 {
 BOOST_TEST_INFO( "Point " << i << " " << aPoints[i] << " is not within tolerance ("
 << aTol << ") of radius (" << aRad << ") from centre point "
 << aCentre );
 ok = false;
 }
 }
 
 return ok;
}

References BOOST_TEST_INFO, and IsPointAtDistance().

Referenced by ArePolylineEndPointsNearCircle(), and ArePolylineMidPointsNearCircle().

FilletPolySet()

SHAPE_POLY_SET GEOM_TEST::FilletPolySet ( SHAPE_POLY_SET &  aPolySet, int  aRadius, int  aError  )

inline

Definition at line 208 of file geom_test_utils.h.

{
 SHAPE_POLY_SET filletedPolySet;
 
 for ( int i = 0; i < aPolySet.OutlineCount(); ++i )
 {
 const auto filleted = aPolySet.FilletPolygon( aRadius, aError, i );
 
 filletedPolySet.AddOutline( filleted[0] );
 }
 
 return filletedPolySet;
}

References SHAPE_POLY_SET::AddOutline(), SHAPE_POLY_SET::FilletPolygon(), and SHAPE_POLY_SET::OutlineCount().

Referenced by TestConcaveSquareFillet(), and TestSquareFillet().

IsInQuadrant()

template<typename T >

bool GEOM_TEST::IsInQuadrant	(	const VECTOR2< T > &	aPoint,
		QUADRANT	aQuadrant
	)

Definition at line 59 of file geom_test_utils.h.

{
 bool isInQuad = false;
 
 switch( aQuadrant )
 {
 case QUADRANT::Q1:
 isInQuad = aPoint.x >= 0 && aPoint.y >= 0;
 break;
 case QUADRANT::Q2:
 isInQuad = aPoint.x <= 0 && aPoint.y >= 0;
 break;
 case QUADRANT::Q3:
 isInQuad = aPoint.x <= 0 && aPoint.y <= 0;
 break;
 case QUADRANT::Q4:
 isInQuad = aPoint.x >= 0 && aPoint.y <= 0;
 break;
 }
 
 return isInQuad;
}

References Q1, Q2, Q3, Q4, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SegmentCompletelyInQuadrant(), and SegmentEndsInQuadrant().

IsOutlineValid()

bool GEOM_TEST::IsOutlineValid ( const SHAPE_LINE_CHAIN &  aChain )

inline

Verify that a SHAPE_LINE_CHAIN has been assembled correctly by ensuring that the arc start and end points match points on the chain and that any points inside the arcs actually collide with the arc segments (with an error margin of 5000 IU)

Parameters

aChain

to test

Returns

true if outline is valid

Definition at line 230 of file geom_test_utils.h.

{
 ssize_t prevArcIdx = -1;
 std::set<size_t> testedArcs;
 
 for( int i = 0; i < aChain.PointCount(); i++ )
 {
 ssize_t arcIdx = aChain.ArcIndex( i );
 
 if( arcIdx >= 0 )
 {
 // Point on arc, lets make sure it collides with the arc shape and we haven't
 // previously seen the same arc index
 
 if( prevArcIdx != arcIdx && testedArcs.count( arcIdx ) )
 return false; // we've already seen this arc before, not contiguous
 
 if( !aChain.Arc( arcIdx ).Collide( aChain.CPoint( i ),
 SHAPE_ARC::DefaultAccuracyForPCB() ) )
 {
 return false;
 }
 
 testedArcs.insert( arcIdx );
 }
 
 if( prevArcIdx != arcIdx )
 {
 // we have changed arc shapes, run a few extra tests
 
 if( prevArcIdx >= 0 )
 {
 // prev point on arc, test that the last arc point on the chain
 // matches the end point of the arc
 VECTOR2I pointToTest = aChain.CPoint( i );
 
 if( !aChain.IsSharedPt( i ) )
 pointToTest = aChain.CPoint( i - 1 );
 
 SHAPE_ARC lastArc = aChain.Arc( prevArcIdx );
 
 if( lastArc.GetP1() != pointToTest )
 return false;
 }
 
 if( arcIdx >= 0 )
 {
 // new arc, test that the start point of the arc matches the point on the chain
 VECTOR2I pointToTest = aChain.CPoint( i );
 SHAPE_ARC currentArc = aChain.Arc( arcIdx );
 
 if( currentArc.GetP0() != pointToTest )
 return false;
 }
 }
 
 prevArcIdx = arcIdx;
 }
 
 return true;
}

References SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), SHAPE_ARC::Collide(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_ARC::DefaultAccuracyForPCB(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), SHAPE_LINE_CHAIN::IsSharedPt(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by BOOST_AUTO_TEST_CASE(), and IsPolySetValid().

IsPointAtDistance()

template<typename T >

bool GEOM_TEST::IsPointAtDistance	(	const VECTOR2< T > &	aPtA,
		const VECTOR2< T > &	aPtB,
		T	aExpDist,
		T	aTol
	)

Check that two points are the given distance apart, within the given tolerance.

Template Parameters

T	the dimension type

Parameters

aPtA	the first point
aPtB	the second point
aExpDist	the expected distance
aTol	the permitted tolerance

Definition at line 120 of file geom_test_utils.h.

{
 const int dist = ( aPtB - aPtA ).EuclideanNorm();
 const bool ok = KI_TEST::IsWithin( dist, aExpDist, aTol );
 
 if( !ok )
 {
 BOOST_TEST_INFO( "Points not at expected distance: distance is " << dist << ", expected "
 << aExpDist );
 }
 
 return ok;
}

References BOOST_TEST_INFO, EuclideanNorm(), and KI_TEST::IsWithin().

Referenced by ArePointsNearCircle().

IsPolySetValid()

bool GEOM_TEST::IsPolySetValid ( const SHAPE_POLY_SET &  aSet )

inline

Verify that a SHAPE_POLY_SET has been assembled correctly by verifying each of the outlines and holes contained within.

Parameters

aSet

to test

Returns

true if the poly set is valid

Definition at line 299 of file geom_test_utils.h.

{
 for( int i = 0; i < aSet.OutlineCount(); i++ )
 {
 if( !IsOutlineValid( aSet.Outline( i ) ) )
 return false;
 
 for( int j = 0; j < aSet.HoleCount( i ); j++ )
 {
 if( !IsOutlineValid( aSet.CHole( i, j ) ) )
 return false;
 }
 }
 
 return true;
}

References SHAPE_POLY_SET::CHole(), SHAPE_POLY_SET::HoleCount(), IsOutlineValid(), SHAPE_POLY_SET::Outline(), and SHAPE_POLY_SET::OutlineCount().

Referenced by BOOST_AUTO_TEST_CASE().

MakeSquarePolyLine()

SHAPE_LINE_CHAIN GEOM_TEST::MakeSquarePolyLine ( int  aSize, const VECTOR2I &  aCentre  )

inline

construct a square polygon of given size width and centre

Parameters

aSize	the side width (must be divisible by 2 if want to avoid rounding)
aCentre	the centre of the square

Definition at line 189 of file geom_test_utils.h.

{
 SHAPE_LINE_CHAIN polyLine;
 
 const VECTOR2I corner = aCentre + aSize / 2;
 
 polyLine.Append( VECTOR2I( corner.x, corner.y ) );
 polyLine.Append( VECTOR2I( -corner.x, corner.y ) ) ;
 polyLine.Append( VECTOR2I( -corner.x, -corner.y ) );
 polyLine.Append( VECTOR2I( corner.x, -corner.y ) );
 
 polyLine.SetClosed( true );
 
 return polyLine;
}

References SHAPE_LINE_CHAIN::Append(), SHAPE_LINE_CHAIN::SetClosed(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by TestSquareFillet().

SegmentCompletelyInQuadrant()

bool GEOM_TEST::SegmentCompletelyInQuadrant ( const SEG &  aSeg, QUADRANT  aQuadrant  )

inline

Definition at line 85 of file geom_test_utils.h.

{
 return IsInQuadrant( aSeg.A, aQuadrant)
 && IsInQuadrant( aSeg.B, aQuadrant );
}

References SEG::A, SEG::B, and IsInQuadrant().

Referenced by TestSquareFillet().

SegmentCompletelyWithinRadius()

bool GEOM_TEST::SegmentCompletelyWithinRadius ( const SEG &  aSeg, const VECTOR2I &  aPt, const int  aRadius  )

inline

Definition at line 103 of file geom_test_utils.h.

{
 // This is true iff both ends of the segment are within the radius
 return ( ( aSeg.A - aPt ).EuclideanNorm() < aRadius )
 && ( ( aSeg.B - aPt ).EuclideanNorm() < aRadius );
}

References SEG::A, SEG::B, and EuclideanNorm().

Referenced by TestConcaveSquareFillet().

SegmentEndsInQuadrant()

bool GEOM_TEST::SegmentEndsInQuadrant ( const SEG &  aSeg, QUADRANT  aQuadrant  )

inline

Definition at line 94 of file geom_test_utils.h.

{
 return IsInQuadrant( aSeg.A, aQuadrant )
 || IsInQuadrant( aSeg.B, aQuadrant );
}

References SEG::A, SEG::B, and IsInQuadrant().