vtkCornerAnnotation.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkCornerAnnotation.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 vtkCornerAnnotation_h
#define vtkCornerAnnotation_h
 
#include "vtkRenderingAnnotationModule.h" // For export macro
#include "vtkActor2D.h"
 
class vtkTextMapper;
class vtkImageMapToWindowLevelColors;
class vtkImageActor;
class vtkTextProperty;
 
class VTKRENDERINGANNOTATION_EXPORT vtkCornerAnnotation : public vtkActor2D
{
public:
  vtkTypeMacro(vtkCornerAnnotation,vtkActor2D);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  static vtkCornerAnnotation *New();
 
 
  int RenderOpaqueGeometry(vtkViewport* viewport);
  virtual int RenderTranslucentPolygonalGeometry(vtkViewport* ) {return 0;};
  int RenderOverlay(vtkViewport* viewport);
 
  virtual int HasTranslucentPolygonalGeometry();
 
 
  vtkSetMacro(MaximumLineHeight,double);
  vtkGetMacro(MaximumLineHeight,double);
 
 
  vtkSetMacro(MinimumFontSize,int);
  vtkGetMacro(MinimumFontSize,int);
  vtkSetMacro(MaximumFontSize,int);
  vtkGetMacro(MaximumFontSize,int);
 
 
  vtkSetMacro( LinearFontScaleFactor, double );
  vtkGetMacro( LinearFontScaleFactor, double );
  vtkSetMacro( NonlinearFontScaleFactor, double );
  vtkGetMacro( NonlinearFontScaleFactor, double );
 
  virtual void ReleaseGraphicsResources(vtkWindow *);
 
 
  enum TextPosition
    {
    LowerLeft = 0, 
    LowerRight,    
    UpperLeft,     
    UpperRight,    
    LowerEdge,     
    RightEdge,     
    LeftEdge,      
    UpperEdge      
    };
  static const int NumTextPositions = 8;
 
 
  void SetText(int i, const char *text);
  const char* GetText(int i);
  void ClearAllTexts();
  void CopyAllTextsFrom(vtkCornerAnnotation *ca);
 
 
  void SetImageActor(vtkImageActor*);
  vtkGetObjectMacro(ImageActor,vtkImageActor);
 
 
  void SetWindowLevel(vtkImageMapToWindowLevelColors*);
  vtkGetObjectMacro(WindowLevel,vtkImageMapToWindowLevelColors);
 
 
  vtkSetMacro(LevelShift, double);
  vtkGetMacro(LevelShift, double);
 
 
  vtkSetMacro(LevelScale, double);
  vtkGetMacro(LevelScale, double);
 
 
  virtual void SetTextProperty(vtkTextProperty *p);
  vtkGetObjectMacro(TextProperty,vtkTextProperty);
 
 
  vtkBooleanMacro(ShowSliceAndImage, int);
  vtkSetMacro(ShowSliceAndImage, int);
  vtkGetMacro(ShowSliceAndImage, int);
 
protected:
  vtkCornerAnnotation();
  ~vtkCornerAnnotation();
 
  double MaximumLineHeight;
 
  vtkTextProperty *TextProperty;
 
  vtkImageMapToWindowLevelColors *WindowLevel;
  double LevelShift;
  double LevelScale;
  vtkImageActor *ImageActor;
  vtkImageActor *LastImageActor;
 
  char *CornerText[NumTextPositions];
 
  int FontSize;
  vtkActor2D    *TextActor[NumTextPositions];
  vtkTimeStamp   BuildTime;
  int            LastSize[2];
  vtkTextMapper *TextMapper[NumTextPositions];
 
  int MinimumFontSize;
  int MaximumFontSize;
 
  double LinearFontScaleFactor;
  double NonlinearFontScaleFactor;
 
  int ShowSliceAndImage;
 
 
  virtual void TextReplace(
    vtkImageActor *ia, vtkImageMapToWindowLevelColors *wl);
 
 
  virtual void SetTextActorsPosition(int vsize[2]);
  virtual void SetTextActorsJustification();
 
private:
  vtkCornerAnnotation(const vtkCornerAnnotation&);  // Not implemented.
  void operator=(const vtkCornerAnnotation&);  // Not implemented.
};
 
 
#endif