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:
[legend]Collaboration diagram for vtkLabeledDataMapper:
[legend]List of all members.
Detailed Description
draw text labels at dataset points.
-
Date:
-
2001/11/13 14:17:22
-
Revision:
-
1.25
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.)
-
Warning:
-
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
-
Examples:
-
vtkLabeledDataMapper (Examples)
-
Tests:
-
vtkLabeledDataMapper (Tests)
Definition at line 95 of file vtkLabeledDataMapper.h.
Constructor & Destructor Documentation
| vtkLabeledDataMapper::vtkLabeledDataMapper |
( |
|
) |
[protected] |
|
| vtkLabeledDataMapper::~vtkLabeledDataMapper |
( |
|
) |
[protected] |
|
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 |
|
) |
[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 vtkMapper2D. |
|
|
Draw the text to the screen at each input point.
Reimplemented from vtkMapper2D. |
|
|
Draw the text to the screen at each input point.
Reimplemented from vtkMapper2D. |
| virtual void vtkLabeledDataMapper::SetInput |
( |
vtkDataSet * |
|
) |
[virtual] |
|
|
|
Set the input dataset to the mapper. |
| virtual vtkDataSet* vtkLabeledDataMapper::GetInput |
( |
|
) |
[virtual] |
|
|
|
Set the input dataset to the mapper. |
| 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] |
|
|
|
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. |
| void vtkLabeledDataMapper::SetLabelModeToLabelIds |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 130 of file vtkLabeledDataMapper.h. |
| void vtkLabeledDataMapper::SetLabelModeToLabelScalars |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 131 of file vtkLabeledDataMapper.h. |
| void vtkLabeledDataMapper::SetLabelModeToLabelVectors |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 132 of file vtkLabeledDataMapper.h. |
| void vtkLabeledDataMapper::SetLabelModeToLabelNormals |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 133 of file vtkLabeledDataMapper.h. |
| void vtkLabeledDataMapper::SetLabelModeToLabelTCoords |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 134 of file vtkLabeledDataMapper.h. |
| void vtkLabeledDataMapper::SetLabelModeToLabelTensors |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 135 of file vtkLabeledDataMapper.h. |
| void vtkLabeledDataMapper::SetLabelModeToLabelFieldData |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 136 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] |
|
|
|
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 void vtkLabeledDataMapper::SetBold |
( |
int |
|
) |
[virtual] |
|
|
|
Enable/Disable bolding labels. |
| virtual int vtkLabeledDataMapper::GetBold |
( |
|
) |
[virtual] |
|
|
|
Enable/Disable bolding labels. |
| virtual void vtkLabeledDataMapper::BoldOn |
( |
|
) |
[virtual] |
|
|
|
Enable/Disable bolding labels. |
| virtual void vtkLabeledDataMapper::BoldOff |
( |
|
) |
[virtual] |
|
|
|
Enable/Disable bolding labels. |
| virtual void vtkLabeledDataMapper::SetItalic |
( |
int |
|
) |
[virtual] |
|
|
|
Enable/Disable italicizing labels. |
| virtual int vtkLabeledDataMapper::GetItalic |
( |
|
) |
[virtual] |
|
|
|
Enable/Disable italicizing labels. |
| virtual void vtkLabeledDataMapper::ItalicOn |
( |
|
) |
[virtual] |
|
|
|
Enable/Disable italicizing labels. |
| virtual void vtkLabeledDataMapper::ItalicOff |
( |
|
) |
[virtual] |
|
|
|
Enable/Disable italicizing labels. |
| 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] |
|
|
|
Enable/Disable creating shadows on the labels. Shadows make the text easier to read. |
| virtual void vtkLabeledDataMapper::ShadowOn |
( |
|
) |
[virtual] |
|
|
|
Enable/Disable creating shadows on the labels. Shadows make the text easier to read. |
| virtual void vtkLabeledDataMapper::ShadowOff |
( |
|
) |
[virtual] |
|
|
|
Enable/Disable creating shadows on the labels. Shadows make the text easier to read. |
| 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] |
|
|
|
Set/Get the font family for the labels. Three font types are available: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES). |
| void vtkLabeledDataMapper::SetFontFamilyToArial |
( |
|
) |
[inline] |
|
|
|
Set/Get the font family for the labels. Three font types are available: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).
Definition at line 176 of file vtkLabeledDataMapper.h. |
| void vtkLabeledDataMapper::SetFontFamilyToCourier |
( |
|
) |
[inline] |
|
|
|
Set/Get the font family for the labels. Three font types are available: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).
Definition at line 177 of file vtkLabeledDataMapper.h. |
| void vtkLabeledDataMapper::SetFontFamilyToTimes |
( |
|
) |
[inline] |
|
|
|
Set/Get the font family for the labels. Three font types are available: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).
Definition at line 178 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] |
|
|
|
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 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] |
|
|
|
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 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] |
|
|
|
Set/Get the field data array to label. This instance variable is only applicable if field data is labeled. |
Member Data Documentation
vtkDataSet* vtkLabeledDataMapper::Input [protected]
|
|
int vtkLabeledDataMapper::LabelMode [protected]
|
|
int vtkLabeledDataMapper::FontSize [protected]
|
|
int vtkLabeledDataMapper::Bold [protected]
|
|
int vtkLabeledDataMapper::Italic [protected]
|
|
int vtkLabeledDataMapper::Shadow [protected]
|
|
int vtkLabeledDataMapper::FontFamily [protected]
|
|
char* vtkLabeledDataMapper::LabelFormat [protected]
|
|
int vtkLabeledDataMapper::LabeledComponent [protected]
|
|
int vtkLabeledDataMapper::FieldDataArray [protected]
|
|
The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:34:31 2002 for VTK by
1.2.11.1 written by Dimitri van Heesch,
© 1997-2001