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

vtkLabeledDataMapper Class Reference

draw text labels at dataset points. More...

#include <vtkLabeledDataMapper.h>

Inheritance diagram for vtkLabeledDataMapper:

Inheritance graph
Collaboration diagram for vtkLabeledDataMapper:

Collaboration graph
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void RenderOpaqueGeometry (vtkViewport *viewport, vtkActor2D *actor)
void RenderOverlay (vtkViewport *viewport, vtkActor2D *actor)
virtual void SetInput (vtkDataSet *)
virtual vtkDataSetGetInput ()
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual void SetLabelMode (int)
virtual int GetLabelMode ()
void SetLabelModeToLabelIds ()
void SetLabelModeToLabelScalars ()
void SetLabelModeToLabelVectors ()
void SetLabelModeToLabelNormals ()
void SetLabelModeToLabelTCoords ()
void SetLabelModeToLabelTensors ()
void SetLabelModeToLabelFieldData ()
virtual void SetFontSize (int)
virtual int GetFontSize ()
virtual void SetBold (int)
virtual int GetBold ()
virtual void BoldOn ()
virtual void BoldOff ()
virtual void SetItalic (int)
virtual int GetItalic ()
virtual void ItalicOn ()
virtual void ItalicOff ()
virtual void SetShadow (int)
virtual int GetShadow ()
virtual void ShadowOn ()
virtual void ShadowOff ()
virtual void SetFontFamily (int)
virtual int GetFontFamily ()
void SetFontFamilyToArial ()
void SetFontFamilyToCourier ()
void SetFontFamilyToTimes ()
virtual void SetLabelFormat (const char *)
virtual char * GetLabelFormat ()
virtual void SetLabeledComponent (int)
virtual int GetLabeledComponent ()
virtual void SetFieldDataArray (int)
virtual int GetFieldDataArray ()

Static Public Methods

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

Protected Methods

 vtkLabeledDataMapper ()
 ~vtkLabeledDataMapper ()
 vtkLabeledDataMapper (const vtkLabeledDataMapper &)
void operator= (const vtkLabeledDataMapper &)

Protected Attributes

int LabelMode
int FontSize
int Bold
int Italic
int Shadow
int FontFamily
char * LabelFormat
int LabeledComponent
int FieldDataArray
vtkTimeStamp BuildTime

Detailed Description

draw text labels at dataset points.

2000/12/10 20:09:12

vtkLabeledDataMapper is a mapper that renders text at dataset points. Various items can be labeled including point ids, scalars, vectors, normals, texture coordinates, tensors, and field data components.

The format with which the label is drawn is specified using a printf style format string. The font attributes of the text can also be set (font style, size, bold, italic, shadow). The color of the text is controlled by the actor2D's color property (i.e., the actor associated with this mapper).

By default, all the components of multi-component data such as vectors, normals, texture coordinates, tensors, and multi-component scalars are labeled. However, you can specify a single component if you prefer. (Note: the label format specifies the format to use for a single component. The label is creating by looping over all components and using the label format to render each component.)

Use this filter in combination with vtkSelectVisiblePoints if you want to label only points that are visible. If you want to label cells rather than points, use the filter vtkCellCenters to generate points at the center of the cells. Also, you can use the class vtkIdFilter to generate ids as scalars or field data, which can then be labeled.
See also:
vtkMapper2D vtkActor2D vtkTextMapper vtkSelectVisiblePoints vtkIdFilter vtkCellCenters
vtkLabeledDataMapper (examples)

Definition at line 91 of file vtkLabeledDataMapper.h.

Constructor & Destructor Documentation

vtkLabeledDataMapper::vtkLabeledDataMapper   [protected]

vtkLabeledDataMapper::~vtkLabeledDataMapper   [protected]

vtkLabeledDataMapper::vtkLabeledDataMapper const vtkLabeledDataMapper &    [inline, protected]

Definition at line 186 of file vtkLabeledDataMapper.h.

Member Function Documentation

vtkLabeledDataMapper* vtkLabeledDataMapper::New   [static]

Instantiate object with font size 12 of font Arial (bolding, italic, shadows on) and %-#6.3g label format. By default, point ids are labeled.

Reimplemented from vtkMapper2D.

virtual const char* vtkLabeledDataMapper::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 vtkMapper2D.

int vtkLabeledDataMapper::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 vtkMapper2D.

virtual int vtkLabeledDataMapper::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 vtkMapper2D.

vtkLabeledDataMapper* vtkLabeledDataMapper::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 vtkMapper2D.

void vtkLabeledDataMapper::PrintSelf ostream &    os,
vtkIndent    indent

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

void vtkLabeledDataMapper::RenderOpaqueGeometry vtkViewport   viewport,
vtkActor2D   actor

Draw the text to the screen at each input point.

Reimplemented from vtkMapper2D.

void vtkLabeledDataMapper::RenderOverlay vtkViewport   viewport,
vtkActor2D   actor

Reimplemented from vtkMapper2D.

virtual void vtkLabeledDataMapper::SetInput vtkDataSet   [virtual]

Set the input dataset to the mapper.

virtual vtkDataSet* vtkLabeledDataMapper::GetInput   [virtual]

virtual void vtkLabeledDataMapper::ReleaseGraphicsResources vtkWindow   [virtual]

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkAbstractMapper.

virtual void vtkLabeledDataMapper::SetLabelMode int    [virtual]

Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetLabeledComponent to control which components to plot.

virtual int vtkLabeledDataMapper::GetLabelMode   [virtual]

void vtkLabeledDataMapper::SetLabelModeToLabelIds   [inline]

Definition at line 121 of file vtkLabeledDataMapper.h.

void vtkLabeledDataMapper::SetLabelModeToLabelScalars   [inline]

Definition at line 122 of file vtkLabeledDataMapper.h.

void vtkLabeledDataMapper::SetLabelModeToLabelVectors   [inline]

Definition at line 123 of file vtkLabeledDataMapper.h.

void vtkLabeledDataMapper::SetLabelModeToLabelNormals   [inline]

Definition at line 124 of file vtkLabeledDataMapper.h.

void vtkLabeledDataMapper::SetLabelModeToLabelTCoords   [inline]

Definition at line 125 of file vtkLabeledDataMapper.h.

void vtkLabeledDataMapper::SetLabelModeToLabelTensors   [inline]

Definition at line 126 of file vtkLabeledDataMapper.h.

void vtkLabeledDataMapper::SetLabelModeToLabelFieldData   [inline]

Definition at line 127 of file vtkLabeledDataMapper.h.

virtual void vtkLabeledDataMapper::SetFontSize int    [virtual]

Set/Get the suggested font size used to label the data. (Suggested because not all font sizes may be available.) The value is expressed in points.

virtual int vtkLabeledDataMapper::GetFontSize   [virtual]

virtual void vtkLabeledDataMapper::SetBold int    [virtual]

Enable/Disable bolding labels.

virtual int vtkLabeledDataMapper::GetBold   [virtual]

virtual void vtkLabeledDataMapper::BoldOn   [virtual]

virtual void vtkLabeledDataMapper::BoldOff   [virtual]

virtual void vtkLabeledDataMapper::SetItalic int    [virtual]

Enable/Disable italicizing labels.

virtual int vtkLabeledDataMapper::GetItalic   [virtual]

virtual void vtkLabeledDataMapper::ItalicOn   [virtual]

virtual void vtkLabeledDataMapper::ItalicOff   [virtual]

virtual void vtkLabeledDataMapper::SetShadow int    [virtual]

Enable/Disable creating shadows on the labels. Shadows make the text easier to read.

virtual int vtkLabeledDataMapper::GetShadow   [virtual]

virtual void vtkLabeledDataMapper::ShadowOn   [virtual]

virtual void vtkLabeledDataMapper::ShadowOff   [virtual]

virtual void vtkLabeledDataMapper::SetFontFamily int    [virtual]

Set/Get the font family for the labels. Three font types are available: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).

virtual int vtkLabeledDataMapper::GetFontFamily   [virtual]

void vtkLabeledDataMapper::SetFontFamilyToArial   [inline]

Definition at line 157 of file vtkLabeledDataMapper.h.

void vtkLabeledDataMapper::SetFontFamilyToCourier   [inline]

Definition at line 158 of file vtkLabeledDataMapper.h.

void vtkLabeledDataMapper::SetFontFamilyToTimes   [inline]

Definition at line 159 of file vtkLabeledDataMapper.h.

virtual void vtkLabeledDataMapper::SetLabelFormat const char *    [virtual]

Set/Get the format with which to print the labels. The format needs to change depending on what you're trying to print. For example, if you're printing a vector, 3 values are printed, whereas when printing an id only one value is printed. See also the ivar LabeledComponent which can be used to specify the component to print if you want to only print one of several.

virtual char* vtkLabeledDataMapper::GetLabelFormat   [virtual]

virtual void vtkLabeledDataMapper::SetLabeledComponent int    [virtual]

Set/Get the component number to label if the data to print has more than one component. For example, all the components of scalars, vectors, normals, etc. are labeled by default (LabeledComponent=(-1)). However, if this ivar is nonnegative, then only the one component specified is labeled.

virtual int vtkLabeledDataMapper::GetLabeledComponent   [virtual]

virtual void vtkLabeledDataMapper::SetFieldDataArray int    [virtual]

Set/Get the field data array to label. This instance variable is only applicable if field data is labeled.

virtual int vtkLabeledDataMapper::GetFieldDataArray   [virtual]

void vtkLabeledDataMapper::operator= const vtkLabeledDataMapper &    [inline, protected]

Definition at line 187 of file vtkLabeledDataMapper.h.

Member Data Documentation

vtkDataSet* vtkLabeledDataMapper::Input [protected]

Definition at line 189 of file vtkLabeledDataMapper.h.

int vtkLabeledDataMapper::LabelMode [protected]

Definition at line 190 of file vtkLabeledDataMapper.h.

int vtkLabeledDataMapper::FontSize [protected]

Definition at line 192 of file vtkLabeledDataMapper.h.

int vtkLabeledDataMapper::Bold [protected]

Definition at line 193 of file vtkLabeledDataMapper.h.

int vtkLabeledDataMapper::Italic [protected]

Definition at line 194 of file vtkLabeledDataMapper.h.

int vtkLabeledDataMapper::Shadow [protected]

Definition at line 195 of file vtkLabeledDataMapper.h.

int vtkLabeledDataMapper::FontFamily [protected]

Definition at line 196 of file vtkLabeledDataMapper.h.

char* vtkLabeledDataMapper::LabelFormat [protected]

Definition at line 198 of file vtkLabeledDataMapper.h.

int vtkLabeledDataMapper::LabeledComponent [protected]

Definition at line 199 of file vtkLabeledDataMapper.h.

int vtkLabeledDataMapper::FieldDataArray [protected]

Definition at line 200 of file vtkLabeledDataMapper.h.

vtkTimeStamp vtkLabeledDataMapper::BuildTime [protected]

Definition at line 202 of file vtkLabeledDataMapper.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:52:37 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001