VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 vtkTextActor * GetTextActor ()
 
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 vtkCoordinate * GetPositionCoordinate ()
 
virtual void SetPosition (float x[2])
 
virtual void SetPosition (float x, float y)
 
virtual float * GetPosition ()
 
virtual vtkCoordinate * GetPosition2Coordinate ()
 
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 vtkProperty2D * GetBorderProperty ()
 
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)
 
vtkBorderRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void PickingManagedOn ()
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool)
 
virtual bool GetPickingManaged ()
 
virtual void SetRenderer (vtkRenderer *ren)
 
virtual vtkRenderer * GetRenderer ()
 
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))
 
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkTextRepresentationNew ()
 
- Static Public Member Functions inherited from vtkBorderRepresentation
static vtkBorderRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkBorderRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static int IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 

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])
 
virtual void RegisterPickers ()
 
virtual void UnRegisterPickers ()
 
virtual void PickersModified ()
 
vtkPickingManager * GetPickingManager ()
 
double SizeHandlesRelativeToViewport (double factor, double pos[3])
 
double SizeHandlesInPixels (double factor, double pos[3])
 
vtkAssemblyPath * GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 

Protected Attributes

vtkTextActor * TextActor
 
vtkTextProperty * TextProperty
 
int WindowLocation
 
vtkTextRepresentationObserver * Observer
 
- Protected Attributes inherited from vtkBorderRepresentation
int ShowBorder
 
vtkProperty2D * BorderProperty
 
int ProportionalResize
 
int Tolerance
 
int Moving
 
double SelectionPoint [2]
 
vtkCoordinate * PositionCoordinate
 
vtkCoordinate * Position2Coordinate
 
int Negotiated
 
double StartPosition [2]
 
vtkPoints * BWPoints
 
vtkPolyDataBWPolyData
 
vtkTransformBWTransform
 
vtkTransformPolyDataFilterBWTransformFilter
 
vtkPolyDataMapper2D * BWMapper
 
vtkActor2D * BWActor
 
int MinimumSize [2]
 
int MaximumSize [2]
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRenderer > Renderer
 
int InteractionState
 
double StartEventPosition [3]
 
double PlaceFactor
 
int Placed
 
double InitialBounds [6]
 
double InitialLength
 
int ValidPick
 
bool PickingManaged
 
double HandleSize
 
int NeedToRender
 
vtkTimeStamp BuildTime
 
typedef vtkBorderRepresentation Superclass
 
static int IsTypeOf (const char *type)
 
static vtkTextRepresentationSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkTextRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

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 40 of file vtkTextRepresentation.h.

Member Typedef Documentation

Standard VTK methods.

Definition at line 48 of file vtkTextRepresentation.h.

Member Enumeration Documentation

anonymous enum
Enumerator
AnyLocation 
LowerLeftCorner 
LowerRightCorner 
LowerCenter 
UpperLeftCorner 
UpperRightCorner 
UpperCenter 

Definition at line 84 of file vtkTextRepresentation.h.

Constructor & Destructor Documentation

vtkTextRepresentation::vtkTextRepresentation ( )
protected
vtkTextRepresentation::~vtkTextRepresentation ( )
protected

Member Function Documentation

static vtkTextRepresentation* vtkTextRepresentation::New ( )
static

Instantiate class.

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

Standard VTK methods.

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

Standard VTK methods.

Reimplemented from vtkBorderRepresentation.

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

Standard VTK methods.

virtual vtkObjectBase* vtkTextRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK methods.

Reimplemented from vtkBorderRepresentation.

vtkTextRepresentation* vtkTextRepresentation::NewInstance ( ) const

Standard VTK methods.

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

Standard VTK methods.

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 68 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 108 of file vtkTextRepresentation.h.

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

Internal. Execute events observed by internal observer

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

Internal. Execute 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 129 of file vtkTextRepresentation.h.

vtkTextProperty* vtkTextRepresentation::TextProperty
protected

Definition at line 130 of file vtkTextRepresentation.h.

int vtkTextRepresentation::WindowLocation
protected

Definition at line 133 of file vtkTextRepresentation.h.

vtkTextRepresentationObserver* vtkTextRepresentation::Observer
protected

Definition at line 137 of file vtkTextRepresentation.h.


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