KiCad PCB EDA Suite
vrml1_base.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2015-2016 Cirilo Bernardo <cirilo.bernardo@gmail.com>
5  * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
30 #ifndef VRML1_BASE_H
31 #define VRML1_BASE_H
32 
33 #include <list>
34 #include <string>
35 #include <map>
36 
37 #include "vrml1_node.h"
38 
39 class SGNODE;
40 class WRL1INLINE;
41 
45 class WRL1BASE : public WRL1NODE
46 {
47 public:
48  WRL1BASE();
49  virtual ~WRL1BASE();
50 
51  // function to read entire VRML file
52  bool Read( WRLPROC& proc );
53 
54  // read in a VRML node
55  bool ReadNode( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
56 
57  virtual std::string GetName( void ) override;
58  virtual bool SetName( const std::string& aName ) override;
59 
60  bool Read( WRLPROC& proc, WRL1BASE* aTopNode ) override;
61  bool SetParent( WRL1NODE* aParent, bool doUnlink = true ) override;
62  SGNODE* TranslateToSG( SGNODE* aParent, WRL1STATUS* sp ) override;
63 
64 private:
65  // handle cases of USE / DEF
66  bool implementUse( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
67  bool implementDef( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
68 
69  bool readGroup( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
70  bool readSeparator( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
71  bool readSwitch( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
72  bool readMaterial( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
73  bool readMatBinding( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
74  bool readCoords( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
75  bool readFaceSet( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
76  bool readTransform( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
77  bool readShapeHints( WRLPROC& proc, WRL1NODE* aParent, WRL1NODE** aNode );
78 };
79 
80 #endif // VRML1_BASE_H
Represent the top node of a VRML1 model.
Definition: vrml1_base.h:45
bool implementUse(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:111
bool SetParent(WRL1NODE *aParent, bool doUnlink=true) override
Set the parent WRL1NODE of this object.
Definition: vrml1_base.cpp:58
bool readSeparator(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:372
virtual std::string GetName(void) override
Definition: vrml1_base.cpp:64
bool Read(WRLPROC &proc)
Definition: vrml1_base.cpp:77
The base class of all Scene Graph nodes.
Definition: sg_node.h:74
bool readSwitch(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:392
bool readGroup(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:352
virtual ~WRL1BASE()
Definition: vrml1_base.cpp:50
bool readCoords(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:449
bool readTransform(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:489
SGNODE * TranslateToSG(SGNODE *aParent, WRL1STATUS *sp) override
Produce a representation of the data using the intermediate scenegraph structures of the kicad_3dsg l...
Definition: vrml1_base.cpp:529
bool ReadNode(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:200
The base class of all VRML1 nodes.
Definition: vrml1_node.h:116
bool implementDef(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:156
bool readShapeHints(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:509
virtual bool SetName(const std::string &aName) override
Definition: vrml1_base.cpp:71
bool readMatBinding(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:429
bool readMaterial(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:409
bool readFaceSet(WRLPROC &proc, WRL1NODE *aParent, WRL1NODE **aNode)
Definition: vrml1_base.cpp:469