Commit patch for x3d file reader (with minor changes). Commit other minor patches and fixes

3d-viewer/3d_struct.h

@@ -115,26 +115,6 @@ public:
 
     void Copy( S3D_MASTER* pattern );
     int  ReadData();
-
-    /**
-     * Function ReadMaterial
-     * read the description of a 3D material definition in the form:
-     * DEF yellow material Material (
-     * DiffuseColor 1.00000 1.00000 0.00000e 0
-     * EmissiveColor 0.00000e 0 0.00000e 0 0.00000e 0
-     * SpecularColor 1.00000 1.00000 1.00000
-     * AmbientIntensity 1.00000
-     * Transparency 0.00000e 0
-     * Shininess 1.00000
-     *)
-     * Or type:
-     * USE yellow material
-     */
-    int  ReadMaterial( FILE* file, int* LineNum );
-    int  ReadChildren( FILE* file, int* LineNum );
-    int  ReadShape( FILE* file, int* LineNum );
-    int  ReadAppearance( FILE* file, int* LineNum );
-    int  ReadGeometry( FILE* file, int* LineNum );
     void Set_Object_Coords( std::vector< S3D_VERTEX >& aVertices );
 
 #if defined(DEBUG)

3d-viewer/CMakeLists.txt

@@ -19,6 +19,8 @@ set(3D-VIEWER_SRCS
     3d_toolbar.cpp
     info3d_visu.cpp
     trackball.cpp
+    x3dmodelparser.cpp
+    vrmlmodelparser.cpp
     )
 
 add_library(3d-viewer STATIC ${3D-VIEWER_SRCS})

3d-viewer/modelparsers.h

+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2013 Tuomas Vaherkoski <tuomasvaherkoski@gmail.com>
+ * Copyright (C) 1992-2013 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 modelparsers.h
+ */
+
+#ifndef MODELPARSERS_H
+#define MODELPARSERS_H
+
+#include <map>
+#include <vector>
+#include <wx/string.h>
+
+
+class S3D_MASTER;
+class S3D_VERTEX;
+
+extern void Set_Object_Data( std::vector< S3D_VERTEX >& aVertices, double aBiuTo3DUnits );
+
+class S3D_MODEL_PARSER;
+class X3D_MODEL_PARSER;
+
+/**
+ * abstract class S3D_MODEL_PARSER
+ * Base class for 3D model parsers.
+ */
+class S3D_MODEL_PARSER
+{
+public:
+    S3D_MODEL_PARSER(S3D_MASTER* aMaster)
+    :master(aMaster)
+    {}
+
+    virtual ~S3D_MODEL_PARSER()
+    {}
+
+    S3D_MASTER* GetMaster()
+    {
+        return master;
+    }
+
+    /**
+     * Function Create
+     * Factory method for creating concrete 3D model parsers
+     * Notice that the caller is responible to delete created parser.
+     *
+     * @param aMaster is master object that the parser will fill.
+     * @param aExtension is file extension of the file you are going to parse.
+     */
+    static S3D_MODEL_PARSER* Create( S3D_MASTER* aMaster,
+                                     const wxString aExtension );
+    /**
+     * Function Load
+     *
+     * Concrete parsers should implement this function
+     */
+    virtual void Load(const wxString aFilename) = 0;
+
+private:
+    S3D_MASTER* master;
+};
+
+
+class wxXmlNode;
+
+/**
+ * class X3D_MODEL_PARSER
+ * Implements parser for X3D file format (VRML2.0 successor)
+ * X3D files can be exported from eg. Blender */
+class X3D_MODEL_PARSER: public S3D_MODEL_PARSER
+{
+public:
+    X3D_MODEL_PARSER(S3D_MASTER* aMaster);
+    ~X3D_MODEL_PARSER();
+    void Load(const wxString aFilename);
+
+    typedef std::map< wxString, wxString > PROPERTY_MAP;
+    typedef std::vector< wxXmlNode* > NODE_LIST;
+
+    /**
+     * Function GetChildsByName
+     * Searches all child nodes with aName.
+     *
+     * @param aParent is node to search from
+     * @param aName is the name of node you try to find
+     * @param aResult contains found nodes
+     */
+    static void GetChildsByName(wxXmlNode* aParent, const wxString aName,
+                                NODE_LIST& aResult);
+
+    /**
+     * Function GetNodeProperties
+     * Collects all node properties to map.
+     *
+     * @param aProps contains map of found properties
+     */
+    static void GetNodeProperties(wxXmlNode* aNode, PROPERTY_MAP& aProps);
+
+    /**
+     * Return string representing x3d file in vrml format
+     * Function Load must be called before this function, otherwise empty
+     * data set is returned.
+     */
+    wxString VRML_representation();
+
+private:
+    std::vector<wxString> vrml_materials;
+    std::vector<wxString> vrml_points;
+    std::vector<wxString> vrml_coord_indexes;
+
+    void readTransform( wxXmlNode* aTransformNode );
+    void readMaterial( wxXmlNode* aMatNode );
+    void readIndexedFaceSet( wxXmlNode* aFaceNode,
+                             PROPERTY_MAP& aTransfromProps );
+    bool parseDoubleTriplet( const wxString& aData, S3D_VERTEX& aResult );
+
+    void rotate( S3D_VERTEX& aCoordinate, S3D_VERTEX& aRotAxis, double angle);
+};
+
+/**
+ * class WRL_MODEL_PARSER
+ * Parses
+ */
+class VRML_MODEL_PARSER: public S3D_MODEL_PARSER
+{
+public:
+    VRML_MODEL_PARSER(S3D_MASTER* aMaster);
+    ~VRML_MODEL_PARSER();
+    void Load(const wxString aFilename);
+
+private:
+    /**
+     * Function ReadMaterial
+     * read the description of a 3D material definition in the form:
+     * DEF yellow material Material (
+     * DiffuseColor 1.00000 1.00000 0.00000e 0
+     * EmissiveColor 0.00000e 0 0.00000e 0 0.00000e 0
+     * SpecularColor 1.00000 1.00000 1.00000
+     * AmbientIntensity 1.00000
+     * Transparency 0.00000e 0
+     * Shininess 1.00000
+     *)
+     * Or type:
+     * USE yellow material
+     */
+    int readMaterial( FILE* file, int* LineNum );
+    int readChildren( FILE* file, int* LineNum );
+    int readShape( FILE* file, int* LineNum );
+    int readAppearance( FILE* file, int* LineNum );
+    int readGeometry( FILE* file, int* LineNum );
+    void readCoordsList( FILE* file, char* text_buffer, std::vector< double >& aList, int* LineNum );
+};
+
+#endif // MODELPARSERS_H

common/class_page_info.cpp

@@ -330,8 +330,8 @@ void PAGE_INFO::Format( OUTPUTFORMATTER* aFormatter, int aNestLevel, int aContro
                            GetCustomWidthMils() * 25.4 / 1000.0,
                            GetCustomHeightMils() * 25.4 / 1000.0 );
 
-    if( IsCustom() && IsPortrait() )
-        aFormatter->Print( 0, " portrait" );
+    if( IsPortrait() )
+       aFormatter->Print( 0, " portrait" );
 
     aFormatter->Print( 0, ")\n" );
 }

common/wildcards_and_files_ext.cpp

@@ -95,4 +95,4 @@ const wxString PdfFileWildcard( _( "Portable document format files (*.pdf)|*.pdf
 const wxString PSFileWildcard( _( "PostScript files (.ps)|*.ps" ) );
 const wxString ReportFileWildcard = _( "Report files (*.rpt)|*.rpt" );
 const wxString FootprintPlaceFileWildcard = _( "Footprint place files (*.pos)|*.pos" );
-const wxString VrmlFileWildcard( _( "Vrml files (*.wrl)|*.wrl" ) );
+const wxString Shapes3DFileWildcard( _( "Vrml and x3d files (*.wrl *.x3d)|*.wrl;*.x3d" ) );

eeschema/dialogs/dialog_build_BOM.cpp

@@ -481,7 +481,7 @@ void DIALOG_BUILD_BOM::CreateSpreadSheetPartsShortList( )
     bom_lister.SetCvsFormOn( s_ExportSeparatorSymbol );
 
     // Set the list of fields to add to list
-    for( int ii = FOOTPRINT; ii < FIELD8; ii++ )
+    for( int ii = FOOTPRINT; ii <= FIELD8; ii++ )
         if( IsFieldChecked( ii ) )
             bom_lister.AddFieldIdToPrintList( ii );
     // Write the list of components grouped by values:
@@ -530,7 +530,7 @@ void DIALOG_BUILD_BOM::CreateSpreadSheetPartsFullList( bool aIncludeSubComponent
                                  aIncludeSubComponents );
 
     // Set the list of fields to add to list
-    for( int ii = FOOTPRINT; ii < FIELD8; ii++ )
+    for( int ii = FOOTPRINT; ii <= FIELD8; ii++ )
         if( IsFieldChecked( ii ) )
             bom_lister.AddFieldIdToPrintList( ii );
 
@@ -564,7 +564,7 @@ void DIALOG_BUILD_BOM::CreatePartsAndLabelsFullList( bool aIncludeSubComponents
     bom_lister.SetCvsFormOff();
     bom_lister.SetPrintLocation( s_Add_Location );
     // Set the list of fields to add to list
-    for( int ii = FOOTPRINT; ii < FIELD8; ii++ )
+    for( int ii = FOOTPRINT; ii <= FIELD8; ii++ )
         if( IsFieldChecked( ii ) )
             bom_lister.AddFieldIdToPrintList( ii );
 

include/wildcards_and_files_ext.h

@@ -91,7 +91,7 @@ extern const wxString DrillFileWildcard;
 extern const wxString SVGFileWildcard;
 extern const wxString ReportFileWildcard;
 extern const wxString FootprintPlaceFileWildcard;
-extern const wxString VrmlFileWildcard;
+extern const wxString Shapes3DFileWildcard;
 extern const wxString DocModulesFileName;
 extern const wxString LegacyFootprintLibPathWildcard;
 extern const wxString KiCadFootprintLibFileWildcard;

pcbnew/dialogs/dialog_edit_module_for_BoardEditor.cpp

@@ -431,17 +431,18 @@ void DIALOG_MODULE_BOARD_EDITOR::Browse3DLib( wxCommandEvent& event )
 #ifdef __WINDOWS__
     fullpath.Replace( wxT( "/" ), wxT( "\\" ) );
 #endif
+
     fullfilename = EDA_FileSelector( _( "3D Shape:" ),
                                      fullpath,
                                      wxEmptyString,
-                                     VrmlFileExtension,
-                                     wxGetTranslation( VrmlFileWildcard ),
+                                     wxEmptyString,
+                                     wxGetTranslation( Shapes3DFileWildcard ),
                                      this,
                                      wxFD_OPEN,
                                      true
                                      );
 
-    if( fullfilename == wxEmptyString )
+    if( fullfilename.IsEmpty() )
         return;
 
     wxFileName fn = fullfilename;

pcbnew/dialogs/dialog_edit_module_for_Modedit.cpp

@@ -302,17 +302,18 @@ void DIALOG_MODULE_MODULE_EDITOR::BrowseAndAdd3DLib( wxCommandEvent& event )
 #ifdef __WINDOWS__
     fullpath.Replace( wxT( "/" ), wxT( "\\" ) );
 #endif
+
     fullfilename = EDA_FileSelector( _( "3D Shape:" ),
                                      fullpath,
                                      wxEmptyString,
-                                     VrmlFileExtension,
-                                     wxGetTranslation( VrmlFileWildcard ),
+                                     wxEmptyString,
+                                     wxGetTranslation( Shapes3DFileWildcard ),
                                      this,
                                      wxFD_OPEN,
                                      true
                                      );
 
-    if( fullfilename == wxEmptyString )
+    if( fullfilename.IsEmpty() )
         return;
 
     wxFileName fn = fullfilename;

pcbnew/dialogs/dialog_gendrill_base.cpp

 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version Apr 10 2012)
+// C++ code generated with wxFormBuilder (version Oct  8 2012)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO "NOT" EDIT THIS FILE!
@@ -23,6 +23,7 @@ DIALOG_GENDRILL_BASE::DIALOG_GENDRILL_BASE( wxWindow* parent, wxWindowID id, con
 	bdirnameSizer = new wxStaticBoxSizer( new wxStaticBox( this, wxID_ANY, _("Output directory:") ), wxHORIZONTAL );
 	
 	m_outputDirectoryName = new wxTextCtrl( this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0 );
+	m_outputDirectoryName->SetMaxLength( 0 ); 
 	bdirnameSizer->Add( m_outputDirectoryName, 1, wxBOTTOM|wxRIGHT|wxLEFT, 5 );
 	
 	m_buttonBrowse = new wxButton( this, wxID_ANY, _("Browse"), wxDefaultPosition, wxDefaultSize, 0 );
@@ -79,7 +80,7 @@ DIALOG_GENDRILL_BASE::DIALOG_GENDRILL_BASE( wxWindow* parent, wxWindowID id, con
 	bMiddleBoxSizer->Add( m_Choice_Drill_Map, 0, wxALL|wxEXPAND, 5 );
 	
 	wxStaticBoxSizer* sbOptSizer;
-	sbOptSizer = new wxStaticBoxSizer( new wxStaticBox( this, wxID_ANY, _("Options:") ), wxVERTICAL );
+	sbOptSizer = new wxStaticBoxSizer( new wxStaticBox( this, wxID_ANY, _("Drill File Options:") ), wxVERTICAL );
 	
 	m_Check_Mirror = new wxCheckBox( this, wxID_ANY, _("Mirror y axis"), wxDefaultPosition, wxDefaultSize, 0 );
 	sbOptSizer->Add( m_Check_Mirror, 0, wxRIGHT|wxLEFT, 5 );
@@ -163,7 +164,7 @@ DIALOG_GENDRILL_BASE::DIALOG_GENDRILL_BASE( wxWindow* parent, wxWindowID id, con
 	
 	bSizerButtons->Add( 10, 20, 0, 0, 5 );
 	
-	m_buttonDrill = new wxButton( this, ID_GEN_DRILL_FILE, _("Drill Fille"), wxDefaultPosition, wxDefaultSize, 0 );
+	m_buttonDrill = new wxButton( this, ID_GEN_DRILL_FILE, _("Drill File"), wxDefaultPosition, wxDefaultSize, 0 );
 	m_buttonDrill->SetDefault(); 
 	bSizerButtons->Add( m_buttonDrill, 0, wxALL|wxALIGN_CENTER_HORIZONTAL|wxEXPAND, 5 );
 	
@@ -186,6 +187,7 @@ DIALOG_GENDRILL_BASE::DIALOG_GENDRILL_BASE( wxWindow* parent, wxWindowID id, con
 	bmsgSizer = new wxStaticBoxSizer( new wxStaticBox( this, wxID_ANY, _("Messages:") ), wxVERTICAL );
 	
 	m_messagesBox = new wxTextCtrl( this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, wxTE_MULTILINE|wxTE_READONLY );
+	m_messagesBox->SetMaxLength( 0 ); 
 	m_messagesBox->SetMinSize( wxSize( -1,90 ) );
 	
 	bmsgSizer->Add( m_messagesBox, 1, wxALL|wxEXPAND, 5 );

pcbnew/dialogs/dialog_gendrill_base.fbp

@@ -697,7 +697,7 @@
                                     <property name="proportion">0</property>
                                     <object class="wxStaticBoxSizer" expanded="1">
                                         <property name="id">wxID_ANY</property>
-                                        <property name="label">Options:</property>
+                                        <property name="label">Drill File Options:</property>
                                         <property name="minimum_size"></property>
                                         <property name="name">sbOptSizer</property>
                                         <property name="orient">wxVERTICAL</property>
@@ -1673,7 +1673,7 @@
                                         <property name="gripper">0</property>
                                         <property name="hidden">0</property>
                                         <property name="id">ID_GEN_DRILL_FILE</property>
-                                        <property name="label">Drill Fille</property>
+                                        <property name="label">Drill File</property>
                                         <property name="max_size"></property>
                                         <property name="maximize_button">0</property>
                                         <property name="maximum_size"></property>

pcbnew/dialogs/dialog_gendrill_base.h

 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version Apr 10 2012)
+// C++ code generated with wxFormBuilder (version Oct  8 2012)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO "NOT" EDIT THIS FILE!
@@ -11,6 +11,8 @@
 #include <wx/artprov.h>
 #include <wx/xrc/xmlres.h>
 #include <wx/intl.h>
+class DIALOG_SHIM;
+
 #include "dialog_shim.h"
 #include <wx/string.h>
 #include <wx/textctrl.h>

pcbnew/export_vrml.cpp

@@ -40,6 +40,8 @@
 #include <class_pcb_text.h>
 #include <convert_from_iu.h>
 
+#include "../3d-viewer/modelparsers.h"
+
 #include <vector>
 #include <cmath>
 
@@ -1149,11 +1151,28 @@ static void export_vrml_module( BOARD* aPcb, MODULE* aModule,
                  vrmlm->m_MatScale.y * aVRMLModelsToBiu,
                  vrmlm->m_MatScale.z * aVRMLModelsToBiu );
 
-        fprintf( aOutputFile,
-//                 "  children [\n    Inline {\n      url \"file://%s\"\n    } ]\n",
-                 "  children [\n    Inline {\n      url \"%s\"\n    } ]\n",
-                 TO_UTF8( fname ) );
-        fprintf( aOutputFile, "  }\n" );
+        if( fname.EndsWith( wxT( "x3d" ) ) )
+        {
+            X3D_MODEL_PARSER* parser = new X3D_MODEL_PARSER(vrmlm);
+
+            if(parser)
+            {
+                // embed x3d model in vrml format
+                parser->Load(fname);
+                fprintf( aOutputFile,
+                         "  children [\n %s ]\n", TO_UTF8( parser->VRML_representation() ) );
+                fprintf( aOutputFile, "  }\n" );
+                delete parser;
+            }
+        }
+        else
+        {
+            fprintf( aOutputFile,
+                     "  children [\n    Inline {\n      url \"%s\"\n    } ]\n",
+                     TO_UTF8( fname ) );
+            fprintf( aOutputFile, "  }\n" );
+        }
+
     }
 }