SHAPE_COMPOUND Class Reference

#include <shape_compound.h>

Inheritance diagram for SHAPE_COMPOUND:

Public Member Functions
	SHAPE_COMPOUND ()
	SHAPE_COMPOUND (const std::vector< SHAPE * > &aShapes)
	SHAPE_COMPOUND (const SHAPE_COMPOUND &aOther)
	~SHAPE_COMPOUND ()
SHAPE_COMPOUND *	Clone () const override
	Return a dynamically allocated copy of the shape. More...
const std::string	Format () const override
bool	Collide (const SEG &aSeg, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
	Check if the boundary of shape (this) lies closer to the segment aSeg than aClearance, indicating a collision. More...
bool	Collide (const SHAPE *aShape, int aClearance, VECTOR2I *aMTV) const override
	Check if the boundary of shape (this) lies closer to the shape aShape than aClearance, indicating a collision. More...
bool	Collide (const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
const std::vector< SHAPE * > &	Shapes () const
const BOX2I	BBox (int aClearance=0) const override
	Compute a bounding box of the shape, with a margin of aClearance a collision. More...
int	Distance (const SEG &aSeg) const
void	Move (const VECTOR2I &aVector) override
void	AddShape (SHAPE *aShape)
bool	Empty () const
int	Size () const
void	Rotate (double aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
bool	IsSolid () const override
SHAPE *	UniqueSubshape () const
virtual bool	HasIndexableSubshapes () const override
virtual size_t	GetIndexableSubshapeCount () const override
virtual void	GetIndexableSubshapes (std::vector< SHAPE * > &aSubshapes) override
bool	ConvertToSimplePolygon (SHAPE_SIMPLE *aOut) const
bool	IsNull () const
	Return true if the shape is a null shape. More...
virtual bool	Collide (const VECTOR2I &aP, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const
	Check if the boundary of shape (this) lies closer to the point aP than aClearance, indicating a collision. More...
virtual VECTOR2I	Centre () const
	Compute a center-of-mass of the shape. More...
virtual bool	Parse (std::stringstream &aStream)
FACET *	NewFacet ()
SGNODE *	CalcShape (SGNODE *aParent, SGNODE *aColor, WRL1_ORDER aVertexOrder, float aCreaseLimit=0.74317, bool isVRML2=false)
SHAPE_TYPE	Type () const
	Return the type of the shape. More...

Static Public Attributes
static const int	MIN_PRECISION_IU = 4
	This is the minimum precision for all the points in a shape. More...

Protected Types
typedef VECTOR2I::extended_type	ecoord

Protected Attributes
SHAPE_TYPE	m_type
	< type of our shape More...

Private Attributes
BOX2I	m_cachedBBox
bool	m_dirty
std::vector< SHAPE * >	m_shapes

Detailed Description

Definition at line 36 of file shape_compound.h.

Member Typedef Documentation

ecoord

typedef VECTOR2I::extended_type SHAPE::ecoord

protectedinherited

Definition at line 236 of file shape.h.

Constructor & Destructor Documentation

SHAPE_COMPOUND() [1/3]

SHAPE_COMPOUND::SHAPE_COMPOUND ( )

inline

Definition at line 39 of file shape_compound.h.

                     :
            SHAPE( SH_COMPOUND ),
            m_dirty( true )
    {
    }

Referenced by Clone().

SHAPE_COMPOUND() [2/3]

SHAPE_COMPOUND::SHAPE_COMPOUND

(

const std::vector< SHAPE * > &

aShapes

)

Definition at line 42 of file shape_compound.cpp.

                                                                 :
         SHAPE( SH_COMPOUND ),
         m_dirty( true ),
         m_shapes( aShapes )
{

}

SHAPE_COMPOUND() [3/3]

SHAPE_COMPOUND::SHAPE_COMPOUND

(

const SHAPE_COMPOUND &

aOther

)

Definition at line 51 of file shape_compound.cpp.

    : SHAPE( SH_COMPOUND )
{
    for ( const SHAPE* shape : aOther.Shapes() )
        m_shapes.push_back( shape->Clone() );

    m_dirty = true;
}

References m_dirty, m_shapes, and Shapes().

~SHAPE_COMPOUND()

SHAPE_COMPOUND::~SHAPE_COMPOUND

(

)

Definition at line 63 of file shape_compound.cpp.

{
    for( auto shape : m_shapes )
        delete shape;
}

References m_shapes.

Member Function Documentation

AddShape()

void SHAPE_COMPOUND::AddShape ( SHAPE *  aShape )

inline

Definition at line 79 of file shape_compound.h.

    {
        // Don't make clients deal with nested SHAPE_COMPOUNDs
        if( aShape->HasIndexableSubshapes() )
        {
            std::vector<SHAPE*> subshapes;
            aShape->GetIndexableSubshapes( subshapes );

            for( SHAPE* subshape : subshapes )
                m_shapes.push_back( subshape->Clone() );

            delete aShape;
        }
        else
        {
            m_shapes.push_back( aShape );
        }

        m_dirty = true;
    }

References SHAPE_BASE::GetIndexableSubshapes(), SHAPE_BASE::HasIndexableSubshapes(), m_dirty, and m_shapes.

BBox()

const BOX2I SHAPE_COMPOUND::BBox ( int  aClearance = 0 ) const

overridevirtual

Compute a bounding box of the shape, with a margin of aClearance a collision.

Parameters

aClearance

how much the bounding box is expanded wrs to the minimum enclosing rectangle for the shape.

Returns

the bounding box.

Implements SHAPE.

Definition at line 76 of file shape_compound.cpp.

{
    BOX2I bb;

    if ( m_shapes.size() < 1 )
        return bb;

    bb = m_shapes[0]->BBox();

    for( size_t i = 1; i < m_shapes.size(); i++ )
        bb.Merge( m_shapes[i]->BBox() );

    return bb;
}

References m_shapes, and BOX2< Vec >::Merge().

CalcShape()

SGNODE * SHAPE::CalcShape ( SGNODE *  aParent, SGNODE *  aColor, WRL1_ORDER  aVertexOrder, float  aCreaseLimit = 0.74317, bool  isVRML2 = false  )

inherited

Definition at line 703 of file wrlfacet.cpp.

{
    if( facets.empty() || !facets.front()->HasMinPoints() )
        return nullptr;

    std::vector< std::list< FACET* > > flist;

    // determine the max. index and size flist as appropriate
    std::list< FACET* >::iterator sF = facets.begin();
    std::list< FACET* >::iterator eF = facets.end();

    int maxIdx = 0;
    int tmi;
    float maxV = 0.0;
    float tV = 0.0;

    while( sF != eF )
    {
        tV = ( *sF )->CalcFaceNormal();
        tmi = ( *sF )->GetMaxIndex();

        if( tmi > maxIdx )
            maxIdx = tmi;

        if( tV > maxV )
            maxV = tV;

        ++sF;
    }

    ++maxIdx;

    if( maxIdx < 3 )
        return nullptr;

    flist.resize( maxIdx );

    // create the lists of facets common to indices
    sF = facets.begin();

    while( sF != eF )
    {
        ( *sF )->Renormalize( tV );
        ( *sF )->CollectVertices( flist );
        ++sF;
    }

    // calculate the normals
    size_t vs = flist.size();

    for( size_t i = 0; i < vs; ++i )
    {
        sF = flist[i].begin();
        eF = flist[i].end();

        while( sF != eF )
        {
            ( *sF )->CalcVertexNormal( static_cast<int>( i ), flist[i], aCreaseLimit );
            ++sF;
        }
    }

    std::vector< WRLVEC3F > vertices;
    std::vector< WRLVEC3F > normals;
    std::vector< SGCOLOR >  colors;

    // push the facet data to the final output list
    sF = facets.begin();
    eF = facets.end();

    while( sF != eF )
    {
        ( *sF )->GetData( vertices, normals, colors, aVertexOrder );
        ++sF;
    }

    flist.clear();

    if( vertices.size() < 3 )
        return nullptr;

    IFSG_SHAPE shapeNode( false );

    if( !isVRML2 )
    {
        shapeNode.NewNode( aParent );

        if( aColor )
        {
            if( nullptr == S3D::GetSGNodeParent( aColor ) )
                shapeNode.AddChildNode( aColor );
            else
                shapeNode.AddRefNode( aColor );
        }
    }

    std::vector< SGPOINT >  lCPts;  // vertex points in SGPOINT (double) format
    std::vector< SGVECTOR > lCNorm; // per-vertex normals
    vs = vertices.size();

    for( size_t i = 0; i < vs; ++i )
    {
        SGPOINT pt;
        pt.x = vertices[i].x;
        pt.y = vertices[i].y;
        pt.z = vertices[i].z;
        lCPts.push_back( pt );
        lCNorm.emplace_back( normals[i].x, normals[i].y, normals[i].z );
    }

    vertices.clear();
    normals.clear();

    IFSG_FACESET fsNode( false );

    if( !isVRML2 )
        fsNode.NewNode( shapeNode );
    else
        fsNode.NewNode( aParent );

    IFSG_COORDS cpNode( fsNode );
    cpNode.SetCoordsList( lCPts.size(), &lCPts[0] );
    IFSG_COORDINDEX ciNode( fsNode );

    for( int i = 0; i < (int)lCPts.size(); ++i )
        ciNode.AddIndex( i );

    IFSG_NORMALS nmNode( fsNode );
    nmNode.SetNormalList( lCNorm.size(), &lCNorm[0] );

    if( !colors.empty() )
    {
        IFSG_COLORS nmColor( fsNode );
        nmColor.SetColorList( colors.size(), &colors[0] );
        colors.clear();
    }

    if( !isVRML2 )
        return shapeNode.GetRawPtr();

    return fsNode.GetRawPtr();
}

References IFSG_NODE::AddChildNode(), IFSG_INDEX::AddIndex(), IFSG_NODE::AddRefNode(), SHAPE::facets, IFSG_NODE::GetRawPtr(), S3D::GetSGNodeParent(), IFSG_FACESET::NewNode(), IFSG_SHAPE::NewNode(), IFSG_COLORS::SetColorList(), IFSG_COORDS::SetCoordsList(), IFSG_NORMALS::SetNormalList(), SGPOINT::x, SGPOINT::y, and SGPOINT::z.

Referenced by WRL1FACESET::TranslateToSG(), WRL2FACESET::TranslateToSG(), and X3DIFACESET::TranslateToSG().

Centre()

virtual VECTOR2I SHAPE::Centre ( ) const

inlinevirtualinherited

Compute a center-of-mass of the shape.

Returns

the center-of-mass point

Definition at line 216 of file shape.h.

    {
        return BBox( 0 ).Centre(); // if nothing better is available....
    }

References SHAPE::BBox(), and BOX2< Vec >::Centre().

Referenced by Collide().

Clone()

SHAPE_COMPOUND * SHAPE_COMPOUND::Clone ( ) const

overridevirtual

Return a dynamically allocated copy of the shape.

Return values

copy	of the shape

Reimplemented from SHAPE.

Definition at line 70 of file shape_compound.cpp.

{
    return new SHAPE_COMPOUND( *this );
}

References SHAPE_COMPOUND().

Collide() [1/4]

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

overridevirtual

Check if the boundary of shape (this) lies closer to the segment aSeg than aClearance, indicating a collision.

Parameters

aActual	[out] an optional pointer to an int to be updated with the actual distance int the event of a collision.
aLocation	[out] an option pointer to a point to store a nearby location in the event of a collision.

Returns

true, if there is a collision.

Implements SHAPE.

Definition at line 117 of file shape_compound.cpp.

{
    int closest_dist = std::numeric_limits<int>::max();
    VECTOR2I nearest;

    for( SHAPE* item : m_shapes )
    {
        int actual = 0;
        VECTOR2I pn;

        if( item->Collide( aSeg, aClearance,
                           aActual || aLocation ? &actual : nullptr,
                           aLocation ? &pn : nullptr ) )
        {
            if( actual < closest_dist )
            {
                nearest = pn;
                closest_dist = actual;

                if( closest_dist == 0 || !aActual )
                    break;
            }
        }
    }

    if( closest_dist == 0 || closest_dist < aClearance )
    {
        if( aLocation )
            *aLocation = nearest;

        if( aActual )
            *aActual = closest_dist;

        return true;
    }

    return false;
}

References m_shapes.

Collide() [2/4]

bool SHAPE_COMPOUND::Collide ( const SHAPE *  aShape, int  aClearance, VECTOR2I *  aMTV  ) const

inlineoverridevirtual

Check if the boundary of shape (this) lies closer to the shape aShape than aClearance, indicating a collision.

Parameters

aShape	shape to check collision against
aClearance	minimum clearance
aMTV	minimum translation vector
aActual	[out] an optional pointer to an int to store the actual distance in the event of a collision.
aLocation	[out] an option pointer to a point to store a nearby location in the event of a collision.

Returns

true, if there is a collision.

Reimplemented from SHAPE.

Definition at line 57 of file shape_compound.h.

    {
        return SHAPE::Collide( aShape, aClearance, aMTV );
    }

References SHAPE::Collide().

Collide() [3/4]

bool SHAPE_COMPOUND::Collide ( const SHAPE *  aShape, int  aClearance = 0, int *  aActual = nullptr, VECTOR2I *  aLocation = nullptr  ) const

inlineoverridevirtual

Reimplemented from SHAPE.

Definition at line 62 of file shape_compound.h.

    {
        return SHAPE::Collide( aShape, aClearance, aActual, aLocation );
    }

References SHAPE::Collide().

Collide() [4/4]

virtual bool SHAPE::Collide ( const VECTOR2I &  aP, int  aClearance = 0, int *  aActual = nullptr, VECTOR2I *  aLocation = nullptr  ) const

inlinevirtualinherited

Check if the boundary of shape (this) lies closer to the point aP than aClearance, indicating a collision.

Parameters

aActual	[out] an optional pointer to an int to store the actual distance in the event of a collision.
aLocation	[out] an option pointer to a point to store a nearby location in the event of a collision.

Returns

true, if there is a collision.

Reimplemented in SHAPE_POLY_SET, SHAPE_LINE_CHAIN_BASE, SHAPE_ARC, and SHAPE_SEGMENT.

Definition at line 165 of file shape.h.

    {
        return Collide( SEG( aP, aP ), aClearance, aActual, aLocation );
    }

Referenced by DRC_RTREE::CheckColliding(), Collide(), SHAPE_SEGMENT::Collide(), collide(), SHAPE_RECT::Collide(), SHAPE_POLY_SET::Collide(), PNS::ITEM::collideSimple(), PNS::SHOVE::onCollidingVia(), PNS::HIT_VISITOR::operator()(), DRC_RTREE::QueryColliding(), PNS::OPTIMIZER::smartPadsSingle(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem().

ConvertToSimplePolygon()

bool SHAPE_COMPOUND::ConvertToSimplePolygon

(

SHAPE_SIMPLE *

aOut

)

const

Definition at line 158 of file shape_compound.cpp.

{
    return false;
}

Distance()

int SHAPE_COMPOUND::Distance

(

const SEG &

aSeg

)

const

Definition at line 98 of file shape_compound.cpp.

{
    assert(false);
    return 0;   // Make compiler happy
}

Empty()

bool SHAPE_COMPOUND::Empty ( ) const

inline

Definition at line 100 of file shape_compound.h.

    {
        return m_shapes.empty();
    }

References m_shapes.

Format()

const std::string SHAPE_COMPOUND::Format ( ) const

overridevirtual

Reimplemented from SHAPE.

Definition at line 30 of file shape_compound.cpp.

{
    std::stringstream ss;

    ss << "compound( ";

    for( auto shape : m_shapes )
        ss << shape->Format() << " ";

    return ss.str();
}

References m_shapes.

GetIndexableSubshapeCount()

virtual size_t SHAPE_COMPOUND::GetIndexableSubshapeCount ( ) const

inlineoverridevirtual

Reimplemented from SHAPE_BASE.

Definition at line 124 of file shape_compound.h.

    {
        return m_shapes.size();
    }

References m_shapes.

GetIndexableSubshapes()

virtual void SHAPE_COMPOUND::GetIndexableSubshapes ( std::vector< SHAPE * > &  aSubshapes )

inlineoverridevirtual

Reimplemented from SHAPE_BASE.

Definition at line 129 of file shape_compound.h.

    {
        aSubshapes = m_shapes;
    }

References m_shapes.

HasIndexableSubshapes()

virtual bool SHAPE_COMPOUND::HasIndexableSubshapes ( ) const

inlineoverridevirtual

Reimplemented from SHAPE_BASE.

Definition at line 119 of file shape_compound.h.

    {
        return true;
    }

IsNull()

bool SHAPE::IsNull ( ) const

inlineinherited

Return true if the shape is a null shape.

Return values

true	if null :-)

Definition at line 150 of file shape.h.

    {
        return m_type == SH_NULL;
    }

References SHAPE_BASE::m_type, and SH_NULL.

IsSolid()

bool SHAPE_COMPOUND::IsSolid ( ) const

overridevirtual

Implements SHAPE.

Definition at line 111 of file shape_compound.cpp.

{
    return true;
}

Move()

void SHAPE_COMPOUND::Move ( const VECTOR2I &  aVector )

overridevirtual

Implements SHAPE.

Definition at line 91 of file shape_compound.cpp.

{
         for( auto& item : m_shapes )
            item->Move( aVector );
}

References m_shapes.

NewFacet()

FACET * SHAPE::NewFacet ( )

inherited

Definition at line 695 of file wrlfacet.cpp.

{
    FACET* fp = new FACET;
    facets.push_back( fp );
    return fp;
}

References SHAPE::facets.

Referenced by WRL1FACESET::TranslateToSG(), WRL2FACESET::TranslateToSG(), and X3DIFACESET::TranslateToSG().

Parse()

bool SHAPE::Parse ( std::stringstream &  aStream )

virtualinherited

Reimplemented in SHAPE_POLY_SET, and SHAPE_LINE_CHAIN.

Definition at line 28 of file shape.cpp.

{
    assert( false );
    return false;
}

Rotate()

void SHAPE_COMPOUND::Rotate ( double  aAngle, const VECTOR2I &  aCenter = { 0, 0 }  )

overridevirtual

Parameters

aCenter	is the rotation center.
aAngle	rotation angle in radians.

Implements SHAPE.

Definition at line 105 of file shape_compound.cpp.

{
    assert( false );
}

Shapes()

const std::vector<SHAPE*>& SHAPE_COMPOUND::Shapes ( ) const

inline

Definition at line 68 of file shape_compound.h.

    {
        return m_shapes;
    }

References m_shapes.

Referenced by collideShapes(), PNS::SOLID::HoleHull(), PNS::SOLID::Hull(), and SHAPE_COMPOUND().

Size()

int SHAPE_COMPOUND::Size ( ) const

inline

Definition at line 105 of file shape_compound.h.

    {
        return m_shapes.size();
    }

References m_shapes.

Type()

SHAPE_TYPE SHAPE_BASE::Type ( ) const

inlineinherited

Return the type of the shape.

Return values

the

type

Definition at line 94 of file shape.h.

    {
        return m_type;
    }

References SHAPE_BASE::m_type.

Referenced by PNS::DP_GATEWAYS::BuildFromPrimitivePair(), PNS::buildHullForPrimitiveShape(), Collide(), SHAPE_POLY_SET::Collide(), collideShapes(), collideSingleShapes(), PNS::OPTIMIZER::computeBreakouts(), ROUTER_PREVIEW_ITEM::drawShape(), PNS::SOLID::HoleHull(), PNS::SOLID::Hull(), and SHAPE_FILE_IO::Write().

UniqueSubshape()

SHAPE* SHAPE_COMPOUND::UniqueSubshape ( ) const

inline

Definition at line 114 of file shape_compound.h.

    {
        return m_shapes.size() != 1 ? nullptr : m_shapes[0];
    }

References m_shapes.

Member Data Documentation

m_cachedBBox

BOX2I SHAPE_COMPOUND::m_cachedBBox

private

Definition at line 137 of file shape_compound.h.

m_dirty

bool SHAPE_COMPOUND::m_dirty

private

Definition at line 138 of file shape_compound.h.

Referenced by AddShape(), and SHAPE_COMPOUND().

m_shapes

std::vector<SHAPE*> SHAPE_COMPOUND::m_shapes

private

Definition at line 139 of file shape_compound.h.

Referenced by AddShape(), BBox(), Collide(), Empty(), Format(), GetIndexableSubshapeCount(), GetIndexableSubshapes(), Move(), SHAPE_COMPOUND(), Shapes(), Size(), UniqueSubshape(), and ~SHAPE_COMPOUND().

m_type

SHAPE_TYPE SHAPE_BASE::m_type

protectedinherited

< type of our shape

Definition at line 110 of file shape.h.

Referenced by SHAPE::IsNull(), and SHAPE_BASE::Type().

MIN_PRECISION_IU

const int SHAPE::MIN_PRECISION_IU = 4

staticinherited

This is the minimum precision for all the points in a shape.

Definition at line 122 of file shape.h.

Referenced by BOOST_AUTO_TEST_CASE(), DIRECTION_45::BuildInitialTrace(), CompareLength(), CIRCLE::Contains(), EDIT_TOOL::FilletTracks(), and CIRCLE::IntersectLine().

---

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

• shape_compound.h
• shape_compound.cpp