Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkTextSource Class Reference

#include <vtkTextSource.h>

Inheritance diagram for vtkTextSource:

Inheritance graph
[legend]
Collaboration diagram for vtkTextSource:

Collaboration graph
[legend]
List of all members.

Detailed Description

create polygonal text

vtkTextSource converts a text string into polygons. This way you can insert text into your renderings. It uses the 9x15 font from X Windows. You can specify if you want the background to be drawn or not. The characters are formed by scan converting the raster font into quadrilaterals. Colors are assigned to the letters using scalar data. To set the color of the characters with the source's actor property, set BackingOff on the text source and ScalarVisibilityOff on the associated vtkPolyDataMapper. Then, the color can be set using the associated actor's property.

vtkVectorText generates higher quality polygonal representations of characters.

See also:
vtkVectorText
Tests:
vtkTextSource (Tests)

Definition at line 43 of file vtkTextSource.h.
virtual void SetText (const char *)
virtual char * GetText ()
static vtkTextSourceNew ()

Public Types

typedef vtkPolyDataAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetBacking (int)
virtual int GetBacking ()
virtual void BackingOn ()
virtual void BackingOff ()
virtual void SetForegroundColor (double, double, double)
virtual void SetForegroundColor (double[3])
virtual double * GetForegroundColor ()
virtual void GetForegroundColor (double data[3])
virtual void SetBackgroundColor (double, double, double)
virtual void SetBackgroundColor (double[3])
virtual double * GetBackgroundColor ()
virtual void GetBackgroundColor (double data[3])

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkTextSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTextSource ()
 ~vtkTextSource ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

char * Text
int Backing
double ForegroundColor [4]
double BackgroundColor [4]


Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkTextSource::Superclass
 

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 46 of file vtkTextSource.h.


Constructor & Destructor Documentation

vtkTextSource::vtkTextSource  )  [protected]
 

vtkTextSource::~vtkTextSource  )  [protected]
 


Member Function Documentation

virtual const char* vtkTextSource::GetClassName  )  [virtual]
 

Reimplemented from vtkPolyDataAlgorithm.

static int vtkTextSource::IsTypeOf const char *  type  )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkTextSource::IsA const char *  type  )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

static vtkTextSource* vtkTextSource::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkPolyDataAlgorithm.

void vtkTextSource::PrintSelf ostream &  os,
vtkIndent  indent
[virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

static vtkTextSource* vtkTextSource::New  )  [static]
 

Construct object with no string set and backing enabled.

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkTextSource::SetText const char *   )  [virtual]
 

Set/Get the text to be drawn.

virtual char* vtkTextSource::GetText  )  [virtual]
 

Set/Get the text to be drawn.

virtual void vtkTextSource::SetBacking int   )  [virtual]
 

Controls whether or not a background is drawn with the text.

virtual int vtkTextSource::GetBacking  )  [virtual]
 

Controls whether or not a background is drawn with the text.

virtual void vtkTextSource::BackingOn  )  [virtual]
 

Controls whether or not a background is drawn with the text.

virtual void vtkTextSource::BackingOff  )  [virtual]
 

Controls whether or not a background is drawn with the text.

virtual void vtkTextSource::SetForegroundColor double  ,
double  ,
double 
[virtual]
 

Set/Get the foreground color. Default is white (1,1,1). ALpha is always 1.

virtual void vtkTextSource::SetForegroundColor double  [3]  )  [virtual]
 

Set/Get the foreground color. Default is white (1,1,1). ALpha is always 1.

virtual double* vtkTextSource::GetForegroundColor  )  [virtual]
 

Set/Get the foreground color. Default is white (1,1,1). ALpha is always 1.

virtual void vtkTextSource::GetForegroundColor double  data[3]  )  [virtual]
 

Set/Get the foreground color. Default is white (1,1,1). ALpha is always 1.

virtual void vtkTextSource::SetBackgroundColor double  ,
double  ,
double 
[virtual]
 

Set/Get the background color. Default is black (0,0,0). Alpha is always 1.

virtual void vtkTextSource::SetBackgroundColor double  [3]  )  [virtual]
 

Set/Get the background color. Default is black (0,0,0). Alpha is always 1.

virtual double* vtkTextSource::GetBackgroundColor  )  [virtual]
 

Set/Get the background color. Default is black (0,0,0). Alpha is always 1.

virtual void vtkTextSource::GetBackgroundColor double  data[3]  )  [virtual]
 

Set/Get the background color. Default is black (0,0,0). Alpha is always 1.

int vtkTextSource::RequestData vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector
[protected, virtual]
 

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

char* vtkTextSource::Text [protected]
 

Definition at line 84 of file vtkTextSource.h.

int vtkTextSource::Backing [protected]
 

Definition at line 85 of file vtkTextSource.h.

double vtkTextSource::ForegroundColor[4] [protected]
 

Definition at line 86 of file vtkTextSource.h.

double vtkTextSource::BackgroundColor[4] [protected]
 

Definition at line 87 of file vtkTextSource.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:22:01 2008 for VTK by  doxygen 1.4.3-20050530