vtkBalloonRepresentation.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkBalloonRepresentation.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 vtkBalloonRepresentation_h
#define vtkBalloonRepresentation_h

#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWidgetRepresentation.h"

class vtkTextMapper;
class vtkTextActor;
class vtkTextProperty;
class vtkPoints;
class vtkCellArray;
class vtkPolyData;
class vtkPolyDataMapper2D;
class vtkActor2D;
class vtkProperty2D;
class vtkImageData;
class vtkTexture;
class vtkPoints;
class vtkPolyData;
class vtkPolyDataMapper2D;
class vtkActor2D;

class VTKINTERACTIONWIDGETS_EXPORT vtkBalloonRepresentation : public vtkWidgetRepresentation
{
public:
  static vtkBalloonRepresentation *New();


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


  virtual void SetBalloonImage(vtkImageData *img);
  vtkGetObjectMacro(BalloonImage,vtkImageData);


  vtkGetStringMacro(BalloonText);
  vtkSetStringMacro(BalloonText);


  vtkSetVector2Macro(ImageSize,int);
  vtkGetVector2Macro(ImageSize,int);


  virtual void SetTextProperty(vtkTextProperty *p);
  vtkGetObjectMacro(TextProperty,vtkTextProperty);


  virtual void SetFrameProperty(vtkProperty2D *p);
  vtkGetObjectMacro(FrameProperty,vtkProperty2D);


  virtual void SetImageProperty(vtkProperty2D *p);
  vtkGetObjectMacro(ImageProperty,vtkProperty2D);

//BTX
  enum {ImageLeft=0,ImageRight,ImageBottom,ImageTop};
//ETX

  vtkSetMacro(BalloonLayout,int);
  vtkGetMacro(BalloonLayout,int);
  void SetBalloonLayoutToImageLeft() {this->SetBalloonLayout(ImageLeft);}
  void SetBalloonLayoutToImageRight() {this->SetBalloonLayout(ImageRight);}
  void SetBalloonLayoutToImageBottom() {this->SetBalloonLayout(ImageBottom);}
  void SetBalloonLayoutToImageTop() {this->SetBalloonLayout(ImageTop);}
  void SetBalloonLayoutToTextLeft() {this->SetBalloonLayout(ImageRight);}
  void SetBalloonLayoutToTextRight() {this->SetBalloonLayout(ImageLeft);}
  void SetBalloonLayoutToTextTop() {this->SetBalloonLayout(ImageBottom);}
  void SetBalloonLayoutToTextBottom() {this->SetBalloonLayout(ImageTop);}


  vtkSetVector2Macro(Offset,int);
  vtkGetVector2Macro(Offset,int);


  vtkSetClampMacro(Padding,int,0,100);
  vtkGetMacro(Padding,int);


  virtual void StartWidgetInteraction(double e[2]);
  virtual void EndWidgetInteraction(double e[2]);
  virtual void BuildRepresentation();
  virtual int ComputeInteractionState(int X, int Y, int modify=0);


  virtual void ReleaseGraphicsResources(vtkWindow *w);
  virtual int RenderOverlay(vtkViewport *viewport);

  enum _InteractionState {Outside=0, OnText, OnImage};

protected:
  vtkBalloonRepresentation();
  ~vtkBalloonRepresentation();

  // The balloon text and image
  char         *BalloonText;
  vtkImageData *BalloonImage;

  // The layout of the balloon
  int BalloonLayout;

  // Controlling placement
  int Padding;
  int Offset[2];
  int ImageSize[2];

  // Represent the text
  vtkTextMapper       *TextMapper;
  vtkActor2D          *TextActor;
  vtkTextProperty     *TextProperty;

  // Represent the image
  vtkTexture          *Texture;
  vtkPolyData         *TexturePolyData;
  vtkPoints           *TexturePoints;
  vtkPolyDataMapper2D *TextureMapper;
  vtkActor2D          *TextureActor;
  vtkProperty2D       *ImageProperty;

  // The frame
  vtkPoints           *FramePoints;
  vtkCellArray        *FramePolygon;
  vtkPolyData         *FramePolyData;
  vtkPolyDataMapper2D *FrameMapper;
  vtkActor2D          *FrameActor;
  vtkProperty2D       *FrameProperty;

  // Internal variable controlling rendering process
  int TextVisible;
  int ImageVisible;

  // Helper methods
  void AdjustImageSize(double imageSize[2]);
  void ScaleImage(double imageSize[2],double scale);

private:
  vtkBalloonRepresentation(const vtkBalloonRepresentation&);  //Not implemented
  void operator=(const vtkBalloonRepresentation&);  //Not implemented
};

#endif