ifsg_api.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]>
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */

 
#ifndef IFSG_API_H
#define IFSG_API_H
 
#include "plugins/3dapi/sg_types.h"
#include "plugins/3dapi/sg_base.h"
#include "plugins/3dapi/c3dmodel.h"
 
class SGNODE;
class SCENEGRAPH;
struct S3D_POINT;
 
namespace S3D
{
    SGLIB_API void GetLibVersion( unsigned char* Major, unsigned char* Minor,
                                  unsigned char* Patch, unsigned char* Revision ) noexcept;

    SGLIB_API void LockModelImport() noexcept;
    SGLIB_API void UnlockModelImport() noexcept;

    class MODEL_IMPORT_LOCK
    {
    public:
        MODEL_IMPORT_LOCK() noexcept { LockModelImport(); }
        ~MODEL_IMPORT_LOCK() { UnlockModelImport(); }
 
        MODEL_IMPORT_LOCK( const MODEL_IMPORT_LOCK& ) = delete;
        MODEL_IMPORT_LOCK& operator=( const MODEL_IMPORT_LOCK& ) = delete;
    };
 
    // functions to extract information from SGNODE pointers
    SGLIB_API S3D::SGTYPES GetSGNodeType( SGNODE* aNode );
    SGLIB_API SGNODE* GetSGNodeParent( SGNODE* aNode );
    SGLIB_API bool AddSGNodeRef( SGNODE* aParent, SGNODE* aChild );
    SGLIB_API bool AddSGNodeChild( SGNODE* aParent, SGNODE* aChild );
    SGLIB_API void AssociateSGNodeWrapper( SGNODE* aObject, SGNODE** aRefPtr );

    SGLIB_API SGVECTOR CalcTriNorm( const SGPOINT& p1, const SGPOINT& p2, const SGPOINT& p3 );

    SGLIB_API bool WriteCache( const char* aFileName, bool overwrite, SGNODE* aNode,
                               const char* aPluginInfo );

    SGLIB_API SGNODE* ReadCache( const char* aFileName, void* aPluginMgr,
                                 bool (*aTagCheck)( const char*, void* ) );

    SGLIB_API bool WriteVRML( const char* filename, bool overwrite, SGNODE* aTopNode,
                              bool reuse, bool renameNodes );
 
    // NOTE: The following functions are used in combination to create a VRML
    // assembly which may use various instances of each SG* representation of a module.
    // A typical use case would be:
    // 1. invoke 'ResetNodeIndex()' to reset the global node name indices
    // 2. for each model pointer provided by 'S3DCACHE->Load()', invoke 'RenameNodes()' once;
    //    this ensures that all nodes have a unique name to present to the final output file.
    //    Internally, RenameNodes() will only rename the given node and all Child subnodes;
    //    nodes which are only referenced will not be renamed. Using the pointer supplied
    //    by 'S3DCACHE->Load()' ensures that all nodes but the returned node (top node) are
    //    children of at least one node, so all nodes are given unique names.
    // 3. if SG* trees are created independently of S3DCACHE->Load() the user must invoke
    //    RenameNodes() as appropriate to ensure that all nodes have a unique name
    // 4. create an assembly structure by creating new IFSG_TRANSFORM nodes as appropriate
    //    for each instance of a component; the component base model as returned by
    //    S3DCACHE->Load() may be added to these IFSG_TRANSFORM nodes via 'AddRefNode()';
    //    set the offset, rotation, etc of the IFSG_TRANSFORM node to ensure correct
    // 5. Ensure that all new IFSG_TRANSFORM nodes are placed as child nodes within a
    //    top level IFSG_TRANSFORM node in preparation for final node naming and output
    // 6. Invoke RenameNodes() on the top level assembly node
    // 7. Invoke WriteVRML() as normal, with renameNodes = false, to write the entire assembly
    //    structure to a single VRML file
    // 8. Clean up by deleting any extra IFSG_TRANSFORM wrappers and their underlying SG*
    //    classes which have been created solely for the assembly output

    SGLIB_API void ResetNodeIndex( SGNODE* aNode );

    SGLIB_API void RenameNodes( SGNODE* aNode );

    SGLIB_API void DestroyNode( SGNODE* aNode ) noexcept;
 
    // NOTE: The following functions facilitate the creation and destruction
    // of data structures for rendering

    SGLIB_API S3DMODEL* GetModel( SCENEGRAPH* aNode );

    SGLIB_API void Destroy3DModel( S3DMODEL** aModel );

    SGLIB_API void Free3DModel( S3DMODEL& aModel );

    SGLIB_API void Free3DMesh( SMESH& aMesh );

    SGLIB_API S3DMODEL* New3DModel( void );

    SGLIB_API void Init3DMaterial( SMATERIAL& aMat );

    SGLIB_API void Init3DMesh( SMESH& aMesh );
} // namespace S3D
 
#endif  // IFSG_API_H