gzRecursive.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzRecursive.h
// Module       : 
// Description  : Class definition of the gzRecursive 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  991116  Created file    
//
//******************************************************************************
#ifndef __GZ_RECURSIVE_H__
#define __GZ_RECURSIVE_H__

#include "gzGroup.h"
#include "gzThread.h"

class gzRecursiveData 
{
public:

    gzRecursiveData():depth(0){};
    virtual ~gzRecursiveData(){};

    gzReal depth;

    gzQueue<gzReal> depthStorage;
};


//******************************************************************************
// Class    : gzRecursive
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  991116  Created 
//                                  
//******************************************************************************
class gzRecursive : public gzGroup
{
public:
    GZ_GRAPH_EXPORT gzRecursive(const gzString & name=GZ_EMPTY_STRING);
    GZ_GRAPH_EXPORT virtual ~gzRecursive();

    GZ_GRAPH_EXPORT gzRecursive(const gzRecursive &copy);

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface


    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;


    // ---------- Common graph functions --------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid updateNode();

    GZ_GRAPH_EXPORT virtual gzVoid  updateNodeData(gzBool force=FALSE);

    // ---------- Action Interface --------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);
    GZ_GRAPH_EXPORT virtual gzBool isTraversable( gzTraverseAction *action , gzNode *node , gzULong index, gzContext *context);
    GZ_GRAPH_EXPORT virtual gzVoid postTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    GZ_GRAPH_EXPORT virtual gzActionStage useActionStage( gzTraverseAction *actionclass , gzContext *context);

    // ---------- Recursive ---------------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setMaxDepth( gzReal depth );
    GZ_GRAPH_EXPORT gzVoid  setTransform(const gzMatrix4 &transform);
    GZ_GRAPH_EXPORT gzVoid  setMaxDepthNode(gzNode *node);
    GZ_GRAPH_EXPORT gzVoid  useDistanceDepth(gzBool on);
    GZ_GRAPH_EXPORT gzVoid  setDistanceDepthEquation(gzReal farDistance=100,gzReal speed=1);

    // ---------- Render models -----------------------------------------

    GZ_GRAPH_EXPORT gzVoid  renderOnRecursion( gzBool on=FALSE );

    GZ_GRAPH_EXPORT gzVoid  transferLightStates( gzBool on=FALSE );


    // ---------- Debug function ----------------------------------------
    GZ_GRAPH_EXPORT virtual gzVoid  debugOutputTraverse(gzString base , gzString anchor , gzDebugFlags features);
    GZ_GRAPH_EXPORT virtual gzVoid  debugOutput(gzString base , gzString anchor , gzDebugFlags features);

    GZ_GRAPH_EXPORT virtual gzNode *    find(const gzString &path,gzBool recursive=TRUE);
    GZ_GRAPH_EXPORT virtual gzBool      hasSiblingNode(gzNode *child);

    // --------- Properties --------------------------------------------

    GZ_PROPERTY_EXPORT(gzBool,          RelativeSceneTransform,     GZ_GRAPH_EXPORT);

protected:

    GZ_GRAPH_EXPORT gzReal  evaluateMaxDepth(gzContext *context);

    gzReal                                              m_maxDepth;
    gzLateBindData<gzMatrix4>                           m_transform;
    gzReal                                              m_maxscale;
    gzRefPointer<gzNode>                                m_maxDepthNode;

    gzLateBindData<gzRealXY>                            m_distanceEquation;

    gzBool                                              m_renderOnRecursion:1;
    gzBool                                              m_transferLightState:1;

    gzULong                                             m_id;
    static gzUniqueIDManager                            s_idManager;
};


#endif

---