SEG Class Reference

#include <seg.h>

Public Types
using	ecoord = VECTOR2I::extended_type

Public Member Functions
	SEG ()
	Create an empty (0, 0) segment. More...
	SEG (int aX1, int aY1, int aX2, int aY2)
	Create a segment between (aX1, aY1) and (aX2, aY2). More...
	SEG (const VECTOR2I &aA, const VECTOR2I &aB)
	Create a segment between (aA) and (aB). More...
	SEG (const VECTOR2I &aA, const VECTOR2I &aB, int aIndex)
	Create a segment between (aA) and (aB), referenced to a multi-segment shape. More...
	SEG (const SEG &aSeg)
	Copy constructor. More...
SEG &	operator= (const SEG &aSeg)
bool	operator== (const SEG &aSeg) const
bool	operator!= (const SEG &aSeg) const
VECTOR2I	LineProject (const VECTOR2I &aP) const
	Compute the perpendicular projection point of aP on a line passing through ends of the segment. More...
int	Side (const VECTOR2I &aP) const
	Determine on which side of directed line passing via segment ends point aP lies. More...
int	LineDistance (const VECTOR2I &aP, bool aDetermineSide=false) const
	Return the closest Euclidean distance between point aP and the line defined by the ends of segment (this). More...
double	AngleDegrees (const SEG &aOther) const
	Determine the smallest angle between two segments (result in degrees) More...
const VECTOR2I	NearestPoint (const VECTOR2I &aP) const
	Compute a point on the segment (this) that is closest to point aP. More...
const VECTOR2I	NearestPoint (const SEG &aSeg) const
	Compute a point on the segment (this) that is closest to any point on aSeg. More...
const VECTOR2I	ReflectPoint (const VECTOR2I &aP) const
	Reflect a point using this segment as axis. More...
OPT_VECTOR2I	Intersect (const SEG &aSeg, bool aIgnoreEndpoints=false, bool aLines=false) const
	Compute intersection point of segment (this) with segment aSeg. More...
OPT_VECTOR2I	IntersectLines (const SEG &aSeg) const
	Compute the intersection point of lines passing through ends of (this) and aSeg. More...
SEG	PerpendicularSeg (const VECTOR2I &aP) const
	Compute a segment perpendicular to this one, passing through point aP. More...
SEG	ParallelSeg (const VECTOR2I &aP) const
	Compute a segment parallel to this one, passing through point aP. More...
bool	Collide (const SEG &aSeg, int aClearance, int *aActual=nullptr) const
ecoord	SquaredDistance (const SEG &aSeg) const
int	Distance (const SEG &aSeg) const
	Compute minimum Euclidean distance to segment aSeg. More...
ecoord	SquaredDistance (const VECTOR2I &aP) const
int	Distance (const VECTOR2I &aP) const
	Compute minimum Euclidean distance to point aP. More...
void	CanonicalCoefs (ecoord &qA, ecoord &qB, ecoord &qC) const
bool	Collinear (const SEG &aSeg) const
	Check if segment aSeg lies on the same line as (this). More...
bool	ApproxCollinear (const SEG &aSeg) const
bool	ApproxParallel (const SEG &aSeg) const
bool	ApproxPerpendicular (const SEG &aSeg) const
bool	Overlaps (const SEG &aSeg) const
bool	Contains (const SEG &aSeg) const
int	Length () const
	Return the length (this). More...
ecoord	SquaredLength () const
ecoord	TCoef (const VECTOR2I &aP) const
int	Index () const
	Return the index of this segment in its parent shape (applicable only to non-local segments). More...
bool	Contains (const VECTOR2I &aP) const
void	Reverse ()
SEG	Reversed () const
	Returns the center point of the line. More...
VECTOR2I	Center () const

Static Public Member Functions
static SEG::ecoord	Square (int a)

Public Attributes
VECTOR2I	A
VECTOR2I	B

Private Member Functions
bool	ccw (const VECTOR2I &aA, const VECTOR2I &aB, const VECTOR2I &aC) const

Private Attributes
int	m_index
	< index withing the parent shape (used when m_is_local == false) More...

Friends
std::ostream &	operator<< (std::ostream &aStream, const SEG &aSeg)

Detailed Description

Definition at line 41 of file seg.h.

Member Typedef Documentation

ecoord

using SEG::ecoord = VECTOR2I::extended_type

Definition at line 44 of file seg.h.

Constructor & Destructor Documentation

SEG() [1/5]

SEG::SEG ( )

inline

Create an empty (0, 0) segment.

Definition at line 55 of file seg.h.

    {
        m_index = -1;
    }

References m_index.

Referenced by ParallelSeg(), PerpendicularSeg(), and Reversed().

SEG() [2/5]

SEG::SEG ( int  aX1, int  aY1, int  aX2, int  aY2  )

inline

Create a segment between (aX1, aY1) and (aX2, aY2).

Definition at line 63 of file seg.h.

                                              :
        A( VECTOR2I( aX1, aY1 ) ),
        B( VECTOR2I( aX2, aY2 ) )
    {
        m_index = -1;
    }

References m_index.

SEG() [3/5]

SEG::SEG ( const VECTOR2I &  aA, const VECTOR2I &  aB  )

inline

Create a segment between (aA) and (aB).

Definition at line 73 of file seg.h.

                                                  :
        A( aA ),
        B( aB )
    {
        m_index = -1;
    }

References m_index.

SEG() [4/5]

SEG::SEG ( const VECTOR2I &  aA, const VECTOR2I &  aB, int  aIndex  )

inline

Create a segment between (aA) and (aB), referenced to a multi-segment shape.

Parameters

aA	reference to the start point in the parent shape
aB	reference to the end point in the parent shape
aIndex	index of the segment within the parent shape

Definition at line 87 of file seg.h.

                                                              :
        A( aA ),
        B( aB )
    {
        m_index = aIndex;
    }

References m_index.

SEG() [5/5]

SEG::SEG ( const SEG &  aSeg )

inline

Copy constructor.

Definition at line 97 of file seg.h.

                           :
        A( aSeg.A ),
        B( aSeg.B ),
        m_index( aSeg.m_index )
    {
    }

Member Function Documentation

AngleDegrees()

double SEG::AngleDegrees

(

const SEG &

aOther

)

const

Determine the smallest angle between two segments (result in degrees)

Parameters

aOther

point to determine the orientation wrs to self

Returns

smallest angle between this and aOther (degrees)

Definition at line 64 of file seg.cpp.

{
    VECTOR2I thisVec = A - B;
    VECTOR2I otherVec = aOther.A - aOther.B;

    double thisVecAngle = NormalizeAngle180( RAD2DECIDEG( thisVec.Angle() ) );
    double otherVecAngle = NormalizeAngle180( RAD2DECIDEG( otherVec.Angle() ) );
    double angleDegrees = std::abs( NormalizeAngle180( thisVecAngle - otherVecAngle ) ) / 10.0;

    return std::min( 180.0 - angleDegrees, angleDegrees );
}

References A, VECTOR2< T >::Angle(), B, NormalizeAngle180(), and RAD2DECIDEG().

ApproxCollinear()

bool SEG::ApproxCollinear ( const SEG &  aSeg ) const

inline

Definition at line 284 of file seg.h.

    {
        ecoord p, q, r;
        CanonicalCoefs( p, q, r );

        ecoord dist1 = ( p * aSeg.A.x + q * aSeg.A.y + r ) / sqrt( p * p + q * q );
        ecoord dist2 = ( p * aSeg.B.x + q * aSeg.B.y + r ) / sqrt( p * p + q * q );

        return std::abs( dist1 ) <= 1 && std::abs( dist2 ) <= 1;
    }

References A, B, CanonicalCoefs(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by TRACK::ApproxCollinear().

ApproxParallel()

bool SEG::ApproxParallel ( const SEG &  aSeg ) const

inline

Definition at line 295 of file seg.h.

    {
        ecoord p, q, r;
        CanonicalCoefs( p, q, r );

        ecoord dist1 = ( p * aSeg.A.x + q * aSeg.A.y + r ) / sqrt( p * p + q * q );
        ecoord dist2 = ( p * aSeg.B.x + q * aSeg.B.y + r ) / sqrt( p * p + q * q );

        return std::abs( dist1 - dist2 ) <= 1;
    }

References A, B, CanonicalCoefs(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ApproxPerpendicular(), PNS::MEANDERED_LINE::CheckSelfIntersections(), CIRCLE::ConstructFromTanTanPt(), PNS::DIFF_PAIR::CoupledLength(), PNS::DIFF_PAIR::CoupledSegmentPairs(), PNS::DP_PRIMITIVE_PAIR::CursorOrientation(), PNS::findCoupledVertices(), and SegParallelCorrect().

ApproxPerpendicular()

bool SEG::ApproxPerpendicular ( const SEG &  aSeg ) const

inline

Definition at line 306 of file seg.h.

    {
        SEG perp = PerpendicularSeg( A );

        return aSeg.ApproxParallel( perp );
    }

References ApproxParallel(), and PerpendicularSeg().

Referenced by SegPerpendicularCorrect().

CanonicalCoefs()

void SEG::CanonicalCoefs ( ecoord &  qA, ecoord &  qB, ecoord &  qC  ) const

inline

Definition at line 260 of file seg.h.

    {
        qA = ecoord{ A.y } - B.y;
        qB = ecoord{ B.x } - A.x;
        qC = -qA * A.x - qB * A.y;
    }

Referenced by ApproxCollinear(), ApproxParallel(), and Collinear().

ccw()

bool SEG::ccw ( const VECTOR2I &  aA, const VECTOR2I &  aB, const VECTOR2I &  aC  ) const

private

Definition at line 166 of file seg.cpp.

{
    return (ecoord) ( aC.y - aA.y ) * ( aB.x - aA.x ) > (ecoord) ( aB.y - aA.y ) * ( aC.x - aA.x );
}

References VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Collide().

Center()

VECTOR2I SEG::Center ( ) const

inline

Definition at line 391 of file seg.h.

    {
        return A + ( B - A ) / 2;
    }

References A.

Referenced by PCB_GRID_HELPER::computeAnchors(), SCH_EAGLE_PLUGIN::findNearestLinePoint(), and SHAPE_ARC::SHAPE_ARC().

Collide()

bool SEG::Collide	(	const SEG &	aSeg,
		int	aClearance,
		int *	aActual = nullptr
	)		const

Definition at line 172 of file seg.cpp.

{
    // check for intersection
    // fixme: move to a method
    if( ccw( A, aSeg.A, aSeg.B ) != ccw( B, aSeg.A, aSeg.B ) &&
            ccw( A, B, aSeg.A ) != ccw( A, B, aSeg.B ) )
    {
        if( aActual )
            *aActual = 0;

        return true;
    }

    ecoord dist_sq = VECTOR2I::ECOORD_MAX;

    dist_sq = std::min( dist_sq, SquaredDistance( aSeg.A ) );
    dist_sq = std::min( dist_sq, SquaredDistance( aSeg.B ) );
    dist_sq = std::min( dist_sq, aSeg.SquaredDistance( A ) );
    dist_sq = std::min( dist_sq, aSeg.SquaredDistance( B ) );

    if( dist_sq == 0 || dist_sq < (ecoord) aClearance * aClearance )
    {
        if( aActual )
            *aActual = sqrt( dist_sq );

        return true;
    }

    return false;
}

References A, B, ccw(), VECTOR2< T >::ECOORD_MAX, and SquaredDistance().

Referenced by SHAPE_POLY_SET::IsPolygonSelfIntersecting(), SegCollideCorrect(), and BOARD::TestZoneIntersection().

Collinear()

bool SEG::Collinear ( const SEG &  aSeg ) const

inline

Check if segment aSeg lies on the same line as (this).

Parameters

aSeg	the segment to check colinearity with

Returns

true, when segments are collinear.

Definition at line 273 of file seg.h.

    {
        ecoord qa, qb, qc;
        CanonicalCoefs( qa, qb, qc );

        ecoord d1 = std::abs( aSeg.A.x * qa + aSeg.A.y * qb + qc );
        ecoord d2 = std::abs( aSeg.B.x * qa + aSeg.B.y * qb + qc );

        return ( d1 <= 1 && d2 <= 1 );
    }

References A, B, CanonicalCoefs(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PNS::DP_GATEWAYS::BuildGeneric(), Contains(), SHAPE_LINE_CHAIN::Intersect(), PNS::OPTIMIZER::mergeColinear(), Overlaps(), SegCollinearCorrect(), and POLYGON_GEOM_MANAGER::updateLeaderPoints().

Contains() [1/2]

bool SEG::Contains ( const SEG &  aSeg ) const

inline

Definition at line 336 of file seg.h.

    {
        if( aSeg.A == aSeg.B ) // single point corner case
            return Contains( aSeg.A );

        if( !Collinear( aSeg ) )
            return false;

        if( Contains( aSeg.A ) && Contains( aSeg.B ) )
            return true;

        return false;
    }

References A, B, and Collinear().

Referenced by PNS::TOPOLOGY::AssembleTuningPath(), BuildFootprintPolygonOutlines(), PNS::LINE::ChangedArea(), findEndSegments(), SHAPE_LINE_CHAIN::Intersect(), PNS::MEANDERED_LINE::MeanderSegment(), and Overlaps().

Contains() [2/2]

bool SEG::Contains

(

const VECTOR2I &

aP

)

const

Definition at line 204 of file seg.cpp.

{
    return SquaredDistance( aP ) <= 1;       // 1 * 1 to be pedantic
}

References SquaredDistance().

Distance() [1/2]

int SEG::Distance ( const SEG &  aSeg ) const

inline

Compute minimum Euclidean distance to segment aSeg.

Parameters

aSeg	other segment

Returns

minimum distance

Definition at line 239 of file seg.h.

    {
        return sqrt( SquaredDistance( aSeg ) );
    }

References SquaredDistance().

Referenced by PNS::MOUSE_TRAIL_TRACER::AddTrailPoint(), PCB_GRID_HELPER::AlignToSegment(), SHAPE_LINE_CHAIN::CheckClearance(), PNS::checkGap(), Collide(), SHAPE_POLY_SET::CollideEdge(), PNS::DIFF_PAIR::CoupledLength(), PNS::DIFF_PAIR::CoupledSegmentPairs(), SHAPE_LINE_CHAIN_BASE::EdgeContainingPoint(), SHAPE_LINE_CHAIN::FindSegment(), SHAPE_LINE_CHAIN::NearestPoint(), SHAPE_LINE_CHAIN::NearestSegment(), SHAPE_LINE_CHAIN::PathLength(), pushoutForce(), SegDistanceCorrect(), SegVecDistanceCorrect(), and SHAPE_LINE_CHAIN::Split().

Distance() [2/2]

int SEG::Distance ( const VECTOR2I &  aP ) const

inline

Compute minimum Euclidean distance to point aP.

Parameters

aP

the point

Returns

minimum distance

Definition at line 255 of file seg.h.

    {
        return sqrt( SquaredDistance( aP ) );
    }

References SquaredDistance().

Index()

int SEG::Index ( ) const

inline

Return the index of this segment in its parent shape (applicable only to non-local segments).

Returns

index value

Definition at line 373 of file seg.h.

    {
        return m_index;
    }

References m_index.

Referenced by addIntersection(), PNS::OPTIMIZER::mergeDpStep(), PNS::OPTIMIZER::mergeObtuse(), and PNS::OPTIMIZER::mergeStep().

Intersect()

OPT_VECTOR2I SEG::Intersect	(	const SEG &	aSeg,
		bool	aIgnoreEndpoints = false,
		bool	aLines = false
	)		const

Compute intersection point of segment (this) with segment aSeg.

Parameters

aSeg	segment to intersect with
aIgnoreEndpoints	don't treat corner cases (i.e. end of one segment touching the other) as intersections.
aLines	treat segments as infinite lines

Returns

intersection point, if exists

Definition at line 119 of file seg.cpp.

{
    const VECTOR2I  e( B - A );
    const VECTOR2I  f( aSeg.B - aSeg.A );
    const VECTOR2I  ac( aSeg.A - A );

    ecoord d = f.Cross( e );
    ecoord p = f.Cross( ac );
    ecoord q = e.Cross( ac );

    if( d == 0 )
        return OPT_VECTOR2I();

    if( !aLines && d > 0 && ( q < 0 || q > d || p < 0 || p > d ) )
        return OPT_VECTOR2I();

    if( !aLines && d < 0 && ( q < d || p < d || p > 0 || q > 0 ) )
        return OPT_VECTOR2I();

    if( !aLines && aIgnoreEndpoints && ( q == 0 || q == d ) && ( p == 0 || p == d ) )
        return OPT_VECTOR2I();

    VECTOR2I ip( aSeg.A.x + rescale( q, (ecoord) f.x, d ),
                 aSeg.A.y + rescale( q, (ecoord) f.y, d ) );

     return ip;
}

References A, B, VECTOR2< T >::Cross(), rescale(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EC_CONVERGING::Apply(), PNS::LINE::dragSegment45(), ALTIUM_PCB::HelperParseDimensions6Linear(), SHAPE_LINE_CHAIN::Intersect(), IntersectLines(), SCH_EAGLE_PLUGIN::loadSegments(), NearestPoint(), SHAPE_LINE_CHAIN::SelfIntersecting(), SHAPE_ARC::SHAPE_ARC(), and SquaredDistance().

IntersectLines()

OPT_VECTOR2I SEG::IntersectLines ( const SEG &  aSeg ) const

inline

Compute the intersection point of lines passing through ends of (this) and aSeg.

Parameters

aSeg	segment defining the line to intersect with

Returns

intersection point, if exists

Definition at line 208 of file seg.h.

    {
        return Intersect( aSeg, false, true );
    }

References Intersect().

Referenced by PCB_GRID_HELPER::AlignToSegment(), BuildFootprintPolygonOutlines(), PNS::DP_GATEWAYS::BuildGeneric(), CIRCLE::ConstructFromTanTanPt(), PNS::ConvexHull(), EDIT_TOOL::DragArcTrack(), PNS::OPTIMIZER::mergeObtuse(), and PNS::LINE::snapDraggedCorner().

Length()

int SEG::Length ( ) const

inline

Return the length (this).

Returns

length

Definition at line 355 of file seg.h.

    {
        return ( A - B ).EuclideanNorm();
    }

Referenced by PNS::MEANDER_SHAPE::BaselineLength(), PNS::DIFF_PAIR::CoupledLength(), PNS::dragCornerInternal(), PCB_SHAPE::GetLength(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), BOARD::GetTrackLength(), PNS::LINE::Is45Degree(), SHAPE_LINE_CHAIN::Length(), PNS::MEANDERED_LINE::MeanderSegment(), SHAPE_LINE_CHAIN::PathLength(), SHAPE_LINE_CHAIN::PointAlong(), SHAPE_ARC::SHAPE_ARC(), and PNS::tightenSegment().

LineDistance()

int SEG::LineDistance ( const VECTOR2I &  aP, bool  aDetermineSide = false  ) const

inline

Return the closest Euclidean distance between point aP and the line defined by the ends of segment (this).

Parameters

aP	the point to test
aDetermineSide	when true, the sign of the returned value indicates the side of the line at which we are (negative = left)

Returns

the distance

Definition at line 420 of file seg.h.

{
    ecoord p = ecoord{ A.y } - B.y;
    ecoord q = ecoord{ B.x } - A.x;
    ecoord r = -p * A.x - q * A.y;

    ecoord dist = ( p * aP.x + q * aP.y + r ) / sqrt( p * p + q * q );

    return aDetermineSide ? dist : std::abs( dist );
}

References VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CIRCLE::ConstructFromTanTanPt(), SHAPE_LINE_CHAIN::NearestPoint(), and PNS::LINE::snapToNeighbourSegments().

LineProject()

VECTOR2I SEG::LineProject ( const VECTOR2I &  aP ) const

inline

Compute the perpendicular projection point of aP on a line passing through ends of the segment.

Parameters

aP	point to project

Returns

projected point

Definition at line 404 of file seg.h.

{
    VECTOR2I d = B - A;
    ecoord l_squared = d.Dot( d );

    if( l_squared == 0 )
        return A;

    ecoord t = d.Dot( aP - A );

    int xp = rescale( t, ecoord{ d.x }, l_squared );
    int yp = rescale( t, ecoord{ d.y }, l_squared );

    return A + VECTOR2I( xp, yp );
}

References A, VECTOR2< T >::Dot(), rescale(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PNS::LINE_PLACER::buildInitialLine(), PNS::DP_GATEWAYS::BuildOrthoProjections(), commonParallelProjection(), PNS::commonParallelProjection(), CIRCLE::ConstructFromTanTanPt(), EDIT_TOOL::DragArcTrack(), PNS::findCoupledVertices(), CIRCLE::IntersectLine(), PNS::DIFF_PAIR_PLACER::routeHead(), SHAPE_ARC::SHAPE_ARC(), and PNS::MEANDER_SHAPE::updateBaseSegment().

NearestPoint() [1/2]

const VECTOR2I SEG::NearestPoint ( const VECTOR2I &  aP ) const

inline

Compute a point on the segment (this) that is closest to point aP.

Returns

the nearest point

Definition at line 437 of file seg.h.

{
    VECTOR2I d = B - A;
    ecoord l_squared = d.Dot( d );

    if( l_squared == 0 )
        return A;

    ecoord t = d.Dot( aP - A );

    if( t < 0 )
        return A;
    else if( t > l_squared )
        return B;

    int xp = rescale( t, (ecoord)d.x, l_squared );
    int yp = rescale( t, (ecoord)d.y, l_squared );

    return A + VECTOR2I( xp, yp );
}

References A, B, VECTOR2< T >::Dot(), rescale(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_POINT_EDITOR::addCorner(), PNS::closestProjectedPoint(), Collide(), SHAPE_CIRCLE::Collide(), SHAPE_SEGMENT::Collide(), SHAPE_RECT::Collide(), SHAPE_LINE_CHAIN_BASE::Collide(), EDIT_TOOL::DragArcTrack(), NearestPoint(), SHAPE_LINE_CHAIN::NearestPoint(), pushoutForce(), PNS::WALKAROUND::Route(), and SquaredDistance().

NearestPoint() [2/2]

const VECTOR2I SEG::NearestPoint

(

const SEG &

aSeg

)

const

Compute a point on the segment (this) that is closest to any point on aSeg.

Returns

the nearest point

Definition at line 77 of file seg.cpp.

{
    if( OPT_VECTOR2I p = Intersect( aSeg ) )
        return *p;

    const VECTOR2I pts_origin[4] =
    {
            aSeg.NearestPoint( A ),
            aSeg.NearestPoint( B ),
            NearestPoint( aSeg.A ),
            NearestPoint( aSeg.B )
    };


    const VECTOR2I* pts_out[4] =
    {
            &A,
            &B,
            &pts_origin[2],
            &pts_origin[3]
    };

    const ecoord pts_dist[4] =
    {
            ( pts_origin[0] - A ).SquaredEuclideanNorm(),
            ( pts_origin[1] - B ).SquaredEuclideanNorm(),
            ( pts_origin[2] - aSeg.A ).SquaredEuclideanNorm(),
            ( pts_origin[3] - aSeg.B ).SquaredEuclideanNorm()
    };

    int min_i = 0;

    for( int i = 0; i < 4; i++ )
    {
        if( pts_dist[i] < pts_dist[min_i] )
            min_i = i;
    }

    return *pts_out[min_i];
}

References A, B, Intersect(), and NearestPoint().

operator!=()

bool SEG::operator!= ( const SEG &  aSeg ) const

inline

Definition at line 118 of file seg.h.

    {
        return (A != aSeg.A || B != aSeg.B);
    }

References A, and B.

operator=()

SEG& SEG::operator= ( const SEG &  aSeg )

inline

Definition at line 104 of file seg.h.

    {
        A = aSeg.A;
        B = aSeg.B;
        m_index = aSeg.m_index;

        return *this;
    }

References A, B, and m_index.

operator==()

bool SEG::operator== ( const SEG &  aSeg ) const

inline

Definition at line 113 of file seg.h.

    {
        return (A == aSeg.A && B == aSeg.B) ;
    }

References A, and B.

Overlaps()

bool SEG::Overlaps ( const SEG &  aSeg ) const

inline

Definition at line 313 of file seg.h.

    {
        if( aSeg.A == aSeg.B ) // single point corner case
        {
            if( A == aSeg.A || B == aSeg.A )
                return false;

            return Contains( aSeg.A );
        }

        if( !Collinear( aSeg ) )
            return false;

        if( Contains( aSeg.A ) || Contains( aSeg.B ) )
            return true;

        if( aSeg.Contains( A ) || aSeg.Contains( B ) )
            return true;

        return false;
    }

References A, B, Collinear(), and Contains().

ParallelSeg()

SEG SEG::ParallelSeg

(

const VECTOR2I &

aP

)

const

Compute a segment parallel to this one, passing through point aP.

Parameters

aP	Point through which the new segment will pass

Returns

SEG parallel to this passing through point aP

Definition at line 157 of file seg.cpp.

{
    VECTOR2I slope( B - A );
    VECTOR2I endPoint = slope + aP;

    return SEG( aP, endPoint );
}

References SEG().

Referenced by BOOST_AUTO_TEST_CASE(), and CIRCLE::ConstructFromTanTanPt().

PerpendicularSeg()

SEG SEG::PerpendicularSeg

(

const VECTOR2I &

aP

)

const

Compute a segment perpendicular to this one, passing through point aP.

Parameters

aP	Point through which the new segment will pass

Returns

SEG perpendicular to this passing through point aP

Definition at line 148 of file seg.cpp.

{
    VECTOR2I slope( B - A );
    VECTOR2I endPoint = slope.Perpendicular() + aP;

    return SEG( aP, endPoint );
}

References VECTOR2< T >::Perpendicular(), and SEG().

Referenced by ApproxPerpendicular(), BOOST_AUTO_TEST_CASE(), and CIRCLE::ConstructFromTanTanPt().

ReflectPoint()

const VECTOR2I SEG::ReflectPoint ( const VECTOR2I &  aP ) const

inline

Reflect a point using this segment as axis.

Returns

the reflected point

Definition at line 458 of file seg.h.

{
    VECTOR2I                d = B - A;
    VECTOR2I::extended_type l_squared = d.Dot( d );
    VECTOR2I::extended_type t = d.Dot( aP - A );
    VECTOR2I                c;

    if( !l_squared )
        c = aP;
    else
    {
        c.x = A.x + rescale( t, static_cast<VECTOR2I::extended_type>( d.x ), l_squared );
        c.y = A.y + rescale( t, static_cast<VECTOR2I::extended_type>( d.y ), l_squared );
    }

    return 2 * c - aP;
}

References A, VECTOR2< T >::Dot(), rescale(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SHAPE_ARC::Mirror(), and SHAPE_LINE_CHAIN::Mirror().

Reverse()

void SEG::Reverse ( )

inline

Definition at line 380 of file seg.h.

    {
        std::swap( A, B );
    }

Reversed()

SEG SEG::Reversed ( ) const

inline

Returns the center point of the line.

Definition at line 385 of file seg.h.

References SEG().

Referenced by PNS::LINE_PLACER::Start().

Side()

int SEG::Side ( const VECTOR2I &  aP ) const

inline

Determine on which side of directed line passing via segment ends point aP lies.

Parameters

aP	point to determine the orientation wrs to self

Returns

: < 0: left, 0 : on the line, > 0 : right

Definition at line 143 of file seg.h.

    {
        const ecoord det = ( B - A ).Cross( aP - A );

        return det < 0 ? -1 : ( det > 0 ? 1 : 0 );
    }

References A.

Referenced by PNS::ArcHull(), PNS::DP_GATEWAYS::buildDpContinuation(), EDIT_TOOL::DragArcTrack(), PNS::DP_MEANDER_PLACER::pairOrientation(), and PNS::SegmentHull().

Square()

static SEG::ecoord SEG::Square ( int  a )

inlinestatic

Definition at line 123 of file seg.h.

    {
        return ecoord( a ) * a;
    }

Referenced by close_enough(), Collide(), SHAPE_CIRCLE::Collide(), SHAPE_SEGMENT::Collide(), SHAPE_ARC::Collide(), SHAPE_RECT::Collide(), SHAPE_LINE_CHAIN_BASE::Collide(), SHAPE_POLY_SET::Collide(), findNext(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), PAD::HitTest(), PNS::TOOL_BASE::snapToItem(), and TestSegmentHit().

SquaredDistance() [1/2]

SEG::ecoord SEG::SquaredDistance

(

const SEG &

aSeg

)

const

Definition at line 39 of file seg.cpp.

{
    // fixme: rather inefficient....
    if( Intersect( aSeg ) )
        return 0;

    const VECTOR2I pts[4] =
    {
        aSeg.NearestPoint( A ) - A,
        aSeg.NearestPoint( B ) - B,
        NearestPoint( aSeg.A ) - aSeg.A,
        NearestPoint( aSeg.B ) - aSeg.B
    };

    ecoord m = VECTOR2I::ECOORD_MAX;

    for( int i = 0; i < 4; i++ )
    {
        m = std::min( m, pts[i].SquaredEuclideanNorm() );
    }

    return m;
}

References A, B, VECTOR2< T >::ECOORD_MAX, Intersect(), and NearestPoint().

Referenced by PNS::PRESERVE_VERTEX_CONSTRAINT::Check(), SHAPE_SEGMENT::Collide(), SHAPE_ARC::Collide(), SHAPE_RECT::Collide(), Collide(), SHAPE_LINE_CHAIN_BASE::Collide(), Contains(), Distance(), SHAPE_LINE_CHAIN_BASE::SquaredDistance(), and TestSegmentHit().

SquaredDistance() [2/2]

ecoord SEG::SquaredDistance ( const VECTOR2I &  aP ) const

inline

Definition at line 244 of file seg.h.

    {
        return ( NearestPoint( aP ) - aP ).SquaredEuclideanNorm();
    }

References NearestPoint().

SquaredLength()

ecoord SEG::SquaredLength ( ) const

inline

Definition at line 360 of file seg.h.

    {
        return ( A - B ).SquaredEuclideanNorm();
    }

Referenced by commonParallelProjection(), PNS::commonParallelProjection(), PNS::OPTIMIZER::mergeColinear(), and POLYGON_GEOM_MANAGER::updateLeaderPoints().

TCoef()

SEG::ecoord SEG::TCoef ( const VECTOR2I &  aP ) const

inline

Definition at line 431 of file seg.h.

{
    VECTOR2I d = B - A;
    return d.Dot( aP - A);
}

References A, and VECTOR2< T >::Dot().

Referenced by commonParallelProjection(), and PNS::commonParallelProjection().

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  aStream, const SEG &  aSeg  )

friend

Definition at line 476 of file seg.h.

{
    aStream << "[ " << aSeg.A << " - " << aSeg.B << " ]";

    return aStream;
}

Member Data Documentation

A

VECTOR2I SEG::A

Definition at line 49 of file seg.h.

Referenced by PNS::NODE::Add(), PNS_KICAD_IFACE::AddItem(), PNS_TEST_DEBUG_DECORATOR::AddSegment(), PNS::NODE::addSegment(), PNS_PCBNEW_DEBUG_DECORATOR::AddSegment(), BOARD_ADAPTER::addShapeWithClearance(), PCB_GRID_HELPER::AlignToSegment(), PNS::SEGMENT::Anchor(), AngleDegrees(), ApproxCollinear(), PNS::ApproximateSegmentAsRect(), ApproxParallel(), PNS::DP_MEANDER_PLACER::baselineSegment(), SHAPE_SEGMENT::BBox(), BOOST_AUTO_TEST_CASE(), PNS::DP_GATEWAYS::BuildFromPrimitivePair(), Center(), SHAPE_LINE_CHAIN::CheckClearance(), PNS::SEGMENT::CLine(), SHAPE_ARC::Collide(), SHAPE_RECT::Collide(), Collide(), SHAPE_LINE_CHAIN_BASE::Collide(), Collinear(), commonParallelProjection(), PNS::commonParallelProjection(), PCB_GRID_HELPER::computeAnchors(), PNS::TOPOLOGY::ConnectedJoints(), CIRCLE::ConstructFromTanTanPt(), Contains(), BOARD_ADAPTER::createPadWithClearance(), BOARD_ADAPTER::createPadWithDrill(), PNS::DP_PRIMITIVE_PAIR::CursorOrientation(), PNS::MEANDER_PLACER_BASE::cutTunedLine(), DIRECTION_45::DIRECTION_45(), PNS::MEANDER_PLACER::doMove(), EDIT_TOOL::DragArcTrack(), PNS::LINE::dragSegment45(), KIGFX::PCB_PAINTER::draw(), ROUTER_PREVIEW_ITEM::drawLineChain(), KI_TEST::DrawSegment(), ROUTER_PREVIEW_ITEM::drawShape(), SHAPE_LINE_CHAIN_BASE::EdgeContainingPoint(), extractDiffPairCoupledItems(), findEndSegments(), PNS::NODE::findRedundantSegment(), PNS::MEANDER_SHAPE::Fit(), SHAPE_SEGMENT::Format(), PNS::getDanglingAnchor(), PNS::LINE_PLACER::handlePullback(), PNS::LINE_PLACER::handleSelfIntersections(), ZONE::HatchBorder(), CIRCLE::Intersect(), Intersect(), SHAPE_LINE_CHAIN::Intersect(), CIRCLE::IntersectLine(), PNS::LINE::Is45Degree(), KIGFX::VIEW_OVERLAY::Line(), LineProject(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), PNS::MEANDER_SHAPE::MakeCorner(), PCB_SHAPE::MakeEffectiveShapes(), PNS::MEANDER_SHAPE::MakeEmpty(), PNS::MEANDERED_LINE::MeanderSegment(), PNS::OPTIMIZER::mergeDpStep(), PNS::OPTIMIZER::mergeObtuse(), PNS::OPTIMIZER::mergeStep(), ZONE::Mirror(), SHAPE_SEGMENT::Move(), ZONE::Move(), PNS::MoveDiagonal(), NearestPoint(), operator!=(), POLY_GRID_PARTITION::segsEqual::operator()(), POLY_GRID_PARTITION::segHash::operator()(), operator<<(), operator=(), operator==(), Overlaps(), DIALOG_PAD_PROPERTIES::padValuesOK(), PNS::DP_MEANDER_PLACER::pairOrientation(), SHAPE_LINE_CHAIN::PathLength(), BRDITEMS_PLOTTER::PlotDimension(), PlotLayerOutlines(), SHAPE_LINE_CHAIN::PointAlong(), PNS::MEANDER_SHAPE::Recalculate(), PNS::LINE_PLACER::reduceTail(), ReflectPoint(), PNS::NODE::removeSegmentIndex(), ZONE::Rotate(), PNS::WALKAROUND::Route(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), POLY_GRID_PARTITION::scanCell(), DIMENSION_BASE::segCircleIntersection(), GEOM_TEST::SegmentCompletelyInQuadrant(), GEOM_TEST::SegmentCompletelyWithinRadius(), GEOM_TEST::SegmentEndsInQuadrant(), PNS::SegmentHull(), DIMENSION_BASE::segPolyIntersection(), SHAPE_LINE_CHAIN::SelfIntersecting(), SHAPE_ARC::SHAPE_ARC(), Side(), PNS::LINE::snapToNeighbourSegments(), SHAPE_LINE_CHAIN::Split(), PNS::LINE_PLACER::SplitAdjacentSegments(), SquaredDistance(), SHAPE_POLY_SET::SquaredDistanceToPolygon(), PNS::LINE_PLACER::Start(), PNS::DRAGGER::startDragSegment(), PNS::SEGMENT::SwapEnds(), TCoef(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZones(), PNS::tightenSegment(), TransformArcToPolygon(), PAD::TransformHoleWithClearanceToPolygon(), unfracture(), SHAPE_POLY_SET::unfractureSingle(), PNS::MEANDER_SHAPE::updateBaseSegment(), ALIGNED_DIMENSION::updateGeometry(), ORTHOGONAL_DIMENSION::updateGeometry(), and PNS_KICAD_IFACE::UpdateItem().

B

VECTOR2I SEG::B

Definition at line 50 of file seg.h.

Referenced by PNS::NODE::Add(), PNS_KICAD_IFACE::AddItem(), PNS::MEANDERED_LINE::AddMeander(), PNS_TEST_DEBUG_DECORATOR::AddSegment(), PNS::NODE::addSegment(), PNS_PCBNEW_DEBUG_DECORATOR::AddSegment(), BOARD_ADAPTER::addShapeWithClearance(), PCB_GRID_HELPER::AlignToSegment(), PNS::SEGMENT::Anchor(), AngleDegrees(), ApproxCollinear(), PNS::ApproximateSegmentAsRect(), ApproxParallel(), PNS::DP_MEANDER_PLACER::baselineSegment(), SHAPE_SEGMENT::BBox(), BOOST_AUTO_TEST_CASE(), POLY_GRID_PARTITION::build(), PNS::DP_GATEWAYS::BuildFromPrimitivePair(), SHAPE_LINE_CHAIN::CheckClearance(), PNS::SEGMENT::CLine(), SHAPE_ARC::Collide(), SHAPE_RECT::Collide(), Collide(), Collinear(), commonParallelProjection(), PNS::commonParallelProjection(), PCB_GRID_HELPER::computeAnchors(), PNS::TOPOLOGY::ConnectedJoints(), CIRCLE::ConstructFromTanTanPt(), Contains(), BOARD_ADAPTER::createPadWithClearance(), BOARD_ADAPTER::createPadWithDrill(), PNS::DP_PRIMITIVE_PAIR::CursorOrientation(), PNS::MEANDER_PLACER_BASE::cutTunedLine(), DIRECTION_45::DIRECTION_45(), PNS::MEANDER_PLACER::doMove(), EDIT_TOOL::DragArcTrack(), PNS::LINE::dragSegment45(), KIGFX::PCB_PAINTER::draw(), ROUTER_PREVIEW_ITEM::drawLineChain(), KI_TEST::DrawSegment(), ROUTER_PREVIEW_ITEM::drawShape(), SHAPE_LINE_CHAIN_BASE::EdgeContainingPoint(), PNS::MEANDER_SHAPE::End(), findEndSegments(), SCH_EAGLE_PLUGIN::findNearestLinePoint(), PNS::NODE::findRedundantSegment(), PNS::MEANDER_SHAPE::Fit(), SHAPE_SEGMENT::Format(), PNS::getDanglingAnchor(), ZONE::HatchBorder(), CIRCLE::Intersect(), Intersect(), SHAPE_LINE_CHAIN::Intersect(), CIRCLE::IntersectLine(), PNS::LINE::Is45Degree(), KIGFX::VIEW_OVERLAY::Line(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), PNS::MEANDER_SHAPE::MakeCorner(), PCB_SHAPE::MakeEffectiveShapes(), PNS::MEANDER_SHAPE::MakeEmpty(), PNS::MEANDERED_LINE::MeanderSegment(), PNS::OPTIMIZER::mergeDpStep(), PNS::LINE_PLACER::mergeHead(), PNS::OPTIMIZER::mergeObtuse(), PNS::OPTIMIZER::mergeStep(), ZONE::Mirror(), SHAPE_SEGMENT::Move(), ZONE::Move(), PNS::MoveDiagonal(), NearestPoint(), operator!=(), POLY_GRID_PARTITION::segsEqual::operator()(), POLY_GRID_PARTITION::segHash::operator()(), operator<<(), operator=(), operator==(), Overlaps(), DIALOG_PAD_PROPERTIES::padValuesOK(), BRDITEMS_PLOTTER::PlotDimension(), PlotLayerOutlines(), SHAPE_LINE_CHAIN::PointAlong(), PNS::MEANDER_SHAPE::Recalculate(), PNS::NODE::removeSegmentIndex(), ZONE::Rotate(), PNS::WALKAROUND::Route(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), POLY_GRID_PARTITION::scanCell(), DIMENSION_BASE::segCircleIntersection(), GEOM_TEST::SegmentCompletelyInQuadrant(), GEOM_TEST::SegmentCompletelyWithinRadius(), GEOM_TEST::SegmentEndsInQuadrant(), PNS::SegmentHull(), DIMENSION_BASE::segPolyIntersection(), SHAPE_LINE_CHAIN::SelfIntersecting(), SHAPE_ARC::SHAPE_ARC(), SHAPE_LINE_CHAIN::Split(), PNS::LINE_PLACER::SplitAdjacentSegments(), SquaredDistance(), SHAPE_POLY_SET::SquaredDistanceToPolygon(), PNS::LINE_PLACER::Start(), PNS::DRAGGER::startDragSegment(), PNS::SEGMENT::SwapEnds(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZones(), PNS::tightenSegment(), TransformArcToPolygon(), PAD::TransformHoleWithClearanceToPolygon(), unfracture(), SHAPE_POLY_SET::unfractureSingle(), PNS::MEANDER_SHAPE::updateBaseSegment(), ALIGNED_DIMENSION::updateGeometry(), ORTHOGONAL_DIMENSION::updateGeometry(), PNS_KICAD_IFACE::UpdateItem(), and POLYGON_GEOM_MANAGER::updateLeaderPoints().

m_index

int SEG::m_index

private

< index withing the parent shape (used when m_is_local == false)

Definition at line 401 of file seg.h.

Referenced by Index(), operator=(), and SEG().

---

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

• seg.h
• seg.cpp