---

vtkScaledTextActor Class Reference

create text that will scale as needed. More...

#include <vtkScaledTextActor.h>

Inheritance diagram for vtkScaledTextActor:

[legend]Collaboration diagram for vtkScaledTextActor:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetMapper (vtkTextMapper *mapper)
void	ShallowCopy (vtkProp *prop)
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual void	SetMinimumSize (int, int)
void	SetMinimumSize (int[2])
virtual int *	GetMinimumSize ()
virtual void	GetMinimumSize (int &, int &)
virtual void	GetMinimumSize (int[2])
virtual void	SetMaximumLineHeight (float)
virtual float	GetMaximumLineHeight ()
int	RenderOpaqueGeometry (vtkViewport *viewport)
int	RenderTranslucentGeometry (vtkViewport *)
int	RenderOverlay (vtkViewport *viewport)
Static Public Methods
int	IsTypeOf (const char *type)
vtkScaledTextActor *	SafeDownCast (vtkObject *o)
vtkScaledTextActor *	New ()
Protected Methods
	vtkScaledTextActor ()
	~vtkScaledTextActor ()
Protected Attributes
int	MinimumSize [2]
float	MaximumLineHeight
vtkActor2D *	TextActor
vtkTimeStamp	BuildTime
int	LastSize [2]
int	LastOrigin [2]

---

Detailed Description

create text that will scale as needed.

Date:

2001/10/11 13:38:25

Revision:

1.20

vtkScaledTextActor can be used to place text annotation into a window and have the font size scale so that the text always bounded by a specified rectangle.

See also:

vtkActor2D vtkTextMapper

Examples:

vtkScaledTextActor (Examples)

Definition at line 62 of file vtkScaledTextActor.h.

---

Constructor & Destructor Documentation

vtkScaledTextActor::vtkScaledTextActor (    )  [protected]

vtkScaledTextActor::~vtkScaledTextActor (    )  [protected]

---

Member Function Documentation

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkActor2D.

int vtkScaledTextActor::IsTypeOf (  const char *    type )  [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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkActor2D.

virtual int vtkScaledTextActor::IsA (  const char *    type )  [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 vtkActor2D.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkActor2D.

void vtkScaledTextActor::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 vtkActor2D.

vtkScaledTextActor* vtkScaledTextActor::New (    )  [static]

Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95). Reimplemented from vtkActor2D.

void vtkScaledTextActor::SetMapper (  vtkTextMapper *    mapper )

Set/Get the vtkTextMapper that defines the text to be drawn.

virtual void vtkScaledTextActor::SetMinimumSize (  int   , int    )  [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10.

void vtkScaledTextActor::SetMinimumSize (  int   [2] )

Set/Get the minimum size in pixels for this actor. Defaults to 10,10.

virtual int* vtkScaledTextActor::GetMinimumSize (    )  [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10.

virtual void vtkScaledTextActor::GetMinimumSize (  int &   , int &    )  [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10.

virtual void vtkScaledTextActor::GetMinimumSize (  int   [2] )  [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10.

virtual void vtkScaledTextActor::SetMaximumLineHeight (  float    )  [virtual]

Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. Defaults to 1.0.

virtual float vtkScaledTextActor::GetMaximumLineHeight (    )  [virtual]

Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. Defaults to 1.0.

void vtkScaledTextActor::ShallowCopy (  vtkProp *    prop )  [virtual]

Shallow copy of this scaled text actor. Overloads the virtual vtkProp method. Reimplemented from vtkActor2D.

virtual void vtkScaledTextActor::ReleaseGraphicsResources (  vtkWindow *    )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release. Reimplemented from vtkActor2D.

int vtkScaledTextActor::RenderOpaqueGeometry (  vtkViewport *    viewport )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. Draw the scaled text actor to the screen. Reimplemented from vtkActor2D.

int vtkScaledTextActor::RenderTranslucentGeometry (  vtkViewport *    viewport )  [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. Draw the scaled text actor to the screen. Reimplemented from vtkActor2D. Definition at line 104 of file vtkScaledTextActor.h.

int vtkScaledTextActor::RenderOverlay (  vtkViewport *    viewport )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. Draw the scaled text actor to the screen. Reimplemented from vtkActor2D.

---

Member Data Documentation

int vtkScaledTextActor::MinimumSize[2] [protected]

Definition at line 113 of file vtkScaledTextActor.h.

float vtkScaledTextActor::MaximumLineHeight [protected]

Definition at line 114 of file vtkScaledTextActor.h.

vtkActor2D* vtkScaledTextActor::TextActor [protected]

Definition at line 116 of file vtkScaledTextActor.h.

vtkTimeStamp vtkScaledTextActor::BuildTime [protected]

Definition at line 117 of file vtkScaledTextActor.h.

int vtkScaledTextActor::LastSize[2] [protected]

Definition at line 118 of file vtkScaledTextActor.h.

int vtkScaledTextActor::LastOrigin[2] [protected]

Definition at line 119 of file vtkScaledTextActor.h.

---

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

• Rendering/vtkScaledTextActor.h

---