vtkLabelSizeCalculator Class Reference

#include <vtkLabelSizeCalculator.h>

Inheritance diagram for vtkLabelSizeCalculator:

Collaboration diagram for vtkLabelSizeCalculator:

Public Types
typedef vtkPassInputTypeAlgorithm	Superclass
Public Types inherited from vtkPassInputTypeAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsA (const char *type)
vtkLabelSizeCalculator *	NewInstance () const
virtual void	SetFontProperty (vtkTextProperty *fontProp, int type=0)
virtual vtkTextProperty *	GetFontProperty (int type=0)
virtual void	SetLabelSizeArrayName (const char *)
virtual char *	GetLabelSizeArrayName ()
Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithm *	NewInstance () const
vtkPolyData *	GetPolyDataOutput ()
vtkStructuredPoints *	GetStructuredPointsOutput ()
vtkImageData *	GetImageDataOutput ()
vtkStructuredGrid *	GetStructuredGridOutput ()
vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
vtkRectilinearGrid *	GetRectilinearGridOutput ()
vtkTable *	GetTableOutput ()
vtkGraph *	GetGraphOutput ()
vtkDataObject *	GetInput ()
vtkDataObject *	GetOutput ()
vtkDataObject *	GetOutput (int)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
void	AddInputData (vtkDataObject *)
void	AddInputData (int, vtkDataObject *)
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkLabelSizeCalculator *	New ()
static int	IsTypeOf (const char *type)
static vtkLabelSizeCalculator *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkPassInputTypeAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkLabelSizeCalculator ()
virtual	~vtkLabelSizeCalculator ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
virtual vtkIntArray *	LabelSizesForArray (vtkAbstractArray *labels, vtkIntArray *types)
virtual void	SetFontUtil (vtkFreeTypeUtilities *fontProp)
virtual vtkFreeTypeUtilities *	GetFontUtil ()
Protected Member Functions inherited from vtkPassInputTypeAlgorithm
	vtkPassInputTypeAlgorithm ()
	~vtkPassInputTypeAlgorithm ()
virtual int	RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
vtkDataObject *	GetInput (int port)
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
virtual void	SetErrorCode (unsigned long)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkFreeTypeUtilities *	FontUtil
char *	LabelSizeArrayName
Internals *	Implementation
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

This filter takes an input dataset, an array to process (which must be a string array), and a text property. It creates a new output array (named "LabelSize" by default) with 4 components per tuple that contain the width, height, horizontal offset, and descender height (in that order) of each string in the array.

Use the inherited SelectInputArrayToProcess to indicate a string array. In no input array is specified, the first of the following that is a string array is used: point scalars, cell scalars, field scalars.

The second input array to process is an array specifying the type of each label. Different label types may have different font properties. This array must be a vtkIntArray. Any type that does not map to a font property that was set will be set to the type 0's type property.

Tests:

vtkLabelSizeCalculator (Tests)

Definition at line 50 of file vtkLabelSizeCalculator.h.

Member Typedef Documentation

typedef vtkPassInputTypeAlgorithm vtkLabelSizeCalculator::Superclass

Definition at line 55 of file vtkLabelSizeCalculator.h.

Constructor & Destructor Documentation

vtkLabelSizeCalculator::vtkLabelSizeCalculator ( )

protected

virtual vtkLabelSizeCalculator::~vtkLabelSizeCalculator ( )

protectedvirtual

Member Function Documentation

static vtkLabelSizeCalculator* vtkLabelSizeCalculator::New ( )

static

virtual void vtkLabelSizeCalculator::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 vtkPassInputTypeAlgorithm.

static int vtkLabelSizeCalculator::IsTypeOf ( const char *  type )

static

virtual int vtkLabelSizeCalculator::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPassInputTypeAlgorithm.

static vtkLabelSizeCalculator* vtkLabelSizeCalculator::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkLabelSizeCalculator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPassInputTypeAlgorithm.

vtkLabelSizeCalculator* vtkLabelSizeCalculator::NewInstance

(

)

const

virtual void vtkLabelSizeCalculator::SetFontProperty ( vtkTextProperty *  fontProp, int  type = 0  )

virtual

Get/Set the font used compute label sizes. This defaults to "Arial" at 12 points. If type is provided, it refers to the type of the text label provided in the optional label type array. The default type is type 0.

virtual vtkTextProperty* vtkLabelSizeCalculator::GetFontProperty ( int  type = 0 )

virtual

Get/Set the font used compute label sizes. This defaults to "Arial" at 12 points. If type is provided, it refers to the type of the text label provided in the optional label type array. The default type is type 0.

virtual void vtkLabelSizeCalculator::SetLabelSizeArrayName ( const char *  )

virtual

The name of the output array containing text label sizes This defaults to "LabelSize"

virtual char* vtkLabelSizeCalculator::GetLabelSizeArrayName ( )

virtual

The name of the output array containing text label sizes This defaults to "LabelSize"

virtual int vtkLabelSizeCalculator::FillInputPortInformation ( int  port, vtkInformation *  info  )

protectedvirtual

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

virtual int vtkLabelSizeCalculator::RequestData ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

protectedvirtual

This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented from vtkPassInputTypeAlgorithm.

virtual vtkIntArray* vtkLabelSizeCalculator::LabelSizesForArray ( vtkAbstractArray *  labels, vtkIntArray *  types  )

protectedvirtual

virtual void vtkLabelSizeCalculator::SetFontUtil ( vtkFreeTypeUtilities *  fontProp )

protectedvirtual

virtual vtkFreeTypeUtilities* vtkLabelSizeCalculator::GetFontUtil ( )

protectedvirtual

Member Data Documentation

vtkFreeTypeUtilities* vtkLabelSizeCalculator::FontUtil

protected

Definition at line 86 of file vtkLabelSizeCalculator.h.

char* vtkLabelSizeCalculator::LabelSizeArrayName

protected

Definition at line 89 of file vtkLabelSizeCalculator.h.

Internals* vtkLabelSizeCalculator::Implementation

protected

Definition at line 92 of file vtkLabelSizeCalculator.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Label/vtkLabelSizeCalculator.h