vrml2_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) 2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * Copyright (C) 2015-2016 Cirilo Bernardo <[email protected]>
 *
 * 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
 */
 
/*
 * Notes on deleting unsupported entities:
 * 1. PROTO: PROTO ProtoName [parameter list] {body}
 *      the parameter list will always have '[]'. So the items
 *      to delete are: String, List, Body
 * 2. EXTERNPROTO: EXTERNPROTO extern protoname [] MFstring
 *      delete: string, string, string, list, list
 * 3. Unsupported node types:  NodeName (Optional DEF RefName) {body}
 *      This scheme should also apply to PROTO'd node types.
 * 4. ROUTE:  ROUTE nodename1.event to nodename2.event
 *      Delete a String 3 times
 * 5. Script: Script { ... }
 */
 
#ifndef VRML2_NODE_H
#define VRML2_NODE_H
 
#include <list>
#include <string>
 
#include "wrlproc.h"
 
class WRL2BASE;
class SGNODE;
 
class WRL2NODE
{
public:
    WRL2NODE();
    virtual ~WRL2NODE();
 
    // read data via the given file processor and WRL2BASE object
    virtual bool Read( WRLPROC& proc, WRL2BASE* aTopNode ) = 0;
 
    WRL2NODES GetNodeType( void ) const;
 
    WRL2NODE* GetParent( void ) const;
 
    virtual bool SetParent( WRL2NODE* aParent, bool doUnlink = true );
 
    virtual std::string GetName( void );
    virtual bool SetName( const std::string& aName );
 
    const char* GetNodeTypeName( WRL2NODES aNodeType ) const;
 
    virtual WRL2NODE* FindNode( const std::string& aNodeName, const WRL2NODE *aCaller );
 
    virtual bool AddChildNode( WRL2NODE* aNode );
 
    virtual bool AddRefNode( WRL2NODE* aNode );
 
    std::string GetError( void );
 
    virtual SGNODE* TranslateToSG( SGNODE* aParent ) = 0;
 
    WRL2NODES getNodeTypeID( const std::string& aNodeName );
 
    virtual void unlinkChildNode( const WRL2NODE* aNode );
 
    virtual void unlinkRefNode( const WRL2NODE* aNode );
 
    void addNodeRef( WRL2NODE* aNode );
 
    void delNodeRef( WRL2NODE* aNode );
 
    virtual bool isDangling( void ) = 0;
 
protected:
    WRL2NODE* m_Parent;     // pointer to parent node; may be NULL for top level node
    WRL2NODES m_Type;       // type of VRML node
    std::string m_Name;     // name to use for referencing the node by name
 
    std::list< WRL2NODE* > m_BackPointers;  // nodes which hold a reference to this
    std::list< WRL2NODE* > m_Children;      // nodes owned by this node
    std::list< WRL2NODE* > m_Refs;          // nodes referenced by this node
    std::string m_error;
 
    SGNODE* m_sgNode;  // the SGNODE representation of the display data
};
 
#endif  // VRML2_NODE_H