POLYGON_4PT_2D Class Reference

Simple non-intersecting polygon with 4 points. More...

#include <4pt_polygon_2d.h>

Inheritance diagram for POLYGON_4PT_2D:

Public Member Functions
	POLYGON_4PT_2D (const SFVEC2F &v1, const SFVEC2F &v2, const SFVEC2F &v3, const SFVEC2F &v4, const BOARD_ITEM &aBoardItem)
const SFVEC2F &	GetV0 () const
const SFVEC2F &	GetV1 () const
const SFVEC2F &	GetV2 () const
const SFVEC2F &	GetV3 () const
const SFVEC2F &	GetN0 () const
const SFVEC2F &	GetN1 () const
const SFVEC2F &	GetN2 () const
const SFVEC2F &	GetN3 () const
bool	Overlaps (const BBOX_2D &aBBox) const override
	Test if the box overlaps the object. More...
bool	Intersects (const BBOX_2D &aBBox) const override
	a.Intersects(b) ⇔ !a.Disjoint(b) ⇔ !(a ∩ b = ∅) More...
bool	Intersect (const RAYSEG2D &aSegRay, float *aOutT, SFVEC2F *aNormalOut) const override
INTERSECTION_RESULT	IsBBoxInside (const BBOX_2D &aBBox) const override
	Test this object if it's completely outside, intersects, or is completely inside aBBox. More...
bool	IsPointInside (const SFVEC2F &aPoint) const override
const BOARD_ITEM &	GetBoardItem () const
const BBOX_2D &	GetBBox () const
const SFVEC2F &	GetCentroid () const
OBJECT_2D_TYPE	GetObjectType () const

Protected Attributes
BBOX_2D	m_bbox
SFVEC2F	m_centroid
OBJECT_2D_TYPE	m_obj_type
const BOARD_ITEM &	m_boardItem

Private Attributes
SFVEC2F	m_segments [4]
SFVEC2F	m_precalc_slope [4]
SFVEC2F	m_seg_normal [4]

Detailed Description

Simple non-intersecting polygon with 4 points.

Used for footprint pads. (rectangles, trapezoids, with rotation.etc). This is a simplified version of the POLYGON_2D class.

Definition at line 41 of file 4pt_polygon_2d.h.

Constructor & Destructor Documentation

POLYGON_4PT_2D()

POLYGON_4PT_2D::POLYGON_4PT_2D	(	const SFVEC2F &	v1,
		const SFVEC2F &	v2,
		const SFVEC2F &	v3,
		const SFVEC2F &	v4,
		const BOARD_ITEM &	aBoardItem
	)

Definition at line 34 of file 4pt_polygon_2d.cpp.

 :
 OBJECT_2D( OBJECT_2D_TYPE::POLYGON4PT, aBoardItem )
{
 m_segments[0] = v1;
 m_segments[1] = v4;
 m_segments[2] = v3;
 m_segments[3] = v2;
 
 unsigned int i;
 unsigned int j = 4 - 1;
 
 for( i = 0; i < 4; j = i++ )
 {
 SFVEC2F slope = m_segments[j] - m_segments[i];
 m_precalc_slope[i] = slope;
 m_seg_normal[i] = glm::normalize( SFVEC2F( -slope.y, +slope.x ) );
 }
 
 m_bbox.Reset();
 m_bbox.Union( v1 );
 m_bbox.Union( v2 );
 m_bbox.Union( v3 );
 m_bbox.Union( v4 );
 m_bbox.ScaleNextUp();
 m_bbox.ScaleNextUp();
 m_bbox.ScaleNextUp();
 m_bbox.ScaleNextUp();
 m_bbox.ScaleNextUp();
 m_centroid = m_bbox.GetCenter();
 
 wxASSERT( m_bbox.IsInitialized() );
}

References BBOX_2D::GetCenter(), BBOX_2D::IsInitialized(), OBJECT_2D::m_bbox, OBJECT_2D::m_centroid, m_precalc_slope, m_seg_normal, m_segments, POLYGON4PT, BBOX_2D::Reset(), BBOX_2D::ScaleNextUp(), BBOX_2D::Union(), v1, v2, and v3.

Member Function Documentation

GetBBox()

const BBOX_2D & OBJECT_2D::GetBBox ( ) const

inlineinherited

Definition at line 103 of file object_2d.h.

{ return m_bbox; }

References OBJECT_2D::m_bbox.

Referenced by CONTAINER_2D_BASE::Add(), RENDER_3D_RAYTRACE::createObject(), RENDER_3D_RAYTRACE::insertHole(), LAYER_ITEM::LAYER_ITEM(), LAYER_ITEM_2D::LAYER_ITEM_2D(), and BVH_CONTAINER_2D::recursiveBuild_MIDDLE_SPLIT().

GetBoardItem()

const BOARD_ITEM & OBJECT_2D::GetBoardItem ( ) const

inlineinherited

Definition at line 66 of file object_2d.h.

{ return m_boardItem; }

References OBJECT_2D::m_boardItem.

Referenced by RENDER_3D_RAYTRACE::createItemsFromContainer().

GetCentroid()

const SFVEC2F & OBJECT_2D::GetCentroid ( ) const

inlineinherited

Definition at line 105 of file object_2d.h.

{ return m_centroid; }

References OBJECT_2D::m_centroid.

Referenced by LAYER_ITEM::LAYER_ITEM(), sortByCentroidX(), sortByCentroidY(), and sortByCentroidZ().

GetN0()

const SFVEC2F & POLYGON_4PT_2D::GetN0 ( ) const

inline

Definition at line 52 of file 4pt_polygon_2d.h.

{ return m_seg_normal[0]; }

References m_seg_normal.

GetN1()

const SFVEC2F & POLYGON_4PT_2D::GetN1 ( ) const

inline

Definition at line 53 of file 4pt_polygon_2d.h.

{ return m_seg_normal[1]; }

References m_seg_normal.

GetN2()

const SFVEC2F & POLYGON_4PT_2D::GetN2 ( ) const

inline

Definition at line 54 of file 4pt_polygon_2d.h.

{ return m_seg_normal[2]; }

References m_seg_normal.

GetN3()

const SFVEC2F & POLYGON_4PT_2D::GetN3 ( ) const

inline

Definition at line 55 of file 4pt_polygon_2d.h.

{ return m_seg_normal[3]; }

References m_seg_normal.

GetObjectType()

OBJECT_2D_TYPE OBJECT_2D::GetObjectType ( ) const

inlineinherited

Definition at line 107 of file object_2d.h.

{ return m_obj_type; }

References OBJECT_2D::m_obj_type.

Referenced by RENDER_3D_OPENGL::createBoard(), RENDER_3D_RAYTRACE::createObject(), RENDER_3D_OPENGL::generateHoles(), RENDER_3D_OPENGL::generateLayerList(), RENDER_3D_OPENGL::generateViasAndPads(), and LAYER_ITEM_2D::Intersect().

GetV0()

const SFVEC2F & POLYGON_4PT_2D::GetV0 ( ) const

inline

Definition at line 47 of file 4pt_polygon_2d.h.

{ return m_segments[0]; }

References m_segments.

Referenced by RENDER_3D_OPENGL::addObjectTriangles().

GetV1()

const SFVEC2F & POLYGON_4PT_2D::GetV1 ( ) const

inline

Definition at line 48 of file 4pt_polygon_2d.h.

{ return m_segments[1]; }

References m_segments.

Referenced by RENDER_3D_OPENGL::addObjectTriangles().

GetV2()

const SFVEC2F & POLYGON_4PT_2D::GetV2 ( ) const

inline

Definition at line 49 of file 4pt_polygon_2d.h.

{ return m_segments[2]; }

References m_segments.

Referenced by RENDER_3D_OPENGL::addObjectTriangles().

GetV3()

const SFVEC2F & POLYGON_4PT_2D::GetV3 ( ) const

inline

Definition at line 50 of file 4pt_polygon_2d.h.

{ return m_segments[3]; }

References m_segments.

Referenced by RENDER_3D_OPENGL::addObjectTriangles().

Intersect()

bool POLYGON_4PT_2D::Intersect ( const RAYSEG2D &  aSegRay, float *  aOutT, SFVEC2F *  aNormalOut  ) const

overridevirtual

Parameters

aOutT

a value between 0.0 and 1.0 in relation to the time of the hit of the segment.

Implements OBJECT_2D.

Definition at line 82 of file 4pt_polygon_2d.cpp.

{
 bool hited = false;
 unsigned int hitIndex;
 float bestHitT;
 
 for( unsigned int i = 0; i < 4; i++ )
 {
 float t;
 
 if( aSegRay.IntersectSegment( m_segments[i], m_precalc_slope[i], &t ) )
 {
 if( ( hited == false ) || ( t < bestHitT ) )
 {
 hited = true;
 hitIndex = i;
 bestHitT = t;
 }
 }
 }
 
 if( hited )
 {
 wxASSERT( ( bestHitT >= 0.0f ) && ( bestHitT <= 1.0f ) );
 
 if( aOutT )
 *aOutT = bestHitT;
 
 if( aNormalOut )
 *aNormalOut = m_seg_normal[hitIndex];
 
 return true;
 }
 
 return false;
}

References RAYSEG2D::IntersectSegment(), m_precalc_slope, m_seg_normal, and m_segments.

Intersects()

bool POLYGON_4PT_2D::Intersects ( const BBOX_2D &  aBBox ) const

overridevirtual

a.Intersects(b) ⇔ !a.Disjoint(b) ⇔ !(a ∩ b = ∅)

Implements OBJECT_2D.

Definition at line 69 of file 4pt_polygon_2d.cpp.

{
 return m_bbox.Intersects( aBBox );
}

References BBOX_2D::Intersects(), and OBJECT_2D::m_bbox.

IsBBoxInside()

INTERSECTION_RESULT POLYGON_4PT_2D::IsBBoxInside ( const BBOX_2D &  aBBox ) const

overridevirtual

Test this object if it's completely outside, intersects, or is completely inside aBBox.

Returns

INTERSECTION_RESULT

Implements OBJECT_2D.

Definition at line 120 of file 4pt_polygon_2d.cpp.

{
 // !TODO:
 
 return INTERSECTION_RESULT::MISSES;
}

References MISSES.

IsPointInside()

bool POLYGON_4PT_2D::IsPointInside ( const SFVEC2F &  aPoint ) const

overridevirtual

Implements OBJECT_2D.

Definition at line 128 of file 4pt_polygon_2d.cpp.

{
 unsigned int i;
 unsigned int j = 4 - 1;
 bool oddNodes = false;
 
 for( i = 0; i < 4; j = i++ )
 {
 const float polyJY = m_segments[j].y;
 const float polyIY = m_segments[i].y;
 
 if( ( ( polyIY <= aPoint.y ) && ( polyJY >= aPoint.y ) )
  || ( ( polyJY <= aPoint.y ) && ( polyIY >= aPoint.y ) ) )
 {
 const float polyJX = m_segments[j].x;
 const float polyIX = m_segments[i].x;
 
 if( ( polyIX <= aPoint.x ) || ( polyJX <= aPoint.x ) )
 {
 oddNodes ^= ( ( polyIX + ( ( aPoint.y - polyIY ) / ( polyJY - polyIY ) )
 * ( polyJX - polyIX ) )
 < aPoint.x );
 }
 }
 }
 
 return oddNodes;
}

References m_segments.

Overlaps()

bool POLYGON_4PT_2D::Overlaps ( const BBOX_2D &  aBBox ) const

overridevirtual

Test if the box overlaps the object.

Conformance Implements the Overlaps function from the OGC Simple Feature Specification at http://www.opengeospatial.org/standards/sfa. a.Overlaps(b) ⇔ ( dim(I(a)) = dim(I(b)) = dim(I(a) ∩ I(b))) ∧ (a ∩ b ≠ a) ∧ (a ∩ b ≠ b) It means that the result dimension of an overlap is the same dimensions of the bounding box (so the overlap cannot be a point or a line) and one of the boxes cannot full contain the other box.

Parameters

aBBox

is the bounding box to test.

Returns

true if the BBox intersects the object or is inside it.

Implements OBJECT_2D.

Definition at line 75 of file 4pt_polygon_2d.cpp.

{
 // NOT IMPLEMENTED
 return true;
}

Member Data Documentation

m_bbox

BBOX_2D OBJECT_2D::m_bbox

protectedinherited

Definition at line 110 of file object_2d.h.

Referenced by DUMMY_BLOCK_2D::DUMMY_BLOCK_2D(), FILLED_CIRCLE_2D::FILLED_CIRCLE_2D(), OBJECT_2D::GetBBox(), Intersects(), LAYER_ITEM_2D::Intersects(), POLYGON_2D::Intersects(), DUMMY_BLOCK_2D::Intersects(), ROUND_SEGMENT_2D::Intersects(), TRIANGLE_2D::Intersects(), FILLED_CIRCLE_2D::IsBBoxInside(), ROUND_SEGMENT_2D::IsBBoxInside(), TRIANGLE_2D::IsBBoxInside(), DUMMY_BLOCK_2D::IsPointInside(), LAYER_ITEM_2D::LAYER_ITEM_2D(), POLYGON_2D::POLYGON_2D(), POLYGON_4PT_2D(), RING_2D::RING_2D(), ROUND_SEGMENT_2D::ROUND_SEGMENT_2D(), and TRIANGLE_2D::TRIANGLE_2D().

m_boardItem

const BOARD_ITEM& OBJECT_2D::m_boardItem

protectedinherited

Definition at line 114 of file object_2d.h.

Referenced by OBJECT_2D::GetBoardItem().

m_centroid

SFVEC2F OBJECT_2D::m_centroid

protectedinherited

Definition at line 111 of file object_2d.h.

Referenced by DUMMY_BLOCK_2D::DUMMY_BLOCK_2D(), FILLED_CIRCLE_2D::FILLED_CIRCLE_2D(), OBJECT_2D::GetCentroid(), LAYER_ITEM_2D::LAYER_ITEM_2D(), POLYGON_2D::POLYGON_2D(), POLYGON_4PT_2D(), RING_2D::RING_2D(), ROUND_SEGMENT_2D::ROUND_SEGMENT_2D(), and TRIANGLE_2D::TRIANGLE_2D().

m_obj_type

OBJECT_2D_TYPE OBJECT_2D::m_obj_type

protectedinherited

Definition at line 112 of file object_2d.h.

Referenced by OBJECT_2D::GetObjectType(), and OBJECT_2D::OBJECT_2D().

m_precalc_slope

SFVEC2F POLYGON_4PT_2D::m_precalc_slope[4]

private

Definition at line 65 of file 4pt_polygon_2d.h.

Referenced by Intersect(), and POLYGON_4PT_2D().

m_seg_normal

SFVEC2F POLYGON_4PT_2D::m_seg_normal[4]

private

Definition at line 66 of file 4pt_polygon_2d.h.

Referenced by GetN0(), GetN1(), GetN2(), GetN3(), Intersect(), and POLYGON_4PT_2D().

m_segments

SFVEC2F POLYGON_4PT_2D::m_segments[4]

private

Definition at line 64 of file 4pt_polygon_2d.h.

Referenced by GetV0(), GetV1(), GetV2(), GetV3(), Intersect(), IsPointInside(), and POLYGON_4PT_2D().

---

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

• 4pt_polygon_2d.h
• 4pt_polygon_2d.cpp