dox/Widgets/vtkSphereRepresentation.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkSphereRepresentation.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkSphereRepresentation_h
#define __vtkSphereRepresentation_h

#include "vtkWidgetRepresentation.h"
#include "vtkSphereSource.h" // Needed for fast access to the sphere source

class vtkActor;
class vtkPolyDataMapper;
class vtkSphere;
class vtkSphereSource;
class vtkCellPicker;
class vtkProperty;
class vtkPolyData;
class vtkPoints;
class vtkPolyDataAlgorithm;
class vtkTransform;
class vtkDoubleArray;
class vtkMatrix4x4;
class vtkTextMapper;
class vtkActor2D;
class vtkTextProperty;
class vtkLineSource;

#define VTK_SPHERE_OFF 0
#define VTK_SPHERE_WIREFRAME 1
#define VTK_SPHERE_SURFACE 2

class VTK_WIDGETS_EXPORT vtkSphereRepresentation : public vtkWidgetRepresentation
{
public:
  static vtkSphereRepresentation *New();


  vtkTypeMacro(vtkSphereRepresentation,vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent);

//BTX - used to manage the state of the widget
  enum {Outside=0,MovingHandle,OnSphere,Translating,Scaling};
//ETX


  vtkSetClampMacro(Representation,int,VTK_SPHERE_OFF,VTK_SPHERE_SURFACE);
  vtkGetMacro(Representation,int);
  void SetRepresentationToOff()
    { this->SetRepresentation(VTK_SPHERE_OFF);}
  void SetRepresentationToWireframe()
    { this->SetRepresentation(VTK_SPHERE_WIREFRAME);}
  void SetRepresentationToSurface()
    { this->SetRepresentation(VTK_SPHERE_SURFACE);}


  void SetThetaResolution(int r)
    { this->SphereSource->SetThetaResolution(r); }
  int GetThetaResolution()
    { return this->SphereSource->GetThetaResolution(); }


  void SetPhiResolution(int r)
    { this->SphereSource->SetPhiResolution(r); }
  int GetPhiResolution()
    { return this->SphereSource->GetPhiResolution(); }


  void SetCenter(double c[3]);
  void SetCenter(double x, double y, double z)
    {double c[3]; c[0]=x; c[1]=y; c[2]=z; this->SetCenter(c);}
  double* GetCenter() 
    {return this->SphereSource->GetCenter();}
  void GetCenter(double xyz[3]) 
    {this->SphereSource->GetCenter(xyz);}


  void SetRadius(double r);
  double GetRadius()
    { return this->SphereSource->GetRadius(); }


  vtkSetMacro(HandleVisibility,int);
  vtkGetMacro(HandleVisibility,int);
  vtkBooleanMacro(HandleVisibility,int);


  void SetHandlePosition(double handle[3]);
  void SetHandlePosition(double x, double y, double z)
    {double p[3]; p[0]=x; p[1]=y; p[2]=z; this->SetHandlePosition(p);}
  vtkGetVector3Macro(HandlePosition,double);
  

  void SetHandleDirection(double dir[3]);
  void SetHandleDirection(double dx, double dy, double dz)
    {double d[3]; d[0]=dx; d[1]=dy; d[2]=dz; this->SetHandleDirection(d);}
  vtkGetVector3Macro(HandleDirection,double);


  vtkSetMacro(HandleText,int);
  vtkGetMacro(HandleText,int);
  vtkBooleanMacro(HandleText,int);


  vtkSetMacro(RadialLine,int);
  vtkGetMacro(RadialLine,int);
  vtkBooleanMacro(RadialLine,int);

  void GetPolyData(vtkPolyData *pd);

  void GetSphere(vtkSphere *sphere);


  vtkGetObjectMacro(SphereProperty,vtkProperty);
  vtkGetObjectMacro(SelectedSphereProperty,vtkProperty);
  

  vtkGetObjectMacro(HandleProperty,vtkProperty);
  vtkGetObjectMacro(SelectedHandleProperty,vtkProperty);
  

  vtkGetObjectMacro(HandleTextProperty,vtkTextProperty);
  

  vtkGetObjectMacro(RadialLineProperty,vtkProperty);
  
  void SetInteractionState(int state);


  virtual void PlaceWidget(double bounds[6]);
  virtual void PlaceWidget(double center[3], double handlePosition[3]);
  virtual void BuildRepresentation();
  virtual int ComputeInteractionState(int X, int Y, int modify=0);
  virtual void StartWidgetInteraction(double e[2]);
  virtual void WidgetInteraction(double e[2]);
  virtual double *GetBounds();
  

  virtual void ReleaseGraphicsResources(vtkWindow*);
  virtual int RenderOpaqueGeometry(vtkViewport*);
  virtual int RenderTranslucentPolygonalGeometry(vtkViewport*);
  virtual int RenderOverlay(vtkViewport*);
  virtual int HasTranslucentPolygonalGeometry();
  
protected:
  vtkSphereRepresentation();
  ~vtkSphereRepresentation();

  // Manage how the representation appears
  double LastEventPosition[3];
  
  // the sphere
  vtkActor            *SphereActor;
  vtkPolyDataMapper   *SphereMapper;
  vtkSphereSource     *SphereSource;
  void HighlightSphere(int highlight);

  // The representation of the sphere
  int Representation;

  // Do the picking
  vtkCellPicker *HandlePicker;
  vtkCellPicker *SpherePicker;
  double LastPickPosition[3];
  
  // Methods to manipulate the sphere widget
  void Translate(double *p1, double *p2);
  void Scale(double *p1, double *p2, int X, int Y);
  void PlaceHandle(double *center, double radius);
  virtual void SizeHandles();
  
  // Properties used to control the appearance of selected objects and
  // the manipulator in general.
  vtkProperty *SphereProperty;
  vtkProperty *SelectedSphereProperty;
  vtkProperty *HandleProperty;
  vtkProperty *SelectedHandleProperty;
  void CreateDefaultProperties();

  // Managing the handle
  vtkActor          *HandleActor;
  vtkPolyDataMapper *HandleMapper;
  vtkSphereSource   *HandleSource;
  void HighlightHandle(int);
  int HandleVisibility;
  double HandleDirection[3];
  double HandlePosition[3];

  // Manage the handle label
  int              HandleText;
  vtkTextProperty *HandleTextProperty;
  vtkTextMapper   *HandleTextMapper;
  vtkActor2D      *HandleTextActor;

  // Manage the radial line segment
  int RadialLine;
  vtkProperty       *RadialLineProperty;
  vtkLineSource     *RadialLineSource;
  vtkPolyDataMapper *RadialLineMapper;
  vtkActor          *RadialLineActor;
  
private:
  vtkSphereRepresentation(const vtkSphereRepresentation&);  //Not implemented
  void operator=(const vtkSphereRepresentation&);  //Not implemented
};

#endif