vrml_layer.h

Go to the documentation of this file.

/*
 * file: vrml_layer.h
 *
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-2017 Cirilo Bernardo
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

 
/*
 * Classes and structures to support the tesselation of a PCB for VRML output.
 */
 
#ifndef VRML_LAYER_H
#define VRML_LAYER_H
 
#include <iostream>
#include <vector>
#include <list>
#include <utility>
 
#include <wx/gdicmn.h>
 
class GLUtesselator;
 
typedef unsigned int GLenum;
 
#ifndef M_PI2
#define M_PI2 ( M_PI / 2.0 )
#endif
 
#ifndef M_PI4
#define M_PI4 ( M_PI / 4.0 )
#endif
 
 
struct VERTEX_3D
{
    double  x;
    double  y;
    int i;          // vertex index
    int o;          // vertex order
    bool pth;       // true for plate-through hole
};
 
struct TRIPLET_3D
{
    int i1, i2, i3;
 
    TRIPLET_3D( int p1, int p2, int p3 )
    {
        i1  = p1;
        i2  = p2;
        i3  = p3;
    }
};
 
 
class VRML_LAYER
{
public:
    VRML_LAYER();
    virtual ~VRML_LAYER();

    void GetArcParams( int& aMaxSeg, double& aMinLength, double& aMaxLength );

    bool SetArcParams( int aMaxSeg, double aMinLength, double aMaxLength );

    void ResetArcParams();

    void Clear( void );

    int GetSize( void );

    int GetNContours( void )
    {
        return contours.size();
    }

    int NewContour( bool aPlatedHole = false );

    bool AddVertex( int aContourID, double aXpos, double aYpos );

    bool EnsureWinding( int aContourID, bool aHoleFlag );

    bool AppendCircle( double aXpos, double aYpos, double aRadius, int aContourID,
                       bool aHoleFlag = false );

    bool AddCircle( double aXpos, double aYpos, double aRadius, bool aHoleFlag = false,
                    bool aPlatedHole = false );

    bool AddSlot( double aCenterX, double aCenterY, double aSlotLength, double aSlotWidth,
                  double aAngle, bool aHoleFlag = false, bool aPlatedHole = false );

    bool AppendArc( double aCenterX, double aCenterY, double aRadius, double aStartAngle,
                    double aAngle, int aContourID );

    bool AddArc( double aCenterX, double aCenterY, double aStartX, double aStartY,
                 double aArcWidth, double aAngle, bool aHoleFlag = false,
                 bool aPlatedHole = false );

    bool AddPolygon( const std::vector< wxRealPoint >& aPolySet, double aCenterX, double aCenterY,
                     double aAngle );

    bool Tesselate( VRML_LAYER* holes = NULL, bool aHolesOnly = false );

    bool WriteVertices( double aZcoord, std::ostream& aOutFile, int aPrecision );

    bool Write3DVertices( double aTopZ, double aBottomZ, std::ostream& aOutFile, int aPrecision );

    bool WriteIndices( bool aTopFlag, std::ostream& aOutFile );

    bool Write3DIndices( std::ostream& aOutFile, bool aIncludePlatedHoles = false );

    VERTEX_3D* AddExtraVertex( double aXpos, double aYpos, bool aPlatedHole );

    void glStart( GLenum cmd );

    void glPushVertex( VERTEX_3D* vertex );

    void glEnd( void );

    void SetGLError( GLenum error_id );

    int Import( int start, GLUtesselator* aTesselator );

    VERTEX_3D* GetVertexByIndex( int aPointIndex );

    const std::string& GetError( void );
 
    void SetVertexOffsets( double aXoffset, double aYoffset );

    bool Get3DTriangles( std::vector< double >& aVertexList, std::vector< int >& aIndexPlane,
                         std::vector< int >& aIndexSide, double aTopZ, double aBotZ );

    bool Get2DTriangles( std::vector< double >& aVertexList, std::vector< int > &aIndexPlane,
                         double aHeight, bool aTopPlane );
 
 
private:
    void clearTmp( void );               // clear ephemeral data used by the tesselation routine
 
    // add a triangular facet (triplet) to the output index list
    bool addTriplet( VERTEX_3D* p0, VERTEX_3D* p1, VERTEX_3D* p2 );
 
    // retrieve a vertex given its index; the vertex may be contained in the
    // vertices vector, extra_verts vector, or foreign VRML_LAYER object
    VERTEX_3D* getVertexByIndex( int aPointIndex, VRML_LAYER* holes );
 
    void processFan( void );                 // process a GL_TRIANGLE_FAN list
    void processStrip( void );               // process a GL_TRIANGLE_STRIP list
    void processTri( void );                 // process a GL_TRIANGLES list
 
    void pushVertices( bool holes );            // push the internal vertices
    bool pushOutline( VRML_LAYER* holes );      // push the outline vertices
 
    // calculate number of sides on an arc (angle is in radians)
    int calcNSides( double aRadius, double aAngle );
 
    // returns the number of solid or hole contours
    int checkNContours( bool holes );
 
public:
    bool Fault;
 
private:
    // Arc parameters
    int    maxArcSeg;                       // maximum number of arc segments in a small circle
    double minSegLength;                    // min. segment length
    double maxSegLength;                    // max. segment length
 
    // Vertex offsets to work around a suspected GLU tesselator bug
    double offsetX;
    double offsetY;
 
    bool    fix;                            // when true, no more vertices may be added by the user
    int     idx;                            // vertex index (number of contained vertices)
    int     ord;                            // vertex order (number of ordered vertices)
    std::vector<VERTEX_3D*> vertices;       // vertices of all contours
    std::vector<std::list<int>*> contours;  // lists of vertices for each contour
    std::vector<bool>pth;                   // indicates whether a 'contour' is a PTH or not
    std::vector<bool>solid;                 // indicates whether a 'contour' is a solid or a hole
    std::vector< double > areas;            // area of the contours (positive if winding is CCW)
    std::list<TRIPLET_3D> triplets;         // output facet triplet list (triplet of ORDER values)
    std::list<std::list<int>*> outline;     // indices for outline outputs (index by ORDER values)
    std::vector<int> ordmap;                // mapping of ORDER to INDEX
 
    std::string error;                      // error message
 
    int hidx;                               // number of vertices in the holes
    int eidx;                               // index for extra vertices
    std::vector<VERTEX_3D*> extra_verts;    // extra vertices added for outlines and facets
    std::vector<VERTEX_3D*> vlist;          // vertex list for the GL command in progress
    VRML_LAYER* pholes;                     // pointer to another layer object used for tesselation;
                                            // this object is normally expected to hold only holes
 
    GLUtesselator* tess;            // local instance of the GLU tesselator
    GLenum glcmd;                   // current GL command type ( fan, triangle, tri-strip, loop )
};
 
#endif    // VRML_LAYER_H