Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkTextSource Class Reference

create polygonal text. More...

#include <vtkTextSource.h>

Inheritance diagram for vtkTextSource:

Inheritance graph
[legend]
Collaboration diagram for vtkTextSource:

Collaboration graph
[legend]
List of all members.

Public Methods

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

Static Public Methods

int IsTypeOf (const char *type)
vtkTextSource * SafeDownCast (vtkObject *o)
vtkTextSource * New ()

Protected Methods

 vtkTextSource ()
 ~vtkTextSource ()
void Execute ()

Protected Attributes

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

Detailed Description

create polygonal text.

Date:
2001/10/11 13:37:19
Revision:
1.37

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 71 of file vtkTextSource.h.


Constructor & Destructor Documentation

vtkTextSource::vtkTextSource   [protected]
 

vtkTextSource::~vtkTextSource   [protected]
 


Member Function Documentation

virtual const char* vtkTextSource::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSource.

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSource.

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSource.

vtkTextSource* vtkTextSource::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSource.

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 vtkSource.

vtkTextSource* vtkTextSource::New   [static]
 

Construct object with no string set and backing enabled.

Reimplemented from vtkPolyDataSource.

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 float   ,
float   ,
float   
[virtual]
 

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

virtual void vtkTextSource::SetForegroundColor float   [3] [virtual]
 

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

virtual float* vtkTextSource::GetForegroundColor   [virtual]
 

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

virtual void vtkTextSource::GetForegroundColor float    data[3] [virtual]
 

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

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

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

virtual void vtkTextSource::SetBackgroundColor float   [3] [virtual]
 

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

virtual float* vtkTextSource::GetBackgroundColor   [virtual]
 

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

virtual void vtkTextSource::GetBackgroundColor float    data[3] [virtual]
 

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

void vtkTextSource::Execute   [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.


Member Data Documentation

char* vtkTextSource::Text [protected]
 

Definition at line 112 of file vtkTextSource.h.

int vtkTextSource::Backing [protected]
 

Definition at line 113 of file vtkTextSource.h.

float vtkTextSource::ForegroundColor[4] [protected]
 

Definition at line 114 of file vtkTextSource.h.

float vtkTextSource::BackgroundColor[4] [protected]
 

Definition at line 115 of file vtkTextSource.h.


The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:43:42 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001