VRS - The Virtual Rendering System

version 3.3

scenegraphanalyzer.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2003 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  is  free  software; you can redistribute it and/or  modify it
 * under the terms of the GNU Lesser General Public  License  as  published  by
 * the  Free  Software  Foundation;  either  version 2.1 of the License, or (at
 * your option) any later version. This library  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 Lesser General Public License for more details. You should have received
 * a copy of the GNU Lesser+ General Public License along with this library; if
 * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: scenegraphanalyzer.h 6352 2008-05-22 19:57:33Z Henrik_Buchholz $
// $Date: 2008-05-22 21:57:33 +0200 (Thu, 22 May 2008) $
// $Revision: 6352 $
// $State$
// $Author: Henrik_Buchholz $
//
// $Log$
// Revision 1.27  2006/01/19 08:14:52  baumann
// splitScene() improved
//
// Revision 1.26  2006/01/18 15:51:35  baumann
// new method flattenScene() added
//
// Revision 1.25  2005/11/11 16:12:18  buchholz
// clipScene() supports now PolygonSets with arbitrary vertex data.
//
// Revision 1.24  2005/09/22 06:50:09  lorenz
// changed method replaceSceneObjects()
//
// Revision 1.23  2005/09/12 10:07:44  lorenz
// fixed template implementation so that it can be used outside scenegraphanalyzer.cpp
//
// Revision 1.22  2005/09/09 13:45:39  lorenz
// - Changed replaceSceneObjects() to be template of user parameter type instead of void*
// - added new function convertToPrimitiveQuadTree()
//
// Revision 1.21  2005/09/04 00:49:18  buchholz
// clipScene improved: It can now clip PolygonSets
//
// Revision 1.20  2005/08/16 14:58:24  buchholz
// comment updated
//
// Revision 1.19  2005/08/16 14:46:54  buchholz
// collapseScene allows now to change the scene graph directly
//
// Revision 1.18  2005/07/19 11:58:56  buchholz
// support for ShapeMaterialGL added to splitScene() (header comment)
//
// Revision 1.17  2005/07/01 14:18:20  buchholz
// splitScene() added
//
// Revision 1.16  2005/06/13 16:59:38  baumann
// code cleanup
//
// Revision 1.15  2005/06/06 13:37:21  buchholz
// collapseScene() added
//
// Revision 1.14  2005/01/03 01:43:10  klimetschek
// - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
// - removed vrs.vcproj
// minor things:
// - added all glutexamples to vrs4glut.sln
// - fixed some problems in glutexamples
// - removed all project references from all VS projects (using solution wide project dependencies instead)
//
// Revision 1.13  2004/11/09 16:32:49  kirsch
// fixed comments again for doxygen
//
// Revision 1.12  2004/10/28 14:16:01  basch
// Class comment changed (Doxygen style)
//
// Revision 1.11  2004/10/12 14:58:42  buchholz
// user data for replaceSceneObjects() callback added
//
// Revision 1.10  2004/10/06 13:05:45  buchholz
// comment added
//
// Revision 1.9  2004/09/24 08:43:47  buchholz
// static lighting flag added to optimization method
//
// Revision 1.8  2004/09/22 13:33:55  buchholz
// return value of createdOptimizedScene changed from C-Pointer to SO
//
// Revision 1.7  2004/09/21 14:51:23  buchholz
// replaceSceneObjects allows callback to be NULL (now default)
//
// Revision 1.6  2004/09/20 07:51:17  buchholz
// clipScene method added
//
// Revision 1.5  2004/03/12 16:28:41  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.4  2004/02/16 16:42:08  baumann
// - moved class VRS::SceneNode from "vrs/sg/" to "vrs/"
// - renamed class VRS::SceneGraphVisitor to class VRS::SceneNodeVisitor
//     and moved it from "vrs/sg/" to "vrs/"
//
// Revision 1.3  2004/02/03 18:21:10  buchholz
// replaceSceneObjects() method added
//
// Revision 1.2  2004/01/22 13:16:08  buchholz
// findClasses returns now ClassInfo* providing more information than
// classname strings.
// opitmization method added.
//
// Revision 1.1  2003/12/19 16:07:00  buchholz
// no message
//

#ifndef VRS_SG_SCENEGRAPHANALYZER_H
#define VRS_SG_SCENEGRAPHANALYZER_H

#include <vrs/scenenodevisitor.h>
#include <vrs/bounds.h>

namespace VRS {

template<typename T> class Iterator;
template<class RETURN, class ARG1, class ARG2> class CallbackR2;
template<class RETURN, class ARG1> class CallbackR1;

class PolygonSet;
class RenderObj;
class SceneThing;
class TexEnvGL;
class TextureGL;
class Texture2DGL;
class MonoAttribute;

class VRS_CORE_API SceneGraphAnalyzer :
    public SharedObj
{
public:

    static SO<Iterator<const ClassInfo*> > findClasses(
        SO<SceneThing> scene,
        bool traverseSceneThingsOnly = false
    );

    struct Result {
        SO<Iterator<SO<SharedObj> > > objects;
        SO<Iterator<SO<Iterator<SO<RenderObj> > > > > contextObjects;
    }; // struct Result

    static Result findObjects(
        const ID& className,
        SO<SceneThing> scene, 
        bool traverseSceneThingsOnly = false
    );

        static SO<Iterator<SO<RenderObj> > > findLeafs(
        SO<SceneThing> scene
    );

    static SO<SceneThing> createOptimizedScene(
        SO<SceneThing> scene,
        bool checkPreconditions = true, 
        bool useStaticLighting = false
    );


    template<class T>
        static void replaceSceneObjects(
        SO<SceneThing> scene,
        const VRS::ID& className,
        SO<CallbackR2<Iterator<SO<SharedObj> >*, SharedObj*, T> > replaceCB,
        T userData
    );

        static void replaceSceneObjects(
        SO<SceneThing> scene,
        const VRS::ID& className,
        SO<CallbackR1<Iterator<SO<SharedObj> >*, SharedObj*> > replaceCB = 0
    );

    enum ClipMode { CLIPMODE_INSIDE, CLIPMODE_PARTIALLY_INSIDE, CLIPMODE_PARTIALLY_OUTSIDE, CLIPMODE_OUTSIDE };
    enum ClipMask { CLIPMASK_IGNORE_X = 1, CLIPMASK_IGNORE_Y = 2, CLIPMASK_IGNORE_Z = 4 };


    static void clipScene(
        SO<SceneThing> target,
        const Bounds& bounds,
        ClipMode mode,
        ClipMask mask = ClipMask(0),
        bool enablePolygonSetClipping = false
    );

    static SO<Iterator<SO<PolygonSet> > > collapseScene(
        SO<SceneThing> scene,
                bool changeScene = false
    );

    struct TexturedShapes {
        SO<TextureGL> texture;
        std::vector<SO<TexEnvGL> > texEnvs;
        std::vector<SO<MonoAttribute> > colors;
        std::vector<SO<PolygonSet> > shapes;
    };
    static void extractTexturedShapes(
        std::vector<SceneGraphAnalyzer::TexturedShapes>& outTexturedShapes,
        SO<SceneThing> scene
    );

    static void KillLowerLODs(SO<SceneThing> target);

    static SO<SceneThing> flattenScene(
        SO<SceneThing> scene
    );

    static std::pair<SO<SceneThing>, SO<SceneThing> > extractNormalMappedPolygonSets(SO<SceneThing> scene);

    static std::pair<SO<SceneThing>, SO<SceneThing> > splitScene(
        VRS::SO<VRS::SceneThing> scene,
        double alphaThreshold = 0.9
    );

    static void convertToPrimitiveQuadTree(SO<SceneThing> &scene, unsigned int desiredLeafVertexCount = 1000);

    enum ShapeType { SH_PolygonSet, SH_MappedVertexAttributeShapeGL };
    static void forceShapeType(SO<SceneThing> scene, enum ShapeType);

    static void forceTriangleMeshes(SO<SceneThing> scene, bool indexed);

    static void applyBatchSegmentation(SO<SceneThing> scene, unsigned int maxBatchSize = 0xFFFF);

    static void applyVertexCacheOptimization(SO<SceneThing> scene);

    static void optimizeMeshes(SO<SceneThing> scene, unsigned int maxBatchSize = 0xFFFF);

        static int countTriangles(SO<SceneThing> scene);

    static void InvertOrientation(SO<SceneNode> target);

    static bool ValidatePolygonSets(SO<SceneNode> target, bool fixErrors = false);
};

} // namespace VRS

#include <vrs/sg/scenegraphanalyzer.tli>

#endif // VRS_SG_SCENEGRAPHANALYZER_H

---

Generated on Wed May 23 06:00:13 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact