KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Attributes | List of all members
RING_2D Class Reference

#include <ring_2d.h>

Inheritance diagram for RING_2D:
OBJECT_2D

Public Member Functions

 RING_2D (const SFVEC2F &aCenter, float aInnerRadius, float aOuterRadius, const BOARD_ITEM &aBoardItem)
 
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 SFVEC2F & GetCenter () const
 
float GetInnerRadius () const
 
float GetOuterRadius () const
 
float GetInnerRadiusSquared () const
 
float GetOuterRadiusSquared () const
 
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_center
 
float m_inner_radius
 
float m_outer_radius
 
float m_inner_radius_squared
 
float m_outer_radius_squared
 

Detailed Description

Definition at line 34 of file ring_2d.h.

Constructor & Destructor Documentation

◆ RING_2D()

RING_2D::RING_2D ( const SFVEC2F &  aCenter,
float  aInnerRadius,
float  aOuterRadius,
const BOARD_ITEM &  aBoardItem 
)

Definition at line 35 of file ring_2d.cpp.

References BBOX_2D::GetCenter(), BBOX_2D::IsInitialized(), OBJECT_2D::m_bbox, m_center, OBJECT_2D::m_centroid, m_inner_radius, m_inner_radius_squared, m_outer_radius, m_outer_radius_squared, BBOX_2D::Reset(), BBOX_2D::ScaleNextUp(), and BBOX_2D::Set().

Member Function Documentation

◆ GetBBox()

const BBOX_2D & OBJECT_2D::GetBBox ( ) const
inlineinherited

Definition at line 103 of file object_2d.h.

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.

References OBJECT_2D::m_boardItem.

Referenced by RENDER_3D_RAYTRACE::createItemsFromContainer().

◆ GetCenter()

const SFVEC2F & RING_2D::GetCenter ( ) const
inline

Definition at line 46 of file ring_2d.h.

References m_center.

Referenced by RENDER_3D_OPENGL::addObjectTriangles().

◆ GetCentroid()

const SFVEC2F & OBJECT_2D::GetCentroid ( ) const
inlineinherited

Definition at line 105 of file object_2d.h.

References OBJECT_2D::m_centroid.

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

◆ GetInnerRadius()

float RING_2D::GetInnerRadius ( ) const
inline

Definition at line 47 of file ring_2d.h.

References m_inner_radius.

Referenced by RENDER_3D_OPENGL::addObjectTriangles().

◆ GetInnerRadiusSquared()

float RING_2D::GetInnerRadiusSquared ( ) const
inline

Definition at line 50 of file ring_2d.h.

References m_inner_radius_squared.

◆ GetObjectType()

OBJECT_2D_TYPE OBJECT_2D::GetObjectType ( ) const
inlineinherited

Definition at line 107 of file object_2d.h.

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

◆ GetOuterRadius()

float RING_2D::GetOuterRadius ( ) const
inline

Definition at line 48 of file ring_2d.h.

References m_outer_radius.

Referenced by RENDER_3D_OPENGL::addObjectTriangles().

◆ GetOuterRadiusSquared()

float RING_2D::GetOuterRadiusSquared ( ) const
inline

Definition at line 51 of file ring_2d.h.

References m_outer_radius_squared.

◆ Intersect()

bool RING_2D::Intersect ( const RAYSEG2D &  aSegRay,
float *  aOutT,
SFVEC2F *  aNormalOut 
) const
overridevirtual
Parameters
aOutTa value between 0.0 and 1.0 in relation to the time of the hit of the segment.

Implements OBJECT_2D.

Definition at line 72 of file ring_2d.cpp.

References RAYSEG2D::at(), m_center, RAYSEG2D::m_Dir, m_inner_radius, m_inner_radius_squared, RAYSEG2D::m_Length, m_outer_radius, m_outer_radius_squared, and RAYSEG2D::m_Start.

◆ Intersects()

bool RING_2D::Intersects ( const BBOX_2D &  aBBox) const
overridevirtual

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

Implements OBJECT_2D.

Definition at line 65 of file ring_2d.cpp.

References BBOX_2D::Intersects(), m_center, and m_outer_radius_squared.

◆ IsBBoxInside()

INTERSECTION_RESULT RING_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 148 of file ring_2d.cpp.

◆ IsPointInside()

bool RING_2D::IsPointInside ( const SFVEC2F &  aPoint) const
overridevirtual

Implements OBJECT_2D.

Definition at line 154 of file ring_2d.cpp.

References m_center, m_inner_radius_squared, and m_outer_radius_squared.

◆ Overlaps()

bool RING_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
aBBoxis the bounding box to test.
Returns
true if the BBox intersects the object or is inside it.

Implements OBJECT_2D.

Definition at line 58 of file ring_2d.cpp.

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(), POLYGON_4PT_2D::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::POLYGON_4PT_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_center

SFVEC2F RING_2D::m_center
private

Definition at line 54 of file ring_2d.h.

Referenced by GetCenter(), Intersect(), Intersects(), IsPointInside(), and RING_2D().

◆ 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::POLYGON_4PT_2D(), RING_2D(), ROUND_SEGMENT_2D::ROUND_SEGMENT_2D(), and TRIANGLE_2D::TRIANGLE_2D().

◆ m_inner_radius

float RING_2D::m_inner_radius
private

Definition at line 55 of file ring_2d.h.

Referenced by GetInnerRadius(), Intersect(), and RING_2D().

◆ m_inner_radius_squared

float RING_2D::m_inner_radius_squared
private

Definition at line 57 of file ring_2d.h.

Referenced by GetInnerRadiusSquared(), Intersect(), IsPointInside(), and RING_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_outer_radius

float RING_2D::m_outer_radius
private

Definition at line 56 of file ring_2d.h.

Referenced by GetOuterRadius(), Intersect(), and RING_2D().

◆ m_outer_radius_squared

float RING_2D::m_outer_radius_squared
private

Definition at line 58 of file ring_2d.h.

Referenced by GetOuterRadiusSquared(), Intersect(), Intersects(), IsPointInside(), and RING_2D().

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