APERTURE_MACRO Struct Reference

Struct APERTURE_MACRO helps support the "aperture macro" defined within standard RS274X. More...

#include <am_primitive.h>

Public Member Functions
double	GetLocalParam (const D_CODE *aDcode, unsigned aParamId) const
	function GetLocalParam Usually, parameters are defined inside the aperture primitive using immediate mode or defered mode. More...
SHAPE_POLY_SET *	GetApertureMacroShape (const GERBER_DRAW_ITEM *aParent, wxPoint aShapePos)
	Function GetApertureMacroShape Calculate the primitive shape for flashed items. More...
void	DrawApertureMacroShape (GERBER_DRAW_ITEM *aParent, EDA_RECT *aClipBox, wxDC *aDC, COLOR4D aColor, wxPoint aShapePos, bool aFilledShape)
	Function DrawApertureMacroShape Draw the primitive shape for flashed items. More...
int	GetShapeDim (GERBER_DRAW_ITEM *aParent)
	Function GetShapeDim Calculate a value that can be used to evaluate the size of text when displaying the D-Code of an item due to the complexity of a shape using many primitives one cannot calculate the "size" of a shape (only abounding box) but most of aperture macro are using one or few primitives and the "dimension" of the shape is the diameter of the primitive (or the max diameter of primitives) More...
EDA_RECT	GetBoundingBox () const
	Returns the bounding box of the shape. More...

Public Attributes
wxString	name
	The name of the aperture macro. More...
AM_PRIMITIVES	primitives
	A sequence of AM_PRIMITIVEs. More...
AM_PARAMS	m_localparamStack
SHAPE_POLY_SET	m_shape
	The shape of the item, calculated by GetApertureMacroShape. More...
EDA_RECT	m_boundingBox
	The bounding box of the item, calculated by GetApertureMacroShape. More...

Detailed Description

Struct APERTURE_MACRO helps support the "aperture macro" defined within standard RS274X.

Definition at line 163 of file am_primitive.h.

Member Function Documentation

DrawApertureMacroShape()

void APERTURE_MACRO::DrawApertureMacroShape	(	GERBER_DRAW_ITEM *	aParent,
		EDA_RECT *	aClipBox,
		wxDC *	aDC,
		COLOR4D	aColor,
		wxPoint	aShapePos,
		bool	aFilledShape
	)

Function DrawApertureMacroShape Draw the primitive shape for flashed items.

When an item is flashed, this is the shape of the item

Parameters

aParent	= the parent GERBER_DRAW_ITEM which is actually drawn
aClipBox	= DC clip box (NULL is no clip)
aDC	= device context
aColor	= the color of shape
aShapePos	= the actual shape position
aFilledShape	= true to draw in filled mode, false to draw in skecth mode

Definition at line 825 of file am_primitive.cpp.

{
    SHAPE_POLY_SET* shapeBuffer = GetApertureMacroShape( aParent, aShapePos );

    if( shapeBuffer->OutlineCount() == 0 )
        return;

    for( int ii = 0; ii < shapeBuffer->OutlineCount(); ii++ )
    {
        SHAPE_LINE_CHAIN& poly = shapeBuffer->Outline( ii );

        GRClosedPoly( aClipBox, aDC,
                      poly.PointCount(), (wxPoint*)&poly.Point( 0 ), aFilledShape, aColor, aColor );
    }
}

References GetApertureMacroShape(), GRClosedPoly(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::Point(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by D_CODE::DrawFlashedShape().

GetApertureMacroShape()

SHAPE_POLY_SET * APERTURE_MACRO::GetApertureMacroShape	(	const GERBER_DRAW_ITEM *	aParent,
		wxPoint	aShapePos
	)

Function GetApertureMacroShape Calculate the primitive shape for flashed items.

When an item is flashed, this is the shape of the item

Parameters

aParent

= the parent GERBER_DRAW_ITEM which is actually drawn

Returns

The shape of the item

Definition at line 776 of file am_primitive.cpp.

{
    SHAPE_POLY_SET holeBuffer;
    bool hasHole = false;

    m_shape.RemoveAllContours();

    for( AM_PRIMITIVES::iterator prim_macro = primitives.begin();
         prim_macro != primitives.end(); ++prim_macro )
    {
        if( prim_macro->primitive_id == AMP_COMMENT )
            continue;

        if( prim_macro->IsAMPrimitiveExposureOn( aParent ) )
            prim_macro->DrawBasicShape( aParent, m_shape, aShapePos );
        else
        {
            prim_macro->DrawBasicShape( aParent, holeBuffer, aShapePos );

            if( holeBuffer.OutlineCount() )     // we have a new hole in shape: remove the hole
            {
                m_shape.BooleanSubtract( holeBuffer, SHAPE_POLY_SET::PM_FAST );
                holeBuffer.RemoveAllContours();
                hasHole = true;
            }
        }
    }

    // If a hole is defined inside a polygon, we must fracture the polygon
    // to be able to drawn it (i.e link holes by overlapping edges)
    if( hasHole )
        m_shape.Fracture( SHAPE_POLY_SET::PM_FAST );

    m_boundingBox = EDA_RECT( wxPoint( 0, 0 ), wxSize( 1, 1 ) );
    auto bb = m_shape.BBox();
    wxPoint center( bb.Centre().x, bb.Centre().y );
    m_boundingBox.Move( aParent->GetABPosition( center ) );
    m_boundingBox.Inflate( bb.GetWidth() / 2, bb.GetHeight() / 2 );

    return &m_shape;
}

References AMP_COMMENT, SHAPE_POLY_SET::BBox(), SHAPE_POLY_SET::BooleanSubtract(), SHAPE_POLY_SET::Fracture(), GERBER_DRAW_ITEM::GetABPosition(), EDA_RECT::Inflate(), m_boundingBox, m_shape, EDA_RECT::Move(), SHAPE_POLY_SET::OutlineCount(), SHAPE_POLY_SET::PM_FAST, primitives, and SHAPE_POLY_SET::RemoveAllContours().

Referenced by KIGFX::GERBVIEW_PAINTER::drawApertureMacro(), DrawApertureMacroShape(), fillFlashedGBRITEM(), GERBER_DRAW_ITEM::GetBoundingBox(), and GERBER_DRAW_ITEM::HitTest().

GetBoundingBox()

EDA_RECT APERTURE_MACRO::GetBoundingBox ( ) const

inline

Returns the bounding box of the shape.

Definition at line 231 of file am_primitive.h.

    {
        return m_boundingBox;
    }

References m_boundingBox.

Referenced by GERBER_DRAW_ITEM::GetBoundingBox(), and GERBER_DRAW_ITEM::ViewGetLOD().

GetLocalParam()

double APERTURE_MACRO::GetLocalParam	(	const D_CODE *	aDcode,
		unsigned	aParamId
	)		const

function GetLocalParam Usually, parameters are defined inside the aperture primitive using immediate mode or defered mode.

in defered mode the value is defined in a DCODE that want to use the aperture macro. But some parameters are defined outside the aperture primitive and are local to the aperture macro

Returns

the value of a defered parameter defined inside the aperture macro

Parameters

aDcode	= the D_CODE that uses this apertur macro and define defered parameters
aParamId	= the param id (defined by $3 or $5 ..) to evaluate

in defered mode the value is defined in a DCODE that want to use the aperture macro. But some parameters are defined outside the aperture primitive and are local to the aperture macro

Returns

the value of a defered parameter defined inside the aperture macro

Parameters

aParamId

= the param id (defined by $3 or $5 ..) to evaluate

Definition at line 879 of file am_primitive.cpp.

{
    // find parameter descr.
    const AM_PARAM * param = NULL;

    for( unsigned ii = 0; ii < m_localparamStack.size(); ii ++ )
    {
        if( m_localparamStack[ii].GetIndex() == aParamId )
        {
            param = &m_localparamStack[ii];
            break;
        }
    }

    if ( param == NULL )    // not found
        return 0.0;

    // Evaluate parameter
    double value = param->GetValue( aDcode );

    return value;
}

References AM_PARAM::GetValue(), and m_localparamStack.

Referenced by AM_PARAM::GetValue().

GetShapeDim()

int APERTURE_MACRO::GetShapeDim

(

GERBER_DRAW_ITEM *

aParent

)

Function GetShapeDim Calculate a value that can be used to evaluate the size of text when displaying the D-Code of an item due to the complexity of a shape using many primitives one cannot calculate the "size" of a shape (only abounding box) but most of aperture macro are using one or few primitives and the "dimension" of the shape is the diameter of the primitive (or the max diameter of primitives)

GetShapeDim Calculate a value that can be used to evaluate the size of text when displaying the D-Code of an item due to the complexity of a shape using many primitives one cannot calculate the "size" of a shape (only abounding box) but most of aperture macro are using one or few primitives and the "dimension" of the shape is the diameter of the primitive (or the max diameter of primitives)

Parameters

aParent

= the parent GERBER_DRAW_ITEM which is actually drawn

Returns

a dimension, or -1 if no dim to calculate

a dimension, or -1 if no dim to calculate

Definition at line 854 of file am_primitive.cpp.

{
    int dim = -1;
    for( AM_PRIMITIVES::iterator prim_macro = primitives.begin();
         prim_macro != primitives.end(); ++prim_macro )
    {
        int pdim = prim_macro->GetShapeDim( aParent );
        if( dim < pdim )
            dim = pdim;
    }

    return dim;
}

References primitives.

Referenced by D_CODE::GetShapeDim().

Member Data Documentation

m_boundingBox

EDA_RECT APERTURE_MACRO::m_boundingBox

The bounding box of the item, calculated by GetApertureMacroShape.

Definition at line 177 of file am_primitive.h.

Referenced by GetApertureMacroShape(), and GetBoundingBox().

m_localparamStack

AM_PARAMS APERTURE_MACRO::m_localparamStack

Definition at line 174 of file am_primitive.h.

Referenced by GetLocalParam(), and GERBER_FILE_IMAGE::ReadApertureMacro().

m_shape

SHAPE_POLY_SET APERTURE_MACRO::m_shape

The shape of the item, calculated by GetApertureMacroShape.

Definition at line 176 of file am_primitive.h.

Referenced by GetApertureMacroShape().

name

wxString APERTURE_MACRO::name

The name of the aperture macro.

Definition at line 165 of file am_primitive.h.

Referenced by GERBER_FILE_IMAGE::ExecuteRS274XCommand(), APERTURE_MACRO_less_than::operator()(), GERBER_FILE_IMAGE::ReadApertureMacro(), and GERBER_DRAW_ITEM::ShowGBRShape().

primitives

AM_PRIMITIVES APERTURE_MACRO::primitives

A sequence of AM_PRIMITIVEs.

Definition at line 166 of file am_primitive.h.

Referenced by GetApertureMacroShape(), GetShapeDim(), and GERBER_FILE_IMAGE::ReadApertureMacro().

---

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

• am_primitive.h
• am_primitive.cpp