gzNodeOptimizer.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzNodeOptimizer.h
// Module       : 
// Description  : Class definition of the gzNodeOptimizer class
// Author       : Anders Modén      
// Product      : Gizmo3D 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden   
//          
// NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
//          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
//          usage in Game or VisSim development.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  011017  Created file    
//
//******************************************************************************
#ifndef __GZ_NODE_OPTIMIZER_H__
#define __GZ_NODE_OPTIMIZER_H__

#include "gzNode.h"

#include "gzDbFlags.h"

typedef enum {  
                GZ_NODE_OPTIMIZE_DEFAULT                    =   0,          // Default
                GZ_NODE_OPTIMIZE_ONLY_STATES                =   (1<<0),     // Only work on state sharing
                GZ_NODE_OPTIMIZE_DONT_COMBINE_NAME_ENCODED  =   (1<<1),     // Don't combine name encoded nodes
                GZ_NODE_OPTIMIZE_DONT_CONCAT_GEOMETRY       =   (1<<2),     // Don't concat simillar geometry
                GZ_NODE_OPTIMIZE_USE_INDEXED_GEOMETRY       =   (1<<3),     // Try to use indexed geometry
                GZ_NODE_OPTIMIZE_USE_DISPLAYLIST_GEOMETRY   =   (1<<4),     // Try to use DisplayLists
                GZ_NODE_OPTIMIZE_USE_BUFFERED_GEOMETRY      =   (1<<5),     // Try to use VBO
                GZ_NODE_OPTIMIZE_STRIP_USER_DATA            =   (1<<6),     // Strip user data from model to save mem
                GZ_NODE_OPTIMIZE_EXCLUDE_TREE               =   (1<<7),     // Excludes entire tree
                GZ_NODE_OPTIMIZE_NO_PROGRESS_REPORT         =   (1<<8),     // Silent progress
                GZ_NODE_OPTIMIZE_NO_BOUNDARY_CALC           =   (1<<9),     // Silent progress
                GZ_NODE_OPTIMIZE_DONT_FLATTEN_GEOMETRY      =   (1<<10),    // Exclude flatten transforms into sub geometry
                GZ_NODE_OPTIMIZE_DONT_CHANGE_RENDER_ORDER   =   (1<<11),    // Dont do optims that changes render order
                GZ_NODE_OPTIMIZE_DONT_OPTIMIZE_GEOMETRY     =   (1<<12),    // Dont optimize or change geom primitives


                } gzNodeOptimizeLevel;

GZ_USE_BIT_LOGIC(gzNodeOptimizeLevel);

//******************************************************************************
// Class    : gzNodeOptimizer
//                                  
// Purpose  : Utility class to optimize scene graph data
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  011017  Created 
//                                  
//******************************************************************************
class gzNodeOptimizer
{
public:

    GZ_GRAPH_EXPORT gzNodeOptimizer();

    GZ_GRAPH_EXPORT virtual ~gzNodeOptimizer();


    GZ_GRAPH_EXPORT gzNode *optimize(gzNode *node , gzNodeOptimizeLevel level=GZ_NODE_OPTIMIZE_DEFAULT);

    GZ_GRAPH_EXPORT gzBool subOptimize(gzNode *subnode,gzNodeOptimizeLevel level=GZ_NODE_OPTIMIZE_DEFAULT);


    GZ_GRAPH_EXPORT gzVoid exclude(const gzString &pathName);

    GZ_GRAPH_EXPORT gzVoid exclude(gzNode *node);

    GZ_GRAPH_EXPORT gzVoid addCompileCandidate(const gzString &nodeName);
    GZ_GRAPH_EXPORT gzVoid removeCompileCandidate(const gzString &nodeName);


    GZ_GRAPH_EXPORT gzBool isExcluded(gzNode *node,gzNodeOptimizeLevel level);

    GZ_GRAPH_EXPORT gzBool isCompileCandidate(const gzString &nodeName);

    GZ_GRAPH_EXPORT gzVoid  setMaxRecursionDepth(gzULong depth);

    GZ_GRAPH_EXPORT gzULong getMaxRecursionDepth() const;

    GZ_GRAPH_EXPORT gzVoid optimizeState(gzNode *node);

    GZ_GRAPH_EXPORT gzVoid clearStateOptims();

    GZ_GRAPH_EXPORT gzVoid reportProgress(gzUByte progress);

    GZ_GRAPH_EXPORT gzReal getMaxCombineRadius();
    GZ_GRAPH_EXPORT gzVoid setMaxCombineRadius(gzReal radius);

    GZ_GRAPH_EXPORT gzULong getMaxCombinations();
    GZ_GRAPH_EXPORT gzVoid  setMaxCombinations(gzULong combs);

private:

    gzDynamicArray<gzString>                        m_excludePaths;

    gzDict<gzInstanceCompareInterface,gzVoid>       m_excludeNodes;

    gzDict<gzString,gzVoid>                         m_compileCandidate;

    gzULong                                         m_maxRecursionDepth;

    gzRefDict<gzInstanceCompareInterface,gzState>   m_stateDict;

    gzRefDict<gzInstanceCompareInterface,gzState>   m_convertStateDict;

    gzUByte                                         m_lastProgress;

    gzReal                                          m_maxCombineRadius;

    gzULong                                         m_maxCombinations;
};

GZ_GRAPH_EXPORT gzNodeOptimizeLevel getNodeOptimizerFlagsFromDbFlags(const gzSerializeAdapterFlags &dbflags);

#endif // __GZ_NODE_OPTIMIZER_H__

---