sg_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-2017 Cirilo Bernardo <cirilo.bernardo@gmail.com>
 * Copyright (C) 2020 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 SG_NODE_H
#define SG_NODE_H

#include <iostream>
#include <string>
#include <list>
#include <vector>
#include <map>
#include <glm/glm.hpp>

#include "plugins/3dapi/c3dmodel.h"
#include "plugins/3dapi/sg_base.h"
#include "plugins/3dapi/sg_types.h"

class SGNODE;
class SGAPPEARANCE;

namespace S3D
{
    char const* GetNodeTypeName( S3D::SGTYPES aType ) noexcept;

    struct MATLIST
    {
        std::vector< SGAPPEARANCE const* > matorder;    // materials in order of addition
        std::map< SGAPPEARANCE const*, int > matmap;    // mapping from material to index
    };

    bool GetMatIndex( MATLIST& aList, SGNODE* aNode, int& aIndex );

    void INIT_SMATERIAL( SMATERIAL& aMaterial );
    void INIT_SMESH( SMESH& aMesh ) noexcept;
    void INIT_S3DMODEL( S3DMODEL& aModel ) noexcept;

    void FREE_SMESH( SMESH& aMesh) noexcept;
    void FREE_S3DMODEL( S3DMODEL& aModel );
}


class SGNODE
{
public:
    SGNODE( SGNODE* aParent );
    virtual ~SGNODE();

    S3D::SGTYPES GetNodeType( void ) const noexcept;

    SGNODE* GetParent( void ) const noexcept;

    virtual bool SetParent( SGNODE* aParent, bool notify = true ) = 0;

    bool SwapParent( SGNODE* aNewParent );

    const char* GetName( void );
    void SetName(const char *aName);

    const char * GetNodeTypeName( S3D::SGTYPES aNodeType ) const noexcept;

    virtual SGNODE* FindNode( const char *aNodeName, const SGNODE *aCaller ) = 0;

    virtual bool AddRefNode( SGNODE* aNode ) = 0;

    virtual bool AddChildNode( SGNODE* aNode ) = 0;

    void AssociateWrapper( SGNODE** aWrapperRef ) noexcept;

    void DisassociateWrapper( SGNODE** aWrapperRef ) noexcept;

    void ResetNodeIndex( void ) noexcept;

    virtual void ReNameNodes( void ) = 0;

    virtual bool WriteVRML( std::ostream& aFile, bool aReuseFlag ) = 0;

    virtual bool WriteCache( std::ostream& aFile, SGNODE* parentNode ) = 0;

    virtual bool ReadCache( std::istream& aFile, SGNODE* parentNode ) = 0;

    virtual void unlinkChildNode( const SGNODE* aNode ) = 0;

    virtual void unlinkRefNode( const SGNODE* aNode ) = 0;

    void addNodeRef( SGNODE* aNode );

    void delNodeRef( const SGNODE* aNode );

    bool isWritten( void ) noexcept
    {
        return m_written;
    }

protected:
    std::list< SGNODE* > m_BackPointers;    
    SGNODE* m_Parent;       
    S3D::SGTYPES m_SGtype;  
    std::string m_Name;     
    bool m_written;         

private:
    SGNODE** m_Association; 
};

#endif  // SG_NODE_H