vtkViewImage2D.h

Go to the documentation of this file.

/*========================================================================
 Copyright (c) INRIA - ASCLEPIOS Project (http://www-sop.inria.fr/asclepios).
 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.

 * Neither the name of INRIA or ASCLEPIOS, nor the names of any contributors
 may be used to endorse or promote products derived from this software
 without specific prior written permission.

 * Modified source versions must be plainly marked as such, and must not be
 misrepresented as being the original software.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER 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 AUTHORS 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.
 =========================================================================*/

/*=========================================================================
 Modifications were made by the GoFigure Dev. Team.
 while at Megason Lab, Systems biology, Harvard Medical school, 2009-11

 Copyright (c) 2009-11, President and Fellows of Harvard College.
 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.
 Neither the name of the  President and Fellows of Harvard College
 nor the names 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 OWNER 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.

 =========================================================================*/

#ifndef _vtkViewImage2D_h_
#define _vtkViewImage2D_h_

#include "vtkViewImage.h"
#include "MegaVTK2Configure.h"

#include <map>
#include <list>

#include "vtkTransform.h"
#include "vtkImageActor.h"
#include "vtkInteractorStyleImage2D.h"
#include "vtkSmartPointer.h"

class vtkPlane;
class vtkViewImage2DCommand;
class vtkTransform;
class vtkInteractorStyle;
class vtkInteractorStyleRubberBandZoom;
class vtkOrientationAnnotation;
class vtkPointHandleRepresentation2D;
class vtkCursor2D;
class vtkCellPicker;
class vtkActor;
// class vtkQuadricLODActor;

class VTK_RENDERINGADDON2_EXPORT vtkViewImage2D:public vtkViewImage
{
public:

  static vtkViewImage2D * New();

  vtkTypeRevisionMacro(vtkViewImage2D, vtkViewImage);
  //BTX
  enum {
    VIEW_ORIENTATION_SAGITTAL = 0,
    VIEW_ORIENTATION_CORONAL = 1,
    VIEW_ORIENTATION_AXIAL = 2
    };
  //ETX
  //BTX
  enum {
    VIEW_CONVENTION_RADIOLOGICAL = 0,
    VIEW_CONVENTION_NEUROLOGICAL = 1
    };
  //ETX
  //BTX
  enum {
    INTERACTOR_STYLE_NAVIGATION = 0,
    INTERACTOR_STYLE_RUBBER_ZOOM
    };
  //ETX

  enum ORIENTATION {
    XY = 0,
    XZ = 1,
    YZ = 2
    };

  vtkGetObjectMacro(SlicePlane, vtkPolyData);

  vtkGetObjectMacro(OrientationAnnotation, vtkOrientationAnnotation);

  virtual void SetWorldCoordinates(double pos[3]);

  virtual void SetSlice(int s);

  vtkGetMacro(ViewOrientation, int);

  virtual void SetViewOrientation(int orientation);

  virtual void SetOrientationMatrix(vtkMatrix4x4 *matrix);

  vtkGetMacro(ViewConvention, int);
  virtual void SetViewConvention(int convention);

  virtual double * GetWorldCoordinatesForSlice(int slice);

  virtual int GetSliceForWorldCoordinates(double pos[3]);
  virtual void ResetPosition(void);

  virtual void Reset(void);

  virtual void ResetCamera(void);

  vtkSetMacro(Zoom, double);

  vtkGetMacro(Zoom, double);

  virtual double *GetWorldCoordinatesFromDisplayPosition(int xy[2]);
  virtual double * GetWorldCoordinatesFromDisplayPosition(const int & x,
                                                          const int & y);

  //BTX
  vtkGetObjectMacro (Command, vtkViewImage2DCommand);
  //ETX

  virtual void SetInterpolate(const int & val);

  virtual int GetInterpolate();

  vtkBooleanMacro (Interpolate, int);

  virtual vtkActor * AddDataSet(vtkPolyData *polydata,
                                vtkProperty *property = NULL,
                                const bool & intersection = true,
                                const bool & iDataVisibility = false);

  vtkSetVector3Macro(CameraMotionVector, double);

  vtkGetVector3Macro(CameraMotionVector, double);

  virtual void SetShowAnnotations(const int & iShowAnnotations);
  vtkGetMacro(ShowAnnotations, int);
  vtkBooleanMacro(ShowAnnotations, int);

  void SetCameraFocalAndPosition(double focal[3], double pos[3]);

  void GetCameraFocalAndPosition(double focal[3], double pos[3]);

  vtkGetVector3Macro (ViewCenter, double);

  virtual void Update(void)
  { this->UpdateOrientation(); }

  void SetDefaultInteractionStyle(void)
  {
    vtkInteractorStyleImage2D *t = vtkInteractorStyleImage2D::SafeDownCast (this->InteractorStyle);

    if ( t )
      {
      t->SetDefaultMode();
      }
  }

  void SetZoomInteractionStyle(void)
  {
    vtkInteractorStyleImage2D *t = vtkInteractorStyleImage2D::SafeDownCast (this->InteractorStyle);

    if ( t )
      {
      t->SetZoomMode();
      }
  }

  void SetPanInteractionStyle(void)
  {
    vtkInteractorStyleImage2D *t = vtkInteractorStyleImage2D::SafeDownCast (this->InteractorStyle);

    if ( t )
      {
      t->SetPanMode();
      }
  }

  void SetPickInteractionStyle(void)
  {
    vtkInteractorStyleImage2D *t = vtkInteractorStyleImage2D::SafeDownCast (this->InteractorStyle);

    if ( t )
      {
      t->SetPickMode();
      }
  }


  /*
   * \brief Synchronize the views
   * \param[in] iSynchronize Enable/disable synchronization
   */
  void SynchronizeViews( bool iSynchronize)
  {
    vtkInteractorStyleImage2D *t = vtkInteractorStyleImage2D::SafeDownCast (this->InteractorStyle);
    if ( t )
      {
      t->SynchronizeViews(iSynchronize);
      }
  }

  vtkGetObjectMacro (Cursor, vtkPointHandleRepresentation2D);
  vtkGetObjectMacro (CursorGenerator, vtkCursor2D);

  template< class TContourContainer,
            class TPropertyContainer >
  void AddContours(TContourContainer & iContours,
                   TPropertyContainer & iProperty,
                   const bool & iIntersection = true)
  {
    if ( iContours.size() != iProperty.size() )
      {
      vtkWarningMacro(<< "iContours.size() != iProperty.size()");
      return;
      }

    typedef typename TContourContainer::iterator  ContourContainerIterator;
    typedef typename TPropertyContainer::iterator PropertyContainerIterator;

    ContourContainerIterator contour_it = iContours.begin();
    ContourContainerIterator contour_end = iContours.end();

    PropertyContainerIterator prop_it = iProperty.begin();
    PropertyContainerIterator prop_end = iProperty.end();

    while ( contour_it != contour_end )
      {
      this->AddDataSet(*contour_it, *prop_it, iIntersection);
      ++contour_it;
      ++prop_it;
      }
  }

/*
  template<class TContourContainer>
  void RemoveContours(TContourContainer& iContours)
  {
    typedef typename TContourContainer::iterator ContourContainerIterator;
    ContourContainerIterator contour_it = iContours.begin();
    ContourContainerIterator contour_end = iContours.end();

    while (contour_it != contour_end)
      {
      this->RemoveDataSet(*contour_it);
      ++contour_it;
      }
  }
*/
  std::map<double, vtkActor *> ExtractActors(
    vtkPolyData *iDataSet, ORIENTATION iOrientation);

protected:

  vtkViewImage2D();
  ~vtkViewImage2D();

  virtual void UpdateSlicePlane(void);

  virtual void UpdateCenter(void);

  virtual void UpdateOrientation();

  virtual void PostUpdateOrientation(void);

  virtual void SetSlicePlaneFromOrientation(void);

  virtual int  SetCameraFromOrientation(void);

  virtual void SetAnnotationsFromOrientation(void);

  virtual void SetImplicitPlaneFromOrientation(void);


  // no possibility of changing the upper-left corner annotation because it is
  // bypassed by this method at each mouse movement.
  virtual void UpdateCursor(void);

  virtual void InitializeSlicePlane(void);

  virtual void InstallPipeline(void);

  virtual int SetCameraToConvention(void);

  virtual void SetAnnotationToConvention(void);

  virtual void SetSlicePlaneToConvention(unsigned int axis);

  vtkMatrix4x4 *ConventionMatrix;

  vtkSmartPointer< vtkPlane > SliceImplicitPlane;

  vtkPolyData *SlicePlane;
  vtkOrientationAnnotation *OrientationAnnotation;

  vtkInteractorStyle *InteractorStyleSwitcher;
  vtkInteractorStyleRubberBandZoom *InteractorStyleRubberZoom;
  vtkViewImage2DCommand *Command;
  vtkPointHandleRepresentation2D *Cursor;
  vtkCursor2D *CursorGenerator;

  int ViewOrientation;
  int ViewConvention;
  int InteractorStyleType;

  double ViewCenter[3];

  char SliceAndWindowInformation[64];
  char ImageInformation[64];

  double Zoom;
  double CameraMotionVector[3];
};

#endif /* _vtkViewImage2D_h_ */