#include <vtkLabeledDataMapper.h>
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 be set through the vtkTextProperty associated to 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.)
Definition at line 68 of file vtkLabeledDataMapper.h.
vtkLabeledDataMapper::vtkLabeledDataMapper | ( | ) | [protected] |
vtkLabeledDataMapper::~vtkLabeledDataMapper | ( | ) | [protected] |
static vtkLabeledDataMapper* vtkLabeledDataMapper::New | ( | ) | [static] |
Instantiate object with %-#6.3g label format. By default, point ids are labeled.
Reimplemented from vtkAlgorithm.
virtual const char* vtkLabeledDataMapper::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkMapper2D.
static int vtkLabeledDataMapper::IsTypeOf | ( | const char * | name | ) | [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 vtkMapper2D.
virtual int vtkLabeledDataMapper::IsA | ( | const char * | name | ) | [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 vtkMapper2D.
static vtkLabeledDataMapper* vtkLabeledDataMapper::SafeDownCast | ( | vtkObject * | o | ) | [static] |
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.
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.
virtual void vtkLabeledDataMapper::SetInput | ( | vtkDataSet * | ) | [virtual] |
Set the input dataset to the mapper. This mapper handles any type of data.
vtkDataSet* vtkLabeledDataMapper::GetInput | ( | ) |
Set the input dataset to the mapper. This mapper handles any type of data.
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 120 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 121 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 122 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 123 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 124 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 125 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 126 of file vtkLabeledDataMapper.h.
virtual void vtkLabeledDataMapper::SetLabelTextProperty | ( | vtkTextProperty * | p | ) | [virtual] |
Set/Get the text property.
virtual vtkTextProperty* vtkLabeledDataMapper::GetLabelTextProperty | ( | ) | [virtual] |
Set/Get the text property.
void vtkLabeledDataMapper::RenderOpaqueGeometry | ( | vtkViewport * | viewport, | |
vtkActor2D * | actor | |||
) | [virtual] |
Draw the text to the screen at each input point.
Reimplemented from vtkMapper2D.
void vtkLabeledDataMapper::RenderOverlay | ( | vtkViewport * | viewport, | |
vtkActor2D * | actor | |||
) | [virtual] |
Draw the text to the screen at each input point.
Reimplemented from vtkMapper2D.
virtual void vtkLabeledDataMapper::ReleaseGraphicsResources | ( | vtkWindow * | ) | [virtual] |
Release any graphics resources that are being consumed by this actor.
Reimplemented from vtkAbstractMapper.
vtkDataSet* vtkLabeledDataMapper::Input [protected] |
Definition at line 149 of file vtkLabeledDataMapper.h.
vtkTextProperty* vtkLabeledDataMapper::LabelTextProperty [protected] |
Definition at line 150 of file vtkLabeledDataMapper.h.
char* vtkLabeledDataMapper::LabelFormat [protected] |
Definition at line 152 of file vtkLabeledDataMapper.h.
int vtkLabeledDataMapper::LabelMode [protected] |
Definition at line 153 of file vtkLabeledDataMapper.h.
int vtkLabeledDataMapper::LabeledComponent [protected] |
Definition at line 154 of file vtkLabeledDataMapper.h.
int vtkLabeledDataMapper::FieldDataArray [protected] |
Definition at line 155 of file vtkLabeledDataMapper.h.
vtkTimeStamp vtkLabeledDataMapper::BuildTime [protected] |
Definition at line 157 of file vtkLabeledDataMapper.h.