vtkTextRepresentation Class Reference

#include <vtkTextRepresentation.h>

Inheritance diagram for vtkTextRepresentation:

Inheritance graph
[legend]
Collaboration diagram for vtkTextRepresentation:

Collaboration graph
[legend]

List of all members.


Detailed Description

represent text for vtkTextWidget

This class represents text for a vtkTextWidget. This class provides support for interactively placing text on the 2D overlay plane. The text is defined by an instance of vtkTextActor.

See also:
vtkTextRepresentation vtkBorderWidget vtkAbstractWidget vtkWidgetRepresentation
Tests:
vtkTextRepresentation (Tests)

Definition at line 39 of file vtkTextRepresentation.h.

typedef vtkBorderRepresentation Superclass
static int IsTypeOf (const char *type)
static vtkTextRepresentationSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Public Types

enum  {
  AnyLocation = 0, LowerLeftCorner, LowerRightCorner, LowerCenter,
  UpperLeftCorner, UpperRightCorner, UpperCenter
}

Public Member Functions

void SetTextActor (vtkTextActor *textActor)
virtual vtkTextActorGetTextActor ()
void SetText (const char *text)
const char * GetText ()
virtual void BuildRepresentation ()
virtual void GetSize (double size[2])
virtual void GetActors2D (vtkPropCollection *)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual int RenderOverlay (vtkViewport *)
virtual int RenderOpaqueGeometry (vtkViewport *)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int HasTranslucentPolygonalGeometry ()
virtual void SetWindowLocation (int enumLocation)
virtual int GetWindowLocation ()
virtual void SetPosition (double x, double y)
virtual void SetPosition (double pos[2])
void ExecuteTextPropertyModifiedEvent (vtkObject *obj, unsigned long enumEvent, void *p)
void ExecuteTextActorModifiedEvent (vtkObject *obj, unsigned long enumEvent, void *p)

Static Public Member Functions

static vtkTextRepresentationNew ()

Protected Member Functions

 vtkTextRepresentation ()
 ~vtkTextRepresentation ()
virtual void InitializeTextActor ()
virtual void CheckTextBoundary ()
virtual void UpdateWindowLocation ()

Protected Attributes

vtkTextActorTextActor
vtkTextPropertyTextProperty
int WindowLocation
vtkTextRepresentationObserver * Observer

Member Typedef Documentation

Standard VTK methods.

Reimplemented from vtkBorderRepresentation.

Definition at line 47 of file vtkTextRepresentation.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
AnyLocation 
LowerLeftCorner 
LowerRightCorner 
LowerCenter 
UpperLeftCorner 
UpperRightCorner 
UpperCenter 

Definition at line 83 of file vtkTextRepresentation.h.


Constructor & Destructor Documentation

vtkTextRepresentation::vtkTextRepresentation (  )  [protected]

vtkTextRepresentation::~vtkTextRepresentation (  )  [protected]


Member Function Documentation

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

Instantiate class.

Reimplemented from vtkBorderRepresentation.

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

Standard VTK methods.

Reimplemented from vtkBorderRepresentation.

static int vtkTextRepresentation::IsTypeOf ( const char *  type  )  [static]

Standard VTK methods.

Reimplemented from vtkBorderRepresentation.

virtual int vtkTextRepresentation::IsA ( const char *  type  )  [virtual]

Standard VTK methods.

Reimplemented from vtkBorderRepresentation.

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

Standard VTK methods.

Reimplemented from vtkBorderRepresentation.

void vtkTextRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Standard VTK methods.

Reimplemented from vtkBorderRepresentation.

void vtkTextRepresentation::SetTextActor ( vtkTextActor textActor  ) 

Specify the vtkTextActor to manage. If not specified, then one is automatically created.

virtual vtkTextActor* vtkTextRepresentation::GetTextActor (  )  [virtual]

Specify the vtkTextActor to manage. If not specified, then one is automatically created.

void vtkTextRepresentation::SetText ( const char *  text  ) 

Get/Set the text string display by this representation.

const char* vtkTextRepresentation::GetText (  ) 

Get/Set the text string display by this representation.

virtual void vtkTextRepresentation::BuildRepresentation (  )  [virtual]

Satisfy the superclasses API.

Reimplemented from vtkBorderRepresentation.

virtual void vtkTextRepresentation::GetSize ( double  size[2]  )  [inline, virtual]

Satisfy the superclasses API.

Reimplemented from vtkBorderRepresentation.

Definition at line 67 of file vtkTextRepresentation.h.

virtual void vtkTextRepresentation::GetActors2D ( vtkPropCollection  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

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

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkTextRepresentation::RenderOverlay ( vtkViewport  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkTextRepresentation::RenderOpaqueGeometry ( vtkViewport  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkTextRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkTextRepresentation::HasTranslucentPolygonalGeometry (  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual void vtkTextRepresentation::SetWindowLocation ( int  enumLocation  )  [virtual]

Set the text position, by enumeration ( AnyLocation = 0, LowerLeftCorner, LowerRightCorner, LowerCenter, UpperLeftCorner, UpperRightCorner, UpperCenter) related to the render window

virtual int vtkTextRepresentation::GetWindowLocation (  )  [virtual]

Set the text position, by enumeration ( AnyLocation = 0, LowerLeftCorner, LowerRightCorner, LowerCenter, UpperLeftCorner, UpperRightCorner, UpperCenter) related to the render window

virtual void vtkTextRepresentation::SetPosition ( double  x,
double  y 
) [virtual]

Set the text position, by overiding the same function of vtkBorderRepresentation so that the Modified() will be called.

virtual void vtkTextRepresentation::SetPosition ( double  pos[2]  )  [inline, virtual]

Set the text position, by overiding the same function of vtkBorderRepresentation so that the Modified() will be called.

Definition at line 107 of file vtkTextRepresentation.h.

void vtkTextRepresentation::ExecuteTextPropertyModifiedEvent ( vtkObject obj,
unsigned long  enumEvent,
void *  p 
)

Internal. Excecute events observed by internal observer

void vtkTextRepresentation::ExecuteTextActorModifiedEvent ( vtkObject obj,
unsigned long  enumEvent,
void *  p 
)

Internal. Excecute events observed by internal observer

virtual void vtkTextRepresentation::InitializeTextActor (  )  [protected, virtual]

virtual void vtkTextRepresentation::CheckTextBoundary (  )  [protected, virtual]

virtual void vtkTextRepresentation::UpdateWindowLocation (  )  [protected, virtual]


Member Data Documentation

Definition at line 128 of file vtkTextRepresentation.h.

Definition at line 129 of file vtkTextRepresentation.h.

Definition at line 132 of file vtkTextRepresentation.h.

vtkTextRepresentationObserver* vtkTextRepresentation::Observer [protected]

Definition at line 136 of file vtkTextRepresentation.h.


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

Generated on Mon Sep 27 18:55:26 2010 for VTK by  doxygen 1.5.6