vrml1_node.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015-2016 Cirilo Bernardo <[email protected]>
 * Copyright (C) 2021 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
 */
 
#ifndef VRML1_NODE_H
#define VRML1_NODE_H
 
#define GLM_FORCE_RADIANS
 
#include <glm/gtc/matrix_transform.hpp>
 
#include <list>
#include <map>
#include <string>
 
#include "wrlproc.h"
 
class WRL1NODE;
 
// The dictionary of node DEFs
class NAMEREGISTER
{
public:
 bool AddName( const std::string& aName, WRL1NODE* aNode );
 bool DelName( const std::string& aName, WRL1NODE* aNode );
 WRL1NODE* FindName( const std::string& aName );
 
private:
 std::map< std::string, WRL1NODE* > reg;
};
 
 
class WRL1BASE;
class WRL1MATERIAL;
class WRL1COORDS;
class SGNODE;
 
 
// current settings which may affect all subsequent nodes during translation / rendering
struct WRL1STATUS
{
 WRL1STATUS()
 {
 Init();
 return;
 }
 
 void Init()
 {
 mat = nullptr;
 matbind = WRL1_BINDING::BIND_OVERALL;
 norm = nullptr;
 normbind = WRL1_BINDING::BIND_DEFAULT;
 coord = nullptr;
 txmatrix = glm::scale( glm::mat4( 1.0 ), glm::vec3( 1.0 ) );
 order = WRL1_ORDER::ORD_UNKNOWN;
 creaseLimit = 0.878f;
 return;
 }
 
 // material
 WRL1MATERIAL* mat;
 
 // normals
 WRL1NODE* norm;
 
 // coordinate3
 WRL1COORDS* coord;
 
 // material binding
 WRL1_BINDING matbind;
 
 // normal binding
 WRL1_BINDING normbind;
 
 // transform
 glm::mat4 txmatrix;
 
 // winding order of vertices
 WRL1_ORDER order;
 
 // cos( creaseAngle ) defines a boundary for normals smoothing
 float creaseLimit;
};
 
 
class WRL1NODE
{
public:
 // cancel the dictionary pointer; for internal use only
 void cancelDict( void );
 
 WRL1NODES getNodeTypeID( const std::string& aNodeName );
 
 virtual void unlinkChildNode( const WRL1NODE* aNode );
 
 virtual void unlinkRefNode( const WRL1NODE* aNode );
 
 void addNodeRef( WRL1NODE* aNode );
 
 void delNodeRef( WRL1NODE* aNode );
 
 WRL1NODE( NAMEREGISTER* aDictionary );
 virtual ~WRL1NODE();
 
 // read data via the given file processor and WRL1BASE object
 virtual bool Read( WRLPROC& proc, WRL1BASE* aTopNode ) = 0;
 
 WRL1NODES GetNodeType( void ) const;
 
 WRL1NODE* GetParent( void ) const;
 
 virtual bool SetParent( WRL1NODE* aParent, bool doUnlink = true );
 
 virtual std::string GetName( void );
 virtual bool SetName( const std::string& aName );
 
 const char* GetNodeTypeName( WRL1NODES aNodeType ) const;
 
 size_t GetNItems( void ) const;
 
 virtual WRL1NODE* FindNode( const std::string& aNodeName );
 
 virtual bool AddChildNode( WRL1NODE* aNode );
 
 virtual bool AddRefNode( WRL1NODE* aNode );
 
 std::string GetError( void );
 
 virtual SGNODE* TranslateToSG( SGNODE* aParent, WRL1STATUS* sp ) = 0;
 
private:
 void addItem( WRL1NODE* aNode );
 void delItem( const WRL1NODE* aNode );
 
protected:
 WRL1NODE* m_Parent; // pointer to parent node; may be NULL for top level node
 WRL1NODES m_Type; // type of VRML node
 std::string m_Name; // name to use for referencing the node by name
 
 std::list< WRL1NODE* > m_BackPointers; // nodes which hold a reference to this
 std::list< WRL1NODE* > m_Children; // nodes owned by this node
 std::list< WRL1NODE* > m_Refs; // nodes referenced by this node
 std::list< WRL1NODE* > m_Items; // all nodes in order of addition
 std::string m_error;
 
 WRL1STATUS m_current; // current settings
 SGNODE* m_sgNode; // the SGNODE representation of the display data
 
 // note: once a node is orphaned from a base node it must never access
 // the dictionary since there is no guarantee the dictionary had not
 // been destroyed. It may be possible to enforce this rule via the
 // SetParent() routine if we implement a GetDictionary() function so
 // that a node can obtain the dictionary of its parent. Note that the
 // dictionary must be propagated to all children as well - perhaps
 // this is best done via a SetDictionary() function.
 NAMEREGISTER* m_dictionary;
};
 
#endif // VRML1_NODE_H