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

represent text for vtkTextWidget More...

#include <vtkTextRepresentation.h>

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

Public Types

enum  {
  AnyLocation = 0, LowerLeftCorner, LowerRightCorner, LowerCenter,
  UpperLeftCorner, UpperRightCorner, UpperCenter
}
- Public Types inherited from vtkBorderRepresentation
enum  { BORDER_OFF = 0, BORDER_ON, BORDER_ACTIVE }
enum  _InteractionState {
  Outside = 0, Inside, AdjustingP0, AdjustingP1,
  AdjustingP2, AdjustingP3, AdjustingE0, AdjustingE1,
  AdjustingE2, AdjustingE3
}
typedef vtkWidgetRepresentation Superclass
- Public Types inherited from vtkWidgetRepresentation
typedef vtkProp Superclass

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)
- Public Member Functions inherited from vtkBorderRepresentation
virtual vtkCoordinateGetPositionCoordinate ()
virtual void SetPosition (float x[2])
virtual void SetPosition (float x, float y)
virtual float * GetPosition ()
virtual vtkCoordinateGetPosition2Coordinate ()
virtual void SetPosition2 (float x[2])
virtual void SetPosition2 (float x, float y)
virtual float * GetPosition2 ()
virtual void SetShowBorder (int)
virtual int GetShowBorder ()
void SetShowBorderToOff ()
void SetShowBorderToOn ()
void SetShowBorderToActive ()
virtual vtkProperty2DGetBorderProperty ()
virtual void SetProportionalResize (int)
virtual int GetProportionalResize ()
virtual void ProportionalResizeOn ()
virtual void ProportionalResizeOff ()
virtual void SetMinimumSize (int, int)
void SetMinimumSize (int[2])
virtual int * GetMinimumSize ()
virtual void GetMinimumSize (int &, int &)
virtual void GetMinimumSize (int[2])
virtual void SetMaximumSize (int, int)
void SetMaximumSize (int[2])
virtual int * GetMaximumSize ()
virtual void GetMaximumSize (int &, int &)
virtual void GetMaximumSize (int[2])
virtual void SetTolerance (int)
virtual int GetTolerance ()
virtual double * GetSelectionPoint ()
virtual void GetSelectionPoint (double data[2])
virtual void SetMoving (int)
virtual int GetMoving ()
virtual void MovingOn ()
virtual void MovingOff ()
virtual void StartWidgetInteraction (double eventPos[2])
virtual void WidgetInteraction (double eventPos[2])
virtual int ComputeInteractionState (int X, int Y, int modify=0)
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void SetRenderer (vtkRenderer *ren)
virtual vtkRendererGetRenderer ()
virtual void PlaceWidget (double *vtkNotUsed(bounds[6]))
virtual void EndWidgetInteraction (double newEventPos[2])
virtual int GetInteractionState ()
virtual void Highlight (int vtkNotUsed(highlightOn))
virtual void SetPlaceFactor (double)
virtual double GetPlaceFactor ()
virtual void SetHandleSize (double)
virtual double GetHandleSize ()
virtual int GetNeedToRender ()
virtual void SetNeedToRender (int)
virtual void NeedToRenderOn ()
virtual void NeedToRenderOff ()
virtual double * GetBounds ()
virtual void ShallowCopy (vtkProp *prop)
virtual void GetActors (vtkPropCollection *)
virtual void GetVolumes (vtkPropCollection *)
virtual int RenderOverlay (vtkViewport *vtkNotUsed(viewport))
virtual int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport))
- Public Member Functions inherited from vtkProp
virtual void Pick ()
virtual unsigned long GetRedrawMTime ()
virtual bool HasKeys (vtkInformation *requiredKeys)
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
virtual void SetVisibility (int)
virtual int GetVisibility ()
virtual void VisibilityOn ()
virtual void VisibilityOff ()
virtual void SetPickable (int)
virtual int GetPickable ()
virtual void PickableOn ()
virtual void PickableOff ()
virtual void SetDragable (int)
virtual int GetDragable ()
virtual void DragableOn ()
virtual void DragableOff ()
virtual void SetUseBounds (bool)
virtual bool GetUseBounds ()
virtual void UseBoundsOn ()
virtual void UseBoundsOff ()
virtual void InitPathTraversal ()
virtual vtkAssemblyPathGetNextPath ()
virtual int GetNumberOfPaths ()
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkMatrix4x4GetMatrix ()
virtual vtkInformationGetPropertyKeys ()
virtual void SetPropertyKeys (vtkInformation *keys)
virtual int RenderVolumetricGeometry (vtkViewport *)
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
virtual double GetEstimatedRenderTime (vtkViewport *)
virtual double GetEstimatedRenderTime ()
virtual void SetEstimatedRenderTime (double t)
virtual void RestoreEstimatedRenderTime ()
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
virtual double GetAllocatedRenderTime ()
void SetRenderTimeMultiplier (double t)
virtual double GetRenderTimeMultiplier ()
virtual bool GetSupportsSelection ()
virtual int GetNumberOfConsumers ()
void AddConsumer (vtkObject *c)
void RemoveConsumer (vtkObject *c)
vtkObjectGetConsumer (int i)
int IsConsumer (vtkObject *c)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
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)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
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 vtkTextRepresentationNew ()
- Static Public Member Functions inherited from vtkBorderRepresentation

Protected Member Functions

 vtkTextRepresentation ()
 ~vtkTextRepresentation ()
virtual void InitializeTextActor ()
virtual void CheckTextBoundary ()
virtual void UpdateWindowLocation ()
- Protected Member Functions inherited from vtkBorderRepresentation
 vtkBorderRepresentation ()
 ~vtkBorderRepresentation ()
virtual void NegotiateLayout ()
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 ~vtkWidgetRepresentation ()
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
double SizeHandlesRelativeToViewport (double factor, double pos[3])
double SizeHandlesInPixels (double factor, double pos[3])
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 ~vtkProp ()
- 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)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkTextActorTextActor
vtkTextPropertyTextProperty
int WindowLocation
vtkTextRepresentationObserver * Observer
- Protected Attributes inherited from vtkBorderRepresentation
int ShowBorder
vtkProperty2DBorderProperty
int ProportionalResize
int Tolerance
int Moving
double SelectionPoint [2]
vtkCoordinatePositionCoordinate
vtkCoordinatePosition2Coordinate
int Negotiated
double StartPosition [2]
vtkPointsBWPoints
vtkPolyDataBWPolyData
vtkTransformBWTransform
vtkTransformPolyDataFilterBWTransformFilter
vtkPolyDataMapper2DBWMapper
vtkActor2DBWActor
int MinimumSize [2]
int MaximumSize [2]
- Protected Attributes inherited from vtkWidgetRepresentation
vtkRendererRenderer
int InteractionState
double StartEventPosition [3]
double PlaceFactor
int Placed
double InitialBounds [6]
double InitialLength
int ValidPick
double HandleSize
int NeedToRender
vtkTimeStamp BuildTime
- Protected Attributes inherited from vtkProp
int Visibility
int Pickable
int Dragable
bool UseBounds
double AllocatedRenderTime
double EstimatedRenderTime
double SavedEstimatedRenderTime
double RenderTimeMultiplier
int NumberOfConsumers
vtkObject ** Consumers
vtkAssemblyPathsPaths
vtkInformationPropertyKeys
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers
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)

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.

Member Typedef Documentation

Standard VTK methods.

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])
inlinevirtual

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])
inlinevirtual

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 ( )
protectedvirtual
virtual void vtkTextRepresentation::CheckTextBoundary ( )
protectedvirtual
virtual void vtkTextRepresentation::UpdateWindowLocation ( )
protectedvirtual

Member Data Documentation

vtkTextActor* vtkTextRepresentation::TextActor
protected

Definition at line 128 of file vtkTextRepresentation.h.

vtkTextProperty* vtkTextRepresentation::TextProperty
protected

Definition at line 129 of file vtkTextRepresentation.h.

int vtkTextRepresentation::WindowLocation
protected

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: