gzGroup.h

Go to the documentation of this file.

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

#include "gzNode.h"

enum { 
        GZ_GROUP_SORT_Z,
        GZ_GROUP_SORT_STATE
    };  

//******************************************************************************
// Class    : gzGroup
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981122  Created 
//                                  
//******************************************************************************
class gzGroup : public gzNode
{
public:

    enum{ GZ_CHILD_NOT_IN_LIST=1000001 };

    GZ_GRAPH_EXPORT gzGroup(const gzString & name=GZ_EMPTY_STRING);
    GZ_GRAPH_EXPORT virtual ~gzGroup();
    GZ_GRAPH_EXPORT gzGroup(const gzGroup &copy);
    GZ_GRAPH_EXPORT gzGroup & operator=(const gzGroup &copy);

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface


    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;
    GZ_GRAPH_EXPORT virtual gzVoid  setCopyMode(gzCopyMode mode);


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

    GZ_GRAPH_EXPORT virtual gzVoid updateNode();

    // ---------- group interface ---------------------------------------

    GZ_GRAPH_EXPORT gzULong     getNumberOfNodes();

    GZ_GRAPH_EXPORT gzNode      *getNode( gzULong childIndex );

    GZ_GRAPH_EXPORT gzNode      *getFirstNode();

    GZ_GRAPH_EXPORT gzULong     getNodeIndex( gzNode *child );

    GZ_GRAPH_EXPORT gzVoid      addNode( gzNode *child , gzLong index = -1 );

    GZ_GRAPH_EXPORT gzVoid      addNodeSorted( gzNode *child , const gzDouble & sortVal ,gzBool preInsert=FALSE);

    GZ_GRAPH_EXPORT gzBool      removeNode(gzNode *child,gzListIterator<gzNode> *iterator=NULL);

    GZ_GRAPH_EXPORT gzVoid      removeAllNodes();

    GZ_GRAPH_EXPORT gzVoid      addGroupNodes( const gzGroup *parent );

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

    GZ_GRAPH_EXPORT virtual gzVoid  updateNodeData(gzBool force=FALSE);

    GZ_GRAPH_EXPORT virtual gzBool  isTraversable( gzTraverseAction *action , gzNode *node , gzULong index , gzContext *context ) { return TRUE; }

    GZ_GRAPH_EXPORT virtual gzBool  isGroupNode() { return TRUE; }  // Speed up RTTI

    GZ_GRAPH_EXPORT virtual gzVoid  sortNodes(gzULong sortCriteria, gzBool recursive=FALSE);

    GZ_GRAPH_EXPORT gzRefList<gzNode> & getNodeList();

    GZ_GRAPH_EXPORT virtual gzBool  isChildOrderDependant();    // Default behaviour is false

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

    // ---------- Serializing -------------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid write(gzSerializeAdapter *adapter);
    GZ_GRAPH_EXPORT virtual gzVoid read(gzSerializeAdapter *adapter);
    GZ_GRAPH_EXPORT virtual gzULong getDataSize(gzSerializeAdapter *adapter) const;

protected:

    friend class gzTraverseAction;

    gzRefList<gzNode> m_childList;
};

// Declare smart pointer type
GZ_DECLARE_REFPTR(gzGroup);

//******************************************************************************
// Class    : gzDummyBoundary
//                                  
// Purpose  : To add a dummy boundary update to tree in e.g. a skinned model
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  040803  Created 
//                                  
//******************************************************************************
class gzDummyBoundary : public gzGroup
{
public:

    GZ_GRAPH_EXPORT gzDummyBoundary(const gzString & name=GZ_EMPTY_STRING);
    GZ_GRAPH_EXPORT virtual ~gzDummyBoundary(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Actual action is not to continue rendering of dummy
    GZ_GRAPH_EXPORT virtual gzBool isTraversable( gzTraverseAction *action , gzNode *node , gzULong index, gzContext *context){ return FALSE; }

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

#endif

---