SDS.h

Go to the documentation of this file.

/* $Id: SDS.h,v 1.4 2002/11/20 15:22:15 cvs Exp $ */

#ifndef __SDS_H
#define __SDS_H

#include <esg/Definitions.h>
#include <esg/SceneGraphObject.h>
#include <esg/List.h>

/*
 * Generic class for spatial data structures.
 *
 * Spatial data structures can order only those objects that have
 * a geometry. Intangible objects are therefore stored unsorted in list.
 * They should be treated by only such iterator functions that
 * do not require geometry.
 *
 * Spatial data structures should never destroy objects it stores.
 */

namespace esg {

class OGSCENE_EXPORT Iterator;
class OGSCENE_EXPORT InspectorSDS;

class OGSCENE_EXPORT SDS {
    friend class IteratorSDS;
    friend class InspectorSDS;
    
protected:
    bool                   _delayBuild;
    List<SceneGraphObject> _intangibleChildren;
    
protected:
    virtual void _duplicate_attributes (const SDS&);

    SDS () {}
  
public:
    // When delayBuild is set to true then creation of inner structure
    // is delaied until the build() method is called - see build() for
    // more details
    SDS (bool delayBuild) : _delayBuild(delayBuild) {}

    virtual ~SDS () { _intangibleChildren.deleteAll(); }

    // Convert two tranformation matrices into one mixed so that the
    // left matrix becames initial.
    static Matrix4* multiTrans (const Matrix4*, const Matrix4*, Vector3&);

    // The same as previous but ignore "stretching". Return the only maximal
    // scale value ration instead
    static Matrix4* multiTrans (const Matrix4*, const Matrix4*, double&);
        
    virtual SDS*          clone           () const   = 0;
    virtual Iterator*     createIterator  ()         = 0;
    virtual InspectorSDS* createInspector (unsigned) = 0;
    
    // Operations changing inner structure must be fixed in SDS
    // interface. Operations which traverse inner structure can be
    // moved to Iterator.
    //
    // All operation are applied locally (not recursivelly to sub-nodes)
    virtual int               append  (SceneGraphObject*)       = 0;
    virtual SceneGraphObject* detach  (SceneGraphObject::OID)   = 0;

    // Update inner structure. Typically when some stored object
    // has been moved.
    virtual bool update (void) = 0;

    // Build inner structure. Some space sub-division structures
    // may preffer its real creation not until they know most of storing
    // objects.
    // This method must be called after all objects are appended when
    // delayBuild is set to true in constructor
    virtual bool build (void) = 0;

    // Dump the tree structure into (opened) file
    virtual void dump (const char* /* intent */, const char* /* tab */) = 0;
    virtual void dump (const char* /* file name */)
    {
        dump("", " ");
        /* to do */
    } 

    // Metrices
//    virtual void acceptMetric (Metric&) = 0;

    // debugging:
    virtual void __debug() {
        fprintf(stderr,"SDS: No debug info\n");
    }
};

}; // namespace

#endif // __SDS_H

---