vtkTextActor.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkTextActor.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 vtkTextActor_h
#define vtkTextActor_h
 
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkTexturedActor2D.h"
 
class vtkTextProperty;
class vtkPolyDataMapper2D;
class vtkImageData;
class vtkTextRenderer;
class vtkTransform;
class vtkPolyData;
class vtkPoints;
 
class VTKRENDERINGCORE_EXPORT vtkTextActor : public vtkTexturedActor2D
{
public:
  vtkTypeMacro(vtkTextActor,vtkTexturedActor2D);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  static vtkTextActor *New();
 
  void ShallowCopy(vtkProp *prop);
 
 
  void SetInput(const char *inputString);
  char *GetInput();
 
 
  vtkSetVector2Macro(MinimumSize,int);
  vtkGetVector2Macro(MinimumSize,int);
 
 
  vtkSetMacro(MaximumLineHeight,float);
  vtkGetMacro(MaximumLineHeight,float);
 
 
  vtkSetClampMacro(TextScaleMode, int,
                     TEXT_SCALE_MODE_NONE, TEXT_SCALE_MODE_VIEWPORT);
  vtkGetMacro(TextScaleMode, int);
  void SetTextScaleModeToNone()
    { this->SetTextScaleMode(TEXT_SCALE_MODE_NONE); }
  void SetTextScaleModeToProp()
    { this->SetTextScaleMode(TEXT_SCALE_MODE_PROP); }
  void SetTextScaleModeToViewport()
    { this->SetTextScaleMode(TEXT_SCALE_MODE_VIEWPORT); }
 
//BTX
  enum {
    TEXT_SCALE_MODE_NONE = 0,
    TEXT_SCALE_MODE_PROP,
    TEXT_SCALE_MODE_VIEWPORT
  };
//ETX
 
 
  vtkSetMacro(UseBorderAlign,int);
  vtkGetMacro(UseBorderAlign,int);
  vtkBooleanMacro(UseBorderAlign,int);
 
 
  void SetAlignmentPoint(int point);
  int GetAlignmentPoint();
 
 
  void SetOrientation(float orientation);
  vtkGetMacro(Orientation,float);
 
 
  virtual void SetTextProperty(vtkTextProperty *p);
  vtkGetObjectMacro(TextProperty,vtkTextProperty);
 
  virtual void GetBoundingBox(vtkViewport* vport, double bbox[4]);
 
  virtual void GetSize(vtkViewport* vport, double size[2]);
 
 
  virtual int SetConstrainedFontSize(
    vtkViewport*, int targetWidth, int targetHeight);
  static int SetConstrainedFontSize(
    vtkTextActor*, vtkViewport*, int targetWidth, int targetHeight);
 
 
  static int SetMultipleConstrainedFontSize(
    vtkViewport*, int targetWidth, int targetHeight,
    vtkTextActor** actors, int nbOfActors, int* maxResultingSize);
 
  virtual void SetNonLinearFontScale(double exponent, int target);
 
  void SpecifiedToDisplay(double *pos, vtkViewport *vport, int specified);
 
  void DisplayToSpecified(double *pos, vtkViewport *vport, int specified);
 
  virtual void ComputeScaledFont(vtkViewport *viewport);
 
 
  vtkGetObjectMacro(ScaledTextProperty, vtkTextProperty);
 
  static float GetFontScale(vtkViewport *viewport);
 
//BTX
  virtual void ReleaseGraphicsResources(vtkWindow *);
 
 
  virtual int RenderOpaqueGeometry(vtkViewport* viewport);
  virtual int RenderTranslucentPolygonalGeometry(vtkViewport* ) {return 0;};
  virtual int RenderOverlay(vtkViewport* viewport);
 
 
  virtual int HasTranslucentPolygonalGeometry();
//ETX
 
protected:
  virtual bool RenderImage(vtkTextProperty *tprop, vtkViewport *viewport);
 
 
  virtual bool GetImageBoundingBox(
    vtkTextProperty *tprop, vtkViewport *viewport, int bbox[4]);
 
   vtkTextActor();
  ~vtkTextActor();
 
  int     MinimumSize[2];
  float   MaximumLineHeight;
  double  FontScaleExponent;
  int     TextScaleMode;
  float   Orientation;
  int     UseBorderAlign;
 
  vtkTextProperty *TextProperty;
  vtkImageData *ImageData;
  vtkTextRenderer *TextRenderer;
  vtkTimeStamp  BuildTime;
  vtkTransform *Transform;
  int LastSize[2];
  int LastOrigin[2];
  char *Input;
  bool InputRendered;
  double FormerOrientation;
  int RenderedDPI;
 
  vtkTextProperty *ScaledTextProperty;
 
  // Stuff needed to display the image text as a texture map.
  vtkPolyData* Rectangle;
  vtkPoints*   RectanglePoints;
 
  virtual void ComputeRectangle(vtkViewport *viewport);
 
  virtual int UpdateRectangle(vtkViewport* viewport);
 
private:
  vtkTextActor(const vtkTextActor&);  // Not implemented.
  void operator=(const vtkTextActor&);  // Not implemented.
};
 
 
#endif