svkPlotLine.h

Go to the documentation of this file.

/*
 *  Copyright © 2009-2014 The Regents of the University of California.
 *  All Rights Reserved.
 *
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions are met:
 *  •   Redistributions of source code must retain the above copyright notice, 
 *      this list of conditions and the following disclaimer.
 *  •   Redistributions in binary form must reproduce the above copyright notice, 
 *      this list of conditions and the following disclaimer in the documentation 
 *      and/or other materials provided with the distribution.
 *  •   None of the names of any campus of the University of California, the name 
 *      "The Regents of the University of California," or the names of any of its 
 *      contributors may be used to endorse or promote products derived from this 
 *      software without specific prior written permission.
 *  
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
 *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
 *  OF SUCH DAMAGE.
 */



/*
 *  $URL$
 *  $Rev$
 *  $Author$
 *  $Date$
 *
 *  Authors:
 *      Jason C. Crane, Ph.D.
 *      Beck Olson
 */

#ifndef SVK_PLOT_LINE_H
#define SVK_PLOT_LINE_H

#include <vtkObjectFactory.h>
#include <vtkPoints.h>
#include <vtkDataArray.h>
#include <vtkPolyLine.h>
#include <vector>


namespace svk {

using namespace vtkstd;

class svkPlotLine : public vtkObject
{
    friend class svkPlotLineGrid;

    public:

        enum PlotComponent {
            REAL = 0,
            IMAGINARY,
            MAGNITUDE 
        };

        typedef enum {
            ROW_COLUMN = 0,
            COLUMN_ROW,
            SLICE_ROW,
            ROW_SLICE,
            SLICE_COLUMN,
            COLUMN_SLICE
        } PlotDirection;


        vtkTypeMacro( svkPlotLine, vtkObject );
        
        static svkPlotLine*  New();

        svkPlotLine();
        ~svkPlotLine();

        void                SetData( vtkDataArray* plotData );
        //void                SetPlotAreaBounds( double* bounds );
        void                SetPointRange( int startPt, int endPt );
        void                SetValueRange( double minValue, double maxValue );
        double*             GetBounds();
        void                SetComponent( PlotComponent component );
        float*              GetDataPoints();
        void                SetDataPoints(float* polyLinePoints);
        double*             GetOrigin();
        void                SetOrigin( double* origin );
        double*             GetSpacing();
        void                SetSpacing( double* spacing );
        void                GetDcos( double dcos[3][3] );
        void                SetInvertPlots( bool invertPlots );
        void                SetMirrorPlots( bool mirrorPlots );
        void                SetPlotDirection( int amplitudeDirection, int plotDirection );
        void                            Modified();

        void                    SetDcos(vector< vector<double> >* dcos);

        // vtk macros
        void                            SetGeneratePolyData( bool generatePolyData );
        bool                            GetGeneratePolyData( );

        template <class T>
                void               GeneratePolyDataTemplated( T* castDataPtr );

    protected:
    
        //Members:

        bool                            generatePolyData;
   
        double              plotAreaBounds[6];

        int                 startPt;

        int                 endPt; 

        int                 numPoints;

        int                 numComponents;

        int                 componentOffset;

        double              minValue;

        double              maxValue;

        vtkDataArray*      plotData;

        void*               dataPtr;

        int                             dataType;

        float*              polyLinePoints;

        bool                invertPlots;

        bool                mirrorPlots;

        PlotDirection       plotDirection;

        void                GeneratePolyData();


        int amplitudeIndex;

        int pointIndex;

        float scale[2]; 

        PlotComponent   plotComponent; 

        double          origin[3];
        
        double          spacing[3];

        vector< vector<double> >*  dcos;

        void RecalculateScale();
        void RecalculatePlotAreaBounds();

};


}   //svk


#endif //SVK_PLOT_LINE_H