vtkLabeledTreeMapDataMapper Class Reference

#include <vtkLabeledTreeMapDataMapper.h>

Inheritance diagram for vtkLabeledTreeMapDataMapper:

Inheritance graph
[legend]
Collaboration diagram for vtkLabeledTreeMapDataMapper:

Collaboration graph
[legend]

List of all members.


Detailed Description

draw text labels on a tree map

vtkLabeledTreeMapDataMapper is a mapper that renders text on a tree map. A tree map is a vtkTree with an associated 4-tuple array used for storing the boundary rectangle for each vertex in the tree. The user must specify the array name used for storing the rectangles.

The mapper iterates through the tree and attempts and renders a label inside the vertex's rectangle as long as the following conditions hold: 1. The vertex level is within the range of levels specified for labeling. 2. The label can fully fit inside its box. 3. The label does not overlap an ancestor's label.

See also:
vtkLabeledDataMapper
Thanks:
Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National Laboratories for their help in developing this class.

Definition at line 54 of file vtkLabeledTreeMapDataMapper.h.


Public Types

typedef vtkLabeledDataMapper Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkTreeGetInputTree ()
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual void RenderOpaqueGeometry (vtkViewport *viewport, vtkActor2D *actor)
virtual void RenderOverlay (vtkViewport *viewport, vtkActor2D *actor)
virtual char * GetRectanglesFieldName ()
virtual void SetRectanglesFieldName (const char *)
virtual int GetClipTextMode ()
virtual void SetClipTextMode (int)
virtual int GetChildMotion ()
virtual void SetChildMotion (int)
virtual int GetDynamicLevel ()
virtual void SetDynamicLevel (int)
void SetFontSizeRange (int maxSize, int minSize, int delta=4)
void GetFontSizeRange (int range[3])
void SetLevelRange (int startLevel, int endLevel)
void GetLevelRange (int range[2])

Static Public Member Functions

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

Protected Member Functions

 vtkLabeledTreeMapDataMapper ()
 ~vtkLabeledTreeMapDataMapper ()
void LabelTree (vtkTree *tree, vtkFloatArray *boxInfo, vtkDataArray *numericData, vtkStringArray *stringData, int activeComp, int numComps)
void GetVertexLabel (vtkIdType vertex, vtkDataArray *numericData, vtkStringArray *stringData, int activeComp, int numComps, char *string)
void UpdateFontSizes ()
int UpdateWindowInfo (vtkViewport *viewport)
int GetStringSize (char *string, int level)
int ConvertToDC (float *origBoxInfo, float *newBoxInfo)
int AnalyseLabel (char *string, int level, float *blimitsDC, float *textPosWC, vtkTextProperty **tprop)
int ApplyMasks (int level, float flimits[4], float blimits[4])

Protected Attributes

char * RectanglesFieldName
vtkViewportCurrentViewPort
int * FontHeights
int ** FontWidths
int MaxFontLevel
int * ChildrenCount
int MaxTreeLevels
double BoxTrans [2][2]
double WindowLimits [2][2]
float(* LabelMasks )[4]
vtkIdListVertexList
vtkPointsTextPoints
vtkCoordinateVCoord
int ClipTextMode
int ChildMotion
int StartLevel
int EndLevel
int DynamicLevel
vtkTextPropertyVerticalLabelProperty
vtkTextProperty ** HLabelProperties

Member Typedef Documentation

Reimplemented from vtkLabeledDataMapper.

Definition at line 61 of file vtkLabeledTreeMapDataMapper.h.


Constructor & Destructor Documentation

vtkLabeledTreeMapDataMapper::vtkLabeledTreeMapDataMapper (  )  [protected]

vtkLabeledTreeMapDataMapper::~vtkLabeledTreeMapDataMapper (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkLabeledDataMapper.

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

Reimplemented from vtkLabeledDataMapper.

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

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

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

Reimplemented from vtkLabeledDataMapper.

void vtkLabeledTreeMapDataMapper::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 vtkLabeledDataMapper.

virtual void vtkLabeledTreeMapDataMapper::RenderOpaqueGeometry ( vtkViewport viewport,
vtkActor2D actor 
) [virtual]

Draw the text to the screen at each input point.

Reimplemented from vtkLabeledDataMapper.

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

Draw the text to the screen at each input point.

Reimplemented from vtkLabeledDataMapper.

virtual vtkTree* vtkLabeledTreeMapDataMapper::GetInputTree (  )  [virtual]

The input to this filter.

virtual char* vtkLabeledTreeMapDataMapper::GetRectanglesFieldName (  )  [virtual]

The name of the 4-tuple array used for

virtual void vtkLabeledTreeMapDataMapper::SetRectanglesFieldName ( const char *   )  [virtual]

The name of the 4-tuple array used for

virtual int vtkLabeledTreeMapDataMapper::GetClipTextMode (  )  [virtual]

Indicates if the label can be displayed clipped by the Window mode = 0 - ok to clip labels 1 - auto center labels w/r to the area of the vertex's clipped region

virtual void vtkLabeledTreeMapDataMapper::SetClipTextMode ( int   )  [virtual]

Indicates if the label can be displayed clipped by the Window mode = 0 - ok to clip labels 1 - auto center labels w/r to the area of the vertex's clipped region

virtual int vtkLabeledTreeMapDataMapper::GetChildMotion (  )  [virtual]

Indicates if the label can be moved by its ancestors

virtual void vtkLabeledTreeMapDataMapper::SetChildMotion ( int   )  [virtual]

Indicates if the label can be moved by its ancestors

virtual int vtkLabeledTreeMapDataMapper::GetDynamicLevel (  )  [virtual]

Indicates at which level labeling should be dynamic

virtual void vtkLabeledTreeMapDataMapper::SetDynamicLevel ( int   )  [virtual]

Indicates at which level labeling should be dynamic

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

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

Reimplemented from vtkLabeledDataMapper.

void vtkLabeledTreeMapDataMapper::SetFontSizeRange ( int  maxSize,
int  minSize,
int  delta = 4 
)

The range of font sizes to use when rendering the labels.

void vtkLabeledTreeMapDataMapper::GetFontSizeRange ( int  range[3]  ) 

The range of font sizes to use when rendering the labels.

void vtkLabeledTreeMapDataMapper::SetLevelRange ( int  startLevel,
int  endLevel 
)

The range of levels to attempt to label. The level of a vertex is the length of the path to the root (the root has level 0).

void vtkLabeledTreeMapDataMapper::GetLevelRange ( int  range[2]  ) 

The range of levels to attempt to label. The level of a vertex is the length of the path to the root (the root has level 0).

void vtkLabeledTreeMapDataMapper::LabelTree ( vtkTree tree,
vtkFloatArray boxInfo,
vtkDataArray numericData,
vtkStringArray stringData,
int  activeComp,
int  numComps 
) [protected]

void vtkLabeledTreeMapDataMapper::GetVertexLabel ( vtkIdType  vertex,
vtkDataArray numericData,
vtkStringArray stringData,
int  activeComp,
int  numComps,
char *  string 
) [protected]

void vtkLabeledTreeMapDataMapper::UpdateFontSizes (  )  [protected]

int vtkLabeledTreeMapDataMapper::UpdateWindowInfo ( vtkViewport viewport  )  [protected]

int vtkLabeledTreeMapDataMapper::GetStringSize ( char *  string,
int  level 
) [protected]

int vtkLabeledTreeMapDataMapper::ConvertToDC ( float *  origBoxInfo,
float *  newBoxInfo 
) [protected]

int vtkLabeledTreeMapDataMapper::AnalyseLabel ( char *  string,
int  level,
float *  blimitsDC,
float *  textPosWC,
vtkTextProperty **  tprop 
) [protected]

int vtkLabeledTreeMapDataMapper::ApplyMasks ( int  level,
float  flimits[4],
float  blimits[4] 
) [protected]


Member Data Documentation

Definition at line 135 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 136 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 137 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 138 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 139 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 140 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 141 of file vtkLabeledTreeMapDataMapper.h.

double vtkLabeledTreeMapDataMapper::BoxTrans[2][2] [protected]

Definition at line 142 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 143 of file vtkLabeledTreeMapDataMapper.h.

float(* vtkLabeledTreeMapDataMapper::LabelMasks)[4] [protected]

Definition at line 145 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 147 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 148 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 149 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 150 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 151 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 152 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 153 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 154 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 155 of file vtkLabeledTreeMapDataMapper.h.

Definition at line 156 of file vtkLabeledTreeMapDataMapper.h.


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

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