source: trunk/gui/vizservers/nanovis/Volume.h @ 723

/*
 * ----------------------------------------------------------------------
 * Volume.h: 3d volume class
 *
 * ======================================================================
 *  AUTHOR:  Wei Qiao <qiaow@purdue.edu>
 *           Purdue Rendering and Perceptualization Lab (PURPL)
 *
 *  Copyright (c) 2004-2006  Purdue Research Foundation
 *
 *  See the file "license.terms" for information on usage and
 *  redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 * ======================================================================
 */

#ifndef _VOLUME_H_
#define _VOLUME_H_

#include <string>
#include <vector>

#include "define.h"
#include "Color.h"
#include "Texture3D.h"
#include "Vector3.h"

using namespace std;

struct CutPlane{
  int orient;   //orientation - 1: xy slice, 2: yz slice, 3: xz slice
  float offset; //normalized offset [0,1] in the volume
  bool enabled;

  CutPlane(int _orient, float _offset):
        orient(_orient),
        offset(_offset),
        enabled(true){}
};



enum {CUBIC, VOLQD, ZINCBLENDE};


class Volume{
        

public:
        int volume_type;        //cubic or zincblende

        vector <CutPlane> plane; //cut planes
        int n_components;

        Texture3D* tex; //OpenGL texture storing the volume
        double vmin;    //minimum (unscaled) value in data
        double vmax;    //maximum (unscaled) value in data

        float specular; //specular lighting parameter
        float diffuse;  //diffuse lighting parameter
        float opacity_scale;    //The scale multiplied to the opacity assigned by the transfer function.
                                //Rule of thumb: higher opacity_scale the object is to appear like plastic

        bool data_enabled;      // show/hide cloud of volume data

        bool outline_enabled;   // show/hide outline around volume
        Color outline_color;    // color for outline around volume



        Vector3 location;

        bool enabled; 
        int n_slice;    //number of slices when rendered. The greater the better quality, lower speed. 

        int width;      //The resolution of the data (how many points in each direction.
        int height;     //It is different from the size of the volume object drawn on screen.
        int depth;      //Width, height and depth together determing the proprotion of the volume ONLY.
        
        float size;     //This is the scaling factor that will size the volume on screen.
                        //A render program drawing different objects, always knows how large an object
                        //is in relation to other objects. This size is provided by the render engine.

        float aspect_ratio_width;
        float aspect_ratio_height;
        float aspect_ratio_depth;

        NVISid id;   //OpenGL textue identifier (==tex->id)

        Volume(float x, float y, float z, 
                        int width, int height, int depth, float size,
                        int n_component, float* data, double vmin, double vmax);
        ~Volume();
        
        void enable(); //VolumeRenderer will render an enabled volume and its cutplanes
        void disable();
        void move(Vector3 _loc);
        bool is_enabled();
        Vector3* get_location();

        double range_min() { return vmin; }
        double range_max() { return vmax; }

        void set_n_slice(int val); //set number of slices
        int get_n_slice();      //return number of slices

        void set_size(float s); //set the drawing size of volume 

        //methods related to cutplanes
        int add_cutplane(int _orientation, float _location); //add a plane and returns its index
        void enable_cutplane(int index);
        void disable_cutplane(int index);
        void move_cutplane(int index, float _location);
        CutPlane* get_cutplane(int index);
        int get_cutplane_count();       //returns the number of cutplanes in the volume
        bool cutplane_is_enabled(int index);    //check if a cutplane is enabled

        //methods related to shading. These parameters are per volume 
        float get_specular();
        float get_diffuse();
        float get_opacity_scale();
        void set_specular(float s);
        void set_diffuse(float d);
        void set_opacity_scale(float s);

        void enable_data();
        void disable_data();
        bool data_is_enabled();

        void enable_outline();
        void disable_outline();
        bool outline_is_enabled();
        void set_outline_color(float* rgb);
        void get_outline_color(float* rgb);


        void set_label(int axis, char* txt);    //change the label displayed on an axis
        std::string label[3];   // the labels along each axis 0:x , 1:y, 2:z
};

#endif