ALPHALINUX5/util/ALPHALINUX5/include/vtk/vtkTextSource.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkTextSource.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:35:51 $
   7   Version:   $Revision: 1.1.1.1 $
   8
   9
  10 Copyright (c) 1993-1998 Ken Martin, Will Schroeder, Bill Lorensen.
  11
  12 This software is copyrighted by Ken Martin, Will Schroeder and Bill Lorensen.
  13 The following terms apply to all files associated with the software unless
  14 explicitly disclaimed in individual files. This copyright specifically does
  15 not apply to the related textbook "The Visualization Toolkit" ISBN
  16 013199837-4 published by Prentice Hall which is covered by its own copyright.
  17
  18 The authors hereby grant permission to use, copy, and distribute this
  19 software and its documentation for any purpose, provided that existing
  20 copyright notices are retained in all copies and that this notice is included
  21 verbatim in any distributions. Additionally, the authors grant permission to
  22 modify this software and its documentation for any purpose, provided that
  23 such modifications are not distributed without the explicit consent of the
  24 authors and that existing copyright notices are retained in all copies. Some
  25 of the algorithms implemented by this software are patented, observe all
  26 applicable patent law.
  27
  28 IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY FOR
  29 DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
  30 OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY DERIVATIVES THEREOF,
  31 EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32
  33 THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
  34 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  35 PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN
  36 "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE
  37 MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  38
  39
  40 =========================================================================*/
  41 // .NAME vtkTextSource - create polygonal text
  42 // .SECTION Description
  43 // vtkTextSource converts a text string into polygons.  This way you can
  44 // insert text into your renderings. It uses the 9x15 font from X Windows.
  45 // You can specify if you want the background to be drawn or not. The
  46 // characters are formed by scan converting the raster font into
  47 // quadrilaterals. Colors are assigned to the letters using scalar data.
  48 // To set the color of the characters with the source's actor property, set
  49 // BackingOff on the text source and ScalarVisibilityOff on the associated
  50 // vtkPolyDataMapper. Then, the color can be set using the associated actor's
  51 // property.
  52 //
  53 // vtkVectorText generates higher quality polygonal representations of
  54 // characters.
  55
  56 // .SECTION See Also
  57 // vtkVectorText
  58
  59 #ifndef __vtkTextSource_h
  60 #define __vtkTextSource_h
  61
  62 #include "vtkPolyDataSource.h"
  63
  64 class VTK_EXPORT vtkTextSource : public vtkPolyDataSource
  65 {
  66 public:
  67   vtkTextSource();
  68   ~vtkTextSource();
  69   static vtkTextSource *New() {return new vtkTextSource;};
  70   const char *GetClassName() {return "vtkTextSource";};
  71   void PrintSelf(ostream& os, vtkIndent indent);
  72
  73   // Description:
  74   // Set/Get the text to be drawn.
  75   vtkSetStringMacro(Text);
  76   vtkGetStringMacro(Text);
  77
  78   // Description:
  79   // Controls whether or not a background is drawn with the text.
  80   vtkSetMacro(Backing,int);
  81   vtkGetMacro(Backing,int);
  82   vtkBooleanMacro(Backing,int);
  83
  84   // Description:
  85   // Set/Get the foreground color. Default is white (1,1,1). ALpha is always 1.
  86   vtkSetVector3Macro(ForegroundColor,float);
  87   vtkGetVectorMacro(ForegroundColor,float,3);
  88
  89   // Description:
  90   // Set/Get the background color. Default is black (0,0,0). Alpha is always 1.
  91   vtkSetVector3Macro(BackgroundColor,float);
  92   vtkGetVectorMacro(BackgroundColor,float,3);
  93
  94 protected:
  95   void Execute();
  96   char *Text;
  97   int  Backing;
  98   float ForegroundColor[4];
  99   float BackgroundColor[4];
 100 };
 101
 102 #endif
 103
 104