include/gdb/netwrkNode.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2001 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: netwrkNode.h,v $ $Revision: 1.21 $ $State: Exp $
*********************************************************************/
#ifndef netwrkNode_H_
#define netwrkNode_H_

// \file netwrkNode.h
// \brief Contains the declaration of the DtNetworkNode class, as well as related interface functions.
//

#include "gdb/gdbDefines.h"
#include "gdb/specMgr.h"
#include "gdb/netwrkSpecEl.h"

#include <vlutil/vlConfig.h>
#include <geometry/point.h>
#include <vlutil/vlNetTypes.h>
#include <vlutil/vlPrint.h>
#include <matrix/3dBoundingVolume.h>
#include <matrix/vlDcm.h>

#include <set>
#include <assert.h>

class DtNetworkEdge;


//
// DtNetworkNode represents a node in the vector network.  Typically, it is used
// to approximate point objects at the level of detail of the network.  For instance,
// in most terrains, trees and other similar objects are usually represented by
// nodes.  Additionally, the nodes are used as glue to join separate edges together
// to create the connected network. 
class DT_DLL_gdb DtNetworkNode : public DtNetworkSpecElement
{
public:

   typedef std::set<DtNetworkEdge*> DtConnectedEdgeContainer;
   typedef DtConnectedEdgeContainer::iterator DtConnectedEdgeIter;
   typedef DtConnectedEdgeContainer::const_iterator DtConnectedEdgeConstIter;

   // default constructor
   DtNetworkNode();

   // destructor
   virtual ~DtNetworkNode();

   virtual void addEdge(DtNetworkEdge& edge);
   virtual void removeEdge(DtNetworkEdge& edge);

   // get the connected edges.
   virtual const DtConnectedEdgeContainer& connectedEdges() const;

   // Get the number of edges connected to the node
   virtual unsigned int degree() const;

   // get/set location
   virtual const DtPoint& location() const;
   virtual void setLocation(const DtPoint& location);

   virtual DtString type();

   virtual int sizeInBytes() const;

   // Override to update our bounding volume and orientation
   virtual bool setSpecification(const DtSpecification& newSpecification, 
      bool allowDuplicates = false);
   virtual void setSpecificationID(DtSpecificationID specID);

   const Dt3dBoundingVolume& boundingVolume() const;
   const DtDcm& orientation() const;

protected:

   virtual void setBoundingVolumeFromSpecification();
   virtual void setOrientationFromSpecification();

protected:

   DtPoint                    myLocation;
   DtConnectedEdgeContainer   myEdges;

   // Bounding volume of node, based on DtWidth, DtHeight, and 
   // DtLength specification attributes.
   Dt3dBoundingVolume         myBoundingVolume;

   // Orientaion of node, based on DtOrienation specification
   // attribute.  In database coordinates.
   DtDcm                      myOrientation;

private:
   // These are private because there is a relationship between
   // nodes and edges that cannot be shared between nodes. If a node
   // is a start node of an edge, then using that node to construct 
   // another node, or to assign it to another node, is improper.

   // copy constructor
   DtNetworkNode(const DtNetworkNode& orig);

   // assignment operator
   DtNetworkNode& operator=(const DtNetworkNode& orig);

};


bool DtNodeIsCircular(const DtNetworkNode& node);


#endif