VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTextMapper Class Reference

2D text annotation More...

#include <vtkTextMapper.h>

Inheritance diagram for vtkTextMapper:
[legend]
Collaboration diagram for vtkTextMapper:
[legend]

Public Types

typedef vtkMapper2D Superclass
 
- Public Types inherited from vtkMapper2D
typedef vtkAbstractMapper Superclass
 
- Public Types inherited from vtkAbstractMapper
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void ShallowCopy (vtkTextMapper *tm)
 
int GetNumberOfLines (const char *input)
 
virtual void GetSize (vtkViewport *, int size[2])
 
virtual int GetWidth (vtkViewport *v)
 
virtual int GetHeight (vtkViewport *v)
 
virtual void SetInput (const char *inputString)
 
virtual char * GetInput ()
 
virtual void SetTextProperty (vtkTextProperty *p)
 
virtual vtkTextPropertyGetTextProperty ()
 
virtual int GetNumberOfLines ()
 
virtual int GetSystemFontSize (int size)
 
- Public Member Functions inherited from vtkMapper2D
virtual void RenderOverlay (vtkViewport *, vtkActor2D *)
 
virtual void RenderOpaqueGeometry (vtkViewport *, vtkActor2D *)
 
virtual void RenderTranslucentPolygonalGeometry (vtkViewport *, vtkActor2D *)
 
virtual int HasTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkAbstractMapper
virtual unsigned long GetMTime ()
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 
void SetClippingPlanes (vtkPlanes *planes)
 
void ShallowCopy (vtkAbstractMapper *m)
 
virtual double GetTimeToDraw ()
 
void AddClippingPlane (vtkPlane *plane)
 
void RemoveClippingPlane (vtkPlane *plane)
 
void RemoveAllClippingPlanes ()
 
virtual void SetClippingPlanes (vtkPlaneCollection *)
 
virtual vtkPlaneCollectionGetClippingPlanes ()
 
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
virtual void Update ()
 
virtual void UpdateInformation ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformationGetInformation ()
 
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)
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (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)
 
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 &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkTextMapperSafeDownCast (vtkObject *o)
 
static vtkTextMapperNew ()
 
static int SetMultipleConstrainedFontSize (vtkViewport *, int targetWidth, int targetHeight, vtkTextMapper **mappers, int nbOfMappers, int *maxResultingSize)
 
static int SetRelativeFontSize (vtkTextMapper *, vtkViewport *, int *winSize, int *stringSize, float sizeFactor=0.0)
 
static int SetMultipleRelativeFontSize (vtkViewport *viewport, vtkTextMapper **textMappers, int nbOfMappers, int *winSize, int *stringSize, float sizeFactor)
 
- Static Public Member Functions inherited from vtkMapper2D
static int IsTypeOf (const char *type)
 
static vtkMapper2DSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAbstractMapper
static int IsTypeOf (const char *type)
 
static vtkAbstractMapperSafeDownCast (vtkObject *o)
 
static vtkDataArrayGetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

 vtkTextMapper ()
 
 ~vtkTextMapper ()
 
char * NextLine (const char *input, int lineNum)
 
void GetMultiLineSize (vtkViewport *viewport, int size[2])
 
void RenderOverlayMultipleLines (vtkViewport *viewport, vtkActor2D *actor)
 
- Protected Member Functions inherited from vtkMapper2D
 vtkMapper2D ()
 
 ~vtkMapper2D ()
 
- Protected Member Functions inherited from vtkAbstractMapper
 vtkAbstractMapper ()
 
 ~vtkAbstractMapper ()
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
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 vtkExecutiveCreateDefaultExecutive ()
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * Input
 
vtkTextPropertyTextProperty
 
int LineSize
 
int NumberOfLines
 
int NumberOfLinesAllocated
 
vtkTextMapper ** TextLines
 
- Protected Attributes inherited from vtkAbstractMapper
vtkTimerLogTimer
 
double TimeToDraw
 
vtkWindowLastWindow
 
vtkPlaneCollectionClippingPlanes
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
virtual int SetConstrainedFontSize (vtkViewport *, int targetWidth, int targetHeight)
 
static int SetConstrainedFontSize (vtkTextMapper *, vtkViewport *, int targetWidth, int targetHeight)
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

2D text annotation

vtkTextMapper provides 2D text annotation support for VTK. It is a vtkMapper2D that can be associated with a vtkActor2D and placed into a vtkRenderer.

To use vtkTextMapper, specify an input text string.

See also
vtkMapper2D vtkActor2D vtkLegendBoxActor vtkCaptionActor2D vtkVectorText vtkTextProperty
Examples:
vtkTextMapper (Examples)
Tests:
vtkTextMapper (Tests)

Definition at line 43 of file vtkTextMapper.h.

Member Typedef Documentation

Definition at line 46 of file vtkTextMapper.h.

Constructor & Destructor Documentation

vtkTextMapper::vtkTextMapper ( )
protected
vtkTextMapper::~vtkTextMapper ( )
protected

Member Function Documentation

virtual const char* vtkTextMapper::GetClassName ( )
virtual

Reimplemented from vtkMapper2D.

Reimplemented in vtkMesaFreeTypeTextMapper, and vtkOpenGLFreeTypeTextMapper.

static int vtkTextMapper::IsTypeOf ( const char *  type)
static
virtual int vtkTextMapper::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 vtkMapper2D.

Reimplemented in vtkMesaFreeTypeTextMapper, and vtkOpenGLFreeTypeTextMapper.

static vtkTextMapper* vtkTextMapper::SafeDownCast ( vtkObject o)
static
void vtkTextMapper::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.

static vtkTextMapper* vtkTextMapper::New ( )
static

Creates a new text mapper.

virtual void vtkTextMapper::GetSize ( vtkViewport ,
int  size[2] 
)
inlinevirtual

Return the size[2]/width/height of the rectangle required to draw this mapper (in pixels).

Reimplemented in vtkMesaFreeTypeTextMapper, and vtkOpenGLFreeTypeTextMapper.

Definition at line 55 of file vtkTextMapper.h.

virtual int vtkTextMapper::GetWidth ( vtkViewport v)
virtual

Return the size[2]/width/height of the rectangle required to draw this mapper (in pixels).

virtual int vtkTextMapper::GetHeight ( vtkViewport v)
virtual

Return the size[2]/width/height of the rectangle required to draw this mapper (in pixels).

virtual void vtkTextMapper::SetInput ( const char *  inputString)
virtual

Set the input text string to the mapper. The mapper recognizes "\n" as a carriage return/linefeed (line separator).

virtual char* vtkTextMapper::GetInput ( )
virtual

Set the input text string to the mapper. The mapper recognizes "\n" as a carriage return/linefeed (line separator).

virtual void vtkTextMapper::SetTextProperty ( vtkTextProperty p)
virtual

Set/Get the text property.

virtual vtkTextProperty* vtkTextMapper::GetTextProperty ( )
virtual

Set/Get the text property.

void vtkTextMapper::ShallowCopy ( vtkTextMapper tm)

Shallow copy of an actor.

int vtkTextMapper::GetNumberOfLines ( const char *  input)

Determine the number of lines in the input string (delimited by "\n").

virtual int vtkTextMapper::GetNumberOfLines ( )
virtual

Get the number of lines in the input string (the method GetNumberOfLines(char*) must have been previously called for the return value to be valid).

virtual int vtkTextMapper::SetConstrainedFontSize ( vtkViewport ,
int  targetWidth,
int  targetHeight 
)
virtual

Set and return the font size required to make this mapper fit in a given target rectangle (width x height, in pixels). A static version of the method is also available for convenience to other classes (e.g., widgets).

static int vtkTextMapper::SetConstrainedFontSize ( vtkTextMapper ,
vtkViewport ,
int  targetWidth,
int  targetHeight 
)
static

Set and return the font size required to make this mapper fit in a given target rectangle (width x height, in pixels). A static version of the method is also available for convenience to other classes (e.g., widgets).

static int vtkTextMapper::SetMultipleConstrainedFontSize ( vtkViewport ,
int  targetWidth,
int  targetHeight,
vtkTextMapper **  mappers,
int  nbOfMappers,
int *  maxResultingSize 
)
static

Set and return the font size required to make each element of an array of mappers fit in a given rectangle (width x height, in pixels). This font size is the smallest size that was required to fit the largest mapper in this constraint.

static int vtkTextMapper::SetRelativeFontSize ( vtkTextMapper ,
vtkViewport ,
int *  winSize,
int *  stringSize,
float  sizeFactor = 0.0 
)
static

Use these methods when setting font size relative to the renderer's size. These methods are static so that external classes (e.g., widgets) can easily use them.

static int vtkTextMapper::SetMultipleRelativeFontSize ( vtkViewport viewport,
vtkTextMapper **  textMappers,
int  nbOfMappers,
int *  winSize,
int *  stringSize,
float  sizeFactor 
)
static

Use these methods when setting font size relative to the renderer's size. These methods are static so that external classes (e.g., widgets) can easily use them.

virtual int vtkTextMapper::GetSystemFontSize ( int  size)
inlinevirtual

Get the available system font size matching a font size.

Definition at line 122 of file vtkTextMapper.h.

char* vtkTextMapper::NextLine ( const char *  input,
int  lineNum 
)
protected
void vtkTextMapper::GetMultiLineSize ( vtkViewport viewport,
int  size[2] 
)
protected
void vtkTextMapper::RenderOverlayMultipleLines ( vtkViewport viewport,
vtkActor2D actor 
)
protected

Member Data Documentation

char* vtkTextMapper::Input
protected

Definition at line 130 of file vtkTextMapper.h.

vtkTextProperty* vtkTextMapper::TextProperty
protected

Definition at line 131 of file vtkTextMapper.h.

int vtkTextMapper::LineSize
protected

Definition at line 133 of file vtkTextMapper.h.

int vtkTextMapper::NumberOfLines
protected

Definition at line 134 of file vtkTextMapper.h.

int vtkTextMapper::NumberOfLinesAllocated
protected

Definition at line 135 of file vtkTextMapper.h.

vtkTextMapper** vtkTextMapper::TextLines
protected

Definition at line 137 of file vtkTextMapper.h.


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