/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com * Copyright (C) 2011 Wayne Stambaugh * Copyright (C) 1992-2011 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, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ /** * @file 3d_struct.h */ #ifndef STRUCT_3D_H #define STRUCT_3D_H #include #include /* 3D modeling units -> PCB units conversion scale: * 1 "3D model unit" wings3d = 1 unit = 2.54 mm = 0.1 inch = 100 mils */ #define UNITS3D_TO_UNITSPCB (IU_PER_MILS * 100) class S3D_MASTER; class STRUCT_3D_SHAPE; /* S3D_VERTEX manages a 3D coordinate (3 float numbers: x,y,z coordinates)*/ class S3D_VERTEX { public: double x, y, z; public: S3D_VERTEX() { x = y = z = 0.0; } S3D_VERTEX( double px, double py, double pz) { x = px; y = py; z = pz; } }; class S3D_MATERIAL : public EDA_ITEM /* openGL "material" data*/ { public: wxString m_Name; S3D_VERTEX m_DiffuseColor; S3D_VERTEX m_EmissiveColor; S3D_VERTEX m_SpecularColor; float m_AmbientIntensity; float m_Transparency; float m_Shininess; public: S3D_MATERIAL( S3D_MASTER* father, const wxString& name ); S3D_MATERIAL* Next() const { return (S3D_MATERIAL*) Pnext; } S3D_MATERIAL* Back() const { return (S3D_MATERIAL*) Pback; } void SetMaterial(); #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const { ShowDummy( os ); } // override #endif }; /* Master structure for a 3D item description */ class S3D_MASTER : public EDA_ITEM { public: S3D_VERTEX m_MatScale; S3D_VERTEX m_MatRotation; S3D_VERTEX m_MatPosition; STRUCT_3D_SHAPE* m_3D_Drawings; S3D_MATERIAL* m_Materials; enum FILE3D_TYPE { FILE3D_NONE = 0, FILE3D_VRML, FILE3D_IDF, FILE3D_UNKNOWN }; private: wxString m_Shape3DName; /* 3D shape name in 3D library */ FILE3D_TYPE m_ShapeType; double m_lastTransparency; // last transparency value from // last material in use bool m_loadTransparentObjects; bool m_loadNonTransparentObjects; public: S3D_MASTER( EDA_ITEM* aParent ); ~S3D_MASTER(); S3D_MASTER* Next() const { return (S3D_MASTER*) Pnext; } S3D_MASTER* Back() const { return (S3D_MASTER*) Pback; } // Accessors void SetLastTransparency( double aValue ) { m_lastTransparency = aValue; } void SetLoadTransparentObjects( bool aLoad ) { m_loadTransparentObjects = aLoad; } void SetLoadNonTransparentObjects( bool aLoad ) { m_loadNonTransparentObjects = aLoad; } void Insert( S3D_MATERIAL* aMaterial ); /** * Function IsOpenGlAllowed * @return true if opengl current list accepts a gl data * used to filter transparent objects, which are drawn after * non transparent objects */ bool IsOpenGlAllowed(); void Copy( S3D_MASTER* pattern ); /** * Function ReadData * Select the parser to read the 3D data file (vrml, x3d ...) * and build the description objects list */ int ReadData(); /** * Function ObjectCoordsTo3DUnits * @param aVertices = a list of 3D coordinates in shape units * to convert to 3D canvas units, according to the * footprint 3Dshape rotation, offset and scale parameters */ void ObjectCoordsTo3DUnits( std::vector< S3D_VERTEX >& aVertices ); #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const { ShowDummy( os ); } // override #endif /** * Function Is3DType * returns true if the argument matches the type of model referred to * by m_Shape3DName */ bool Is3DType( enum FILE3D_TYPE aShapeType ); const wxString& GetShape3DName( void ) { return m_Shape3DName; } /** * Function GetShape3DFullFilename * @return the full filename of the 3D shape, * expanding environment variable (if any ) and/or adding default 3D path * given by environment variable KISYS3DMOD */ const wxString GetShape3DFullFilename(); /** * Function SetShape3DName * @param aShapeName = file name of the data file relative to the 3D shape * * Set the filename of the 3D shape, and depending on the file extention * (vrl, x3d, idf ) the type of file. */ void SetShape3DName( const wxString& aShapeName ); }; /* Describes a complex 3D */ class STRUCT_3D_SHAPE : public EDA_ITEM { public: S3D_VERTEX* m_3D_Coord; int* m_3D_CoordIndex; int m_3D_Points; public: STRUCT_3D_SHAPE( EDA_ITEM* aParent ); ~STRUCT_3D_SHAPE(); STRUCT_3D_SHAPE* Next() const { return (STRUCT_3D_SHAPE*) Pnext; } STRUCT_3D_SHAPE* Back() const { return (STRUCT_3D_SHAPE*) Pback; } #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const { ShowDummy( os ); } // override #endif }; /** * Class VERTEX_VALUE_CTRL * displays a vertex for editing. A vertex is a triplet of values * Values can be scale, rotation, offset... */ class VERTEX_VALUE_CTRL { private: wxTextCtrl* m_XValueCtrl, * m_YValueCtrl, * m_ZValueCtrl; public: VERTEX_VALUE_CTRL( wxWindow* parent, wxBoxSizer* BoxSizer ); ~VERTEX_VALUE_CTRL(); /** * Function GetValue * @return the vertex in internal units. */ S3D_VERTEX GetValue(); void SetValue( S3D_VERTEX vertex ); void Enable( bool enbl ); void SetToolTip( const wxString& text ); }; #endif // STRUCT_3D_H