vtkLabeledDataMapper Class Reference

#include <vtkLabeledDataMapper.h>

Inheritance diagram for vtkLabeledDataMapper:

Inheritance graph
[legend]
Collaboration diagram for vtkLabeledDataMapper:

Collaboration graph
[legend]

List of all members.


Detailed Description

draw text labels at dataset points

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

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 vtkTextProperty vtkSelectVisiblePoints vtkIdFilter vtkCellCenters
Examples:
vtkLabeledDataMapper (Examples)
Tests:
vtkLabeledDataMapper (Tests)

Definition at line 70 of file vtkLabeledDataMapper.h.


Public Types

typedef vtkMapper2D Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetInput (vtkDataObject *)
vtkDataSetGetInput ()
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual void SetLabelFormat (const char *)
virtual char * GetLabelFormat ()
virtual void SetLabeledComponent (int)
virtual int GetLabeledComponent ()
void SetFieldDataArray (int arrayIndex)
virtual int GetFieldDataArray ()
void SetFieldDataName (const char *arrayName)
virtual char * GetFieldDataName ()
virtual void SetLabelMode (int)
virtual int GetLabelMode ()
void SetLabelModeToLabelIds ()
void SetLabelModeToLabelScalars ()
void SetLabelModeToLabelVectors ()
void SetLabelModeToLabelNormals ()
void SetLabelModeToLabelTCoords ()
void SetLabelModeToLabelTensors ()
void SetLabelModeToLabelFieldData ()
virtual void SetLabelTextProperty (vtkTextProperty *p)
virtual vtkTextPropertyGetLabelTextProperty ()
void RenderOpaqueGeometry (vtkViewport *viewport, vtkActor2D *actor)
void RenderOverlay (vtkViewport *viewport, vtkActor2D *actor)
virtual vtkTransformGetTransform ()
void SetTransform (vtkTransform *t)

Static Public Member Functions

static vtkLabeledDataMapperNew ()
static int IsTypeOf (const char *type)
static vtkLabeledDataMapperSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkLabeledDataMapper ()
 ~vtkLabeledDataMapper ()
virtual int FillInputPortInformation (int, vtkInformation *)
void AllocateLables (int numLables)
void BuildLabels ()
void BuildLabelsInternal (vtkDataSet *)

Protected Attributes

vtkDataSetInput
vtkTextPropertyLabelTextProperty
char * LabelFormat
int LabelMode
int LabeledComponent
int FieldDataArray
char * FieldDataName
vtkTimeStamp BuildTime
int NumberOfLabels
int NumberOfLabelsAllocated
vtkTextMapper ** TextMappers
double * LabelPositions
vtkTransformTransform

Member Typedef Documentation

Reimplemented from vtkMapper2D.

Reimplemented in vtkLabeledTreeMapDataMapper, and vtkDynamic2DLabelMapper.

Definition at line 77 of file vtkLabeledDataMapper.h.


Constructor & Destructor Documentation

vtkLabeledDataMapper::vtkLabeledDataMapper (  )  [protected]

vtkLabeledDataMapper::~vtkLabeledDataMapper (  )  [protected]


Member Function Documentation

static vtkLabeledDataMapper* vtkLabeledDataMapper::New (  )  [static]

Instantiate object with %-#6.3g label format. By default, point ids are labeled.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkLabeledTreeMapDataMapper, and vtkDynamic2DLabelMapper.

virtual const char* vtkLabeledDataMapper::GetClassName (  )  [virtual]

Reimplemented from vtkMapper2D.

Reimplemented in vtkLabeledTreeMapDataMapper, and vtkDynamic2DLabelMapper.

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.

Reimplemented in vtkLabeledTreeMapDataMapper, and vtkDynamic2DLabelMapper.

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.

Reimplemented in vtkLabeledTreeMapDataMapper, and vtkDynamic2DLabelMapper.

static vtkLabeledDataMapper* vtkLabeledDataMapper::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkMapper2D.

Reimplemented in vtkLabeledTreeMapDataMapper, and vtkDynamic2DLabelMapper.

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.

Reimplemented in vtkLabeledTreeMapDataMapper, and vtkDynamic2DLabelMapper.

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

Set/Get the format with which to print the labels. This should be a printf-style format string. By default, the mapper will try to print each component of the tuple using a sane format: d for integers, f for floats, g for doubles, ld for longs, et cetera. If you need a different format, set it here. You can do things like limit the number of significant digits, add prefixes/suffixes, basically anything that printf can do. If you only want to print one component of a vector, see the ivar LabeledComponent.

virtual char* vtkLabeledDataMapper::GetLabelFormat (  )  [virtual]

Set/Get the format with which to print the labels. This should be a printf-style format string. By default, the mapper will try to print each component of the tuple using a sane format: d for integers, f for floats, g for doubles, ld for longs, et cetera. If you need a different format, set it here. You can do things like limit the number of significant digits, add prefixes/suffixes, basically anything that printf can do. If you only want to print one component of a vector, see the ivar LabeledComponent.

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.

void vtkLabeledDataMapper::SetFieldDataArray ( int  arrayIndex  ) 

Set/Get the field data array to label. This instance variable is only applicable if field data is labeled. This will clear FieldDataName when set.

virtual int vtkLabeledDataMapper::GetFieldDataArray (  )  [virtual]

Set/Get the field data array to label. This instance variable is only applicable if field data is labeled. This will clear FieldDataName when set.

void vtkLabeledDataMapper::SetFieldDataName ( const char *  arrayName  ) 

Set/Get the name of the field data array to label. This instance variable is only applicable if field data is labeled. This will override FieldDataArray when set.

virtual char* vtkLabeledDataMapper::GetFieldDataName (  )  [virtual]

Set/Get the name of the field data array to label. This instance variable is only applicable if field data is labeled. This will override FieldDataArray when set.

virtual void vtkLabeledDataMapper::SetInput ( vtkDataObject  )  [virtual]

Set the input dataset to the mapper. This mapper handles any type of data.

vtkDataSet* vtkLabeledDataMapper::GetInput (  ) 

Use GetInputDataObject() to get the input data object for composite datasets.

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 134 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 135 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 136 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 137 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 138 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 139 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 140 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.

Reimplemented in vtkLabeledTreeMapDataMapper, and vtkDynamic2DLabelMapper.

void vtkLabeledDataMapper::RenderOverlay ( vtkViewport viewport,
vtkActor2D actor 
) [virtual]

Draw the text to the screen at each input point.

Reimplemented from vtkMapper2D.

Reimplemented in vtkLabeledTreeMapDataMapper, and vtkDynamic2DLabelMapper.

virtual void vtkLabeledDataMapper::ReleaseGraphicsResources ( vtkWindow  )  [virtual]

Release any graphics resources that are being consumed by this actor.

Reimplemented from vtkAbstractMapper.

Reimplemented in vtkLabeledTreeMapDataMapper.

virtual vtkTransform* vtkLabeledDataMapper::GetTransform (  )  [virtual]

The transform to apply to the labels before mapping to 2D.

void vtkLabeledDataMapper::SetTransform ( vtkTransform t  ) 

The transform to apply to the labels before mapping to 2D.

virtual int vtkLabeledDataMapper::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

void vtkLabeledDataMapper::AllocateLables ( int  numLables  )  [protected]

void vtkLabeledDataMapper::BuildLabels (  )  [protected]

void vtkLabeledDataMapper::BuildLabelsInternal ( vtkDataSet  )  [protected]


Member Data Documentation

Definition at line 169 of file vtkLabeledDataMapper.h.

Definition at line 170 of file vtkLabeledDataMapper.h.

Definition at line 172 of file vtkLabeledDataMapper.h.

Definition at line 173 of file vtkLabeledDataMapper.h.

Definition at line 174 of file vtkLabeledDataMapper.h.

Definition at line 175 of file vtkLabeledDataMapper.h.

Definition at line 176 of file vtkLabeledDataMapper.h.

Definition at line 178 of file vtkLabeledDataMapper.h.

Definition at line 180 of file vtkLabeledDataMapper.h.

Definition at line 181 of file vtkLabeledDataMapper.h.

Definition at line 182 of file vtkLabeledDataMapper.h.

Definition at line 183 of file vtkLabeledDataMapper.h.

Definition at line 184 of file vtkLabeledDataMapper.h.


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

Generated on Sat Dec 27 13:34:32 2008 for VTK by  doxygen 1.5.6