ifsg_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 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:
 * 1. The IFSG wrapper classes shall be aimed at creating a VRML-like
 * intermediate scenegraph representation. Although objects are
 * readily created and added to the structure, no provision shall
 * be made to inspect the structures in detail. For example the
 * SCENEGRAPH class may contain various SGSHAPE and SCENEGRAPH
 * nodes but there shall be no provision to extract those nodes.
 * This was done because in principle all the detailed data shall
 * only be handled within the SG* classes and only data processed
 * via GetRenderData() shall be available via the wrappers.
 */
 
#ifndef IFSG_NODE_H
#define IFSG_NODE_H
 
#include "plugins/3dapi/sg_base.h"
#include "plugins/3dapi/sg_types.h"
 
class SGNODE;
 
class SGLIB_API IFSG_NODE
{
protected:
 SGNODE* m_node;
 
public:
 IFSG_NODE();
 virtual ~IFSG_NODE();
 
 // deleted operators
 IFSG_NODE( const IFSG_NODE& aParent ) = delete;
 IFSG_NODE& operator= ( const IFSG_NODE& ) = delete;
 
 void Destroy( void );
 
 virtual bool Attach( SGNODE* aNode ) = 0;
 
 virtual bool NewNode( SGNODE* aParent ) = 0;
 virtual bool NewNode( IFSG_NODE& aParent ) = 0;
 
 SGNODE* GetRawPtr( void ) noexcept;
 
 S3D::SGTYPES GetNodeType( void ) const;
 
 SGNODE* GetParent( void ) const;
 
 bool SetParent( SGNODE* aParent );
 
 const char* GetName( void );
 
 bool SetName( const char *aName );
 
 const char * GetNodeTypeName( S3D::SGTYPES aNodeType ) const;
 
 SGNODE* FindNode( const char *aNodeName );
 
 bool AddRefNode( SGNODE* aNode );
 bool AddRefNode( IFSG_NODE& aNode );
 
 bool AddChildNode( SGNODE* aNode );
 bool AddChildNode( IFSG_NODE& aNode );
};
 
#endif // IFSG_NODE_H