Volume.h

Go to the documentation of this file.

//------------------------------------------------------------------------
//
//   Joe Kniss
//     3-22-03
//                   ________    ____   ___ 
//                  |        \  /    | /  /
//                  +---+     \/     |/  /
//                  +--+|  |\    /|     < 
//                  |  ||  | \  / |  |\  \ 
//                  |      |  \/  |  | \  \ 
//                   \_____|      |__|  \__\
//                       Copyright  2003 
//                      Joe Michael Kniss
//                   <<< jmk@cs.utah.edu >>>
//               "All Your Base are Belong to Us"
//-------------------------------------------------------------------------

/// volume.h

#ifndef __VOLUME_DOT_H
#define __VOLUME_DOT_H

#include <volume/Volytope.h>
#include <smartptr.h>
#include <nrro/nrro.h>
#include <textureGlift.h>
#include <texture/simTexture.h>
#include <volume/VolField.h>

////////////////////////////////////////////////////////////////////////////
/// Volume, basic container for multi-channel volume data
/// contains VolFields and Volytopes, see these class definitions for
/// for more functionality
////////////////////////////////////////////////////////////////////////////
/// Notes:
///
///  Add data to the fields using the fieldvec:
///    vol->fields->addNrro(myNrro);
///
///  Call vol->update() when you have added all of the fields you want.
///  update calls update on all the fields and creates the volytopes that
///  you will need for rendering the volume.


class Volume : 
   public gutz::Counted, 
   public SimBase
{
public:
   Volume();
   virtual ~Volume(){}

   //////////////////////////////////////////////////
   ///@name Field & Volytope: Public data and accesors
   ///   We have public data, since the interface to it
   ///   throught this class would have to duplicate 
   ///   their interface, exactly.  So what's the point? \n
   ///   Set/Get provided for symetry. 
   ///
   /// TODO: this class really shouldn't own these objects!
   ///@{
   VolFieldVec fields;  //fields, your data
   VolFieldVec getFields() const                    { return fields; }
   void        setFields(const VolFieldVec &vfv)    { fields = vfv; }

   VolytopeVec volys;   //volytopes, generated by "update()"
   VolytopeVec getVolytopes() const                 { return volys; }
   void        setVolytopes(const VolytopeVec &vtv) { volys = vtv; }
   ///@}
   //////////////////////////////////////////////////

   ///////////////////////////////////////////////////
   /// is this object good to go? \n
   /// if not, needs update (most likely), or 
   /// it is mis-configured
   bool        isValid() const {return _valid;}

   ///////////////////////////////////////////////////
   ///@name Types of volumes supported
   ///@{
   enum VOLUME_KIND{ 
      RECTLIN,  //rectilinear - default
      CURVLIN,  //curvilinear - not supported yet
      VOLYTOPE, //generic volytope volume
      UNSTRUCT, //unstructured - not supported yet
   };
   int         getVolType() const    {return _vtype;}
   void        setVolType(int vtype) {_vtype = vtype;}
   ///@}
   ///////////////////////////////////////////////////

   ///////////////////////////////////////////////////
   ///@name Default texture qualities 
   ///   from simTexture.h
   ///@{
   int         getTexQual() const { return _texqual; }
   void        setTexQual(int tq = SIMT_BEST) {_texqual = tq; }
   ///@}

   //////////////////////////////////////////////////
   /// Update the Volume if something changes
   virtual void update();

   //////////////////////////////////////////////////
   ///@name Bricking info
   /// default brick size set to {128,128,128}
   ///@{
   gutz::vec3i  getBrickDims()  const         { return _brickDims; }
   void         setBrickDims(gutz::vec3i bd)  {_brickDims = bd;}
   ///@}

   //////////////////////////////////////////////////
   ///@name Set/Get size of volume.
   /// -1 means that the size isn't set,
   /// and you are using the volytopes native size,
   /// setting the size scales the volytopes so that
   /// collectively they are no larger than the size
   /// along any axis
   ///  need to call "update()" for this to take effect
   ///@{
   float  getSize() const                 { return _size; }
   void   setSize(float size = -1);
   ///@}

   //////////////////////////////////////////////////
   ///@name toggle centering on and off,
   /// need to call "update()" for this to take effect
   ///@{
   bool   getCentered() const         { return _centered; }
   void   setCentered(bool onoff)  
   { if(onoff != _centered) _valid = false; _centered = onoff; }
   ///@}

protected:
   void clearVolytopes();
   void updateVolytopesRL(); ///rectilinear volytopes

   void updateRectLin();

   void setDefault();

   bool         _valid; ///< is the volume valid?
   int          _vtype;  ///< what type of volume is this?
   gutz::vec3i  _brickDims;
   int          _texqual;

   float  _size;
   bool   _centered;
};

typedef gutz::SmartPtr<Volume> VolumeSP;

#endif

---

Send questions, comments, and bug reports to: