VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTextSource Class Reference

create polygonal text More...

#include <vtkTextSource.h>

Inherits vtkPolyDataAlgorithm.

Public Types

typedef vtkPolyDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTextSourceNewInstance () const
 
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 (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 (vtkObjectBase *o)
 
static vtkTextSourceNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkTextSource ()
 
 ~vtkTextSource ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

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

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

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkTextSource::Superclass

Definition at line 47 of file vtkTextSource.h.

Constructor & Destructor Documentation

vtkTextSource::vtkTextSource ( )
protected
vtkTextSource::~vtkTextSource ( )
protected

Member Function Documentation

static int vtkTextSource::IsTypeOf ( const char *  type)
static
virtual int vtkTextSource::IsA ( const char *  type)
virtual
static vtkTextSource* vtkTextSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkTextSource::NewInstanceInternal ( ) const
protectedvirtual
vtkTextSource* vtkTextSource::NewInstance ( ) const
void vtkTextSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkTextSource* vtkTextSource::New ( )
static

Construct object with no string set and backing enabled.

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

Member Data Documentation

char* vtkTextSource::Text
protected

Definition at line 85 of file vtkTextSource.h.

int vtkTextSource::Backing
protected

Definition at line 86 of file vtkTextSource.h.

double vtkTextSource::ForegroundColor[4]
protected

Definition at line 87 of file vtkTextSource.h.

double vtkTextSource::BackgroundColor[4]
protected

Definition at line 88 of file vtkTextSource.h.


The documentation for this class was generated from the following file: