tree.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1999 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: tree.h,v $ $Revision: 1.6 $ $State: Exp $
*********************************************************************/
#ifndef tree_H_
#define tree_H_

#include "gdb/gdbDefines.h"
#include "gdb/gdbCulturalFeature.h"
#include "geometry/homogeneousTransformMatrix.h"
#include "geometry/point.h"

enum DtTreeType
{
   DECIDUOUS,
   CONIFEROUS,
   BUSH_OR_SHRUB
};
 
// class DtTree:
//
// Instances of DtTree are
class DT_DLL_gdb DtTree : public DtGdbCulturalFeature
{
public:

   // default constructor
   DtTree();

   // destructor
   virtual ~DtTree();

private:
   // copy constructor - unimplemented
   DtTree(const DtTree& orig);

   // assignment operator - unimplemented
   DtTree& operator=(const DtTree& orig);

public:
   //accessors/mutators

   //set/get functions for tree type
   virtual DtTreeType treeType() const;
   virtual void setTreeType(DtTreeType newTreeType);

   // set/get the location of the tree
   virtual const DtPoint& location() const;
   virtual void setLocation(const DtPoint& p);

   // set/get the height of trunk of the tree
   virtual double trunkHeight() const;
   virtual void setTrunkHeight(double h);

   // set/get the width of trunk of the tree
   virtual double trunkWidth() const;
   virtual void setTrunkWidth(double w);

   // set/get the height of foliage of the tree
   virtual double foliageHeight() const;
   virtual void setFoliageHeight(double h);

   // set/get the width of foliage of the tree
   virtual double foliageWidth() const;
   virtual void setFoliageWidth(double w);

   // set/get the foliage density of the tree
   virtual double foliageDensity() const;
   virtual void setFoliageDensity(double d);
  
   // obtain the extent of the tree
   virtual DtExtent extent() const;

 // redefine the input extent to include the tree
   virtual void expandExtent(DtExtent& extent) const;

   // debugging aid
   virtual void dump(int indentLevel) const;

   // Applies the specified transform to its location.  
   // Ignores the flag.
   // NOTE:  Does NOT transform ANY of the other parameters
   // Returns false if the transformation fails for any reason.
   virtual bool applyTransform(const DtHomogeneousTransformMatrix& matrix,
                               bool createNewVertices);

protected:

  DtPoint     myLocation;
  DtTreeType  myTreeType;
  double      myTrunkHeight;
  double      myTrunkWidth;
  double      myFoliageHeight;
  double      myFoliageWidth;
  double      myFoliageDensity; // a real between 0 and 1

};

inline DtTreeType DtTree::treeType() const
{
   return myTreeType;
}

inline void DtTree::setTreeType(DtTreeType newTreeType)
{
   myTreeType = newTreeType;
}

inline const DtPoint& DtTree::location() const
{
   return(myLocation);
}

inline void DtTree::setLocation(const DtPoint& p)
{
   myLocation = p;
}

inline double DtTree::trunkHeight() const
{
   return myTrunkHeight;
}

inline void DtTree::setTrunkHeight(double h)
{
   myTrunkHeight = h;
}

inline double DtTree::trunkWidth() const
{
   return myTrunkWidth;
}

inline void DtTree::setTrunkWidth(double w)
{
   myTrunkWidth = w;
}

inline double DtTree::foliageHeight() const
{
   return myFoliageHeight;
}

inline void DtTree::setFoliageHeight(double h)
{
   myFoliageHeight = h;
}

inline double DtTree::foliageWidth() const
{
   return myFoliageWidth;
}

inline void DtTree::setFoliageWidth(double w)
{
   myFoliageWidth = w;
}

inline double DtTree::foliageDensity() const
{
   return myFoliageDensity;
}

inline void DtTree::setFoliageDensity(double d)
{
   myFoliageDensity = d;
}
#endif