vtkDistanceRepresentation Class Reference

#include <vtkDistanceRepresentation.h>

Inheritance diagram for vtkDistanceRepresentation:

Inheritance graph
[legend]
Collaboration diagram for vtkDistanceRepresentation:

Collaboration graph
[legend]

List of all members.


Detailed Description

represent the vtkDistanceWidget

The vtkDistanceRepresentation is a superclass for various types of representations for the vtkDistanceWidget. Logically subclasses consist of an axis and two handles for placing/manipulating the end points.

See also:
vtkDistanceWidget vtkHandleRepresentation vtkDistanceRepresentation2D vtkDistanceRepresentation

Definition at line 34 of file vtkDistanceRepresentation.h.

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

Public Types

enum  { Outside = 0, NearP1, NearP2 }

Public Member Functions

virtual double GetDistance ()=0
virtual void GetPoint1WorldPosition (double pos[3])=0
virtual void GetPoint2WorldPosition (double pos[3])=0
virtual double * GetPoint1WorldPosition ()=0
virtual double * GetPoint2WorldPosition ()=0
virtual void SetPoint1DisplayPosition (double pos[3])=0
virtual void SetPoint2DisplayPosition (double pos[3])=0
virtual void GetPoint1DisplayPosition (double pos[3])=0
virtual void GetPoint2DisplayPosition (double pos[3])=0
virtual void SetPoint1WorldPosition (double pos[3])=0
virtual void SetPoint2WorldPosition (double pos[3])=0
void SetHandleRepresentation (vtkHandleRepresentation *handle)
void InstantiateHandleRepresentation ()
virtual vtkHandleRepresentationGetPoint1Representation ()
virtual vtkHandleRepresentationGetPoint2Representation ()
virtual void SetTolerance (int)
virtual int GetTolerance ()
virtual void SetLabelFormat (const char *)
virtual char * GetLabelFormat ()
virtual void BuildRepresentation ()
virtual int ComputeInteractionState (int X, int Y, int modify=0)
virtual void StartWidgetInteraction (double e[2])
virtual void WidgetInteraction (double e[2])

Protected Member Functions

 vtkDistanceRepresentation ()
 ~vtkDistanceRepresentation ()

Protected Attributes

vtkHandleRepresentationHandleRepresentation
vtkHandleRepresentationPoint1Representation
vtkHandleRepresentationPoint2Representation
int Tolerance
char * LabelFormat

Member Typedef Documentation

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkDistanceRepresentation2D.

Definition at line 39 of file vtkDistanceRepresentation.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
Outside 
NearP1 
NearP2 

Definition at line 102 of file vtkDistanceRepresentation.h.


Constructor & Destructor Documentation

vtkDistanceRepresentation::vtkDistanceRepresentation (  )  [protected]

vtkDistanceRepresentation::~vtkDistanceRepresentation (  )  [protected]


Member Function Documentation

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkDistanceRepresentation2D.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkDistanceRepresentation2D.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkDistanceRepresentation2D.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkDistanceRepresentation2D.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkDistanceRepresentation2D.

virtual double vtkDistanceRepresentation::GetDistance (  )  [pure virtual]

This representation and all subclasses must keep a distance consistent with the state of the widget.

Implemented in vtkDistanceRepresentation2D.

virtual void vtkDistanceRepresentation::GetPoint1WorldPosition ( double  pos[3]  )  [pure virtual]

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkDistanceRepresentation2D.

virtual void vtkDistanceRepresentation::GetPoint2WorldPosition ( double  pos[3]  )  [pure virtual]

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkDistanceRepresentation2D.

virtual double* vtkDistanceRepresentation::GetPoint1WorldPosition (  )  [pure virtual]

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkDistanceRepresentation2D.

virtual double* vtkDistanceRepresentation::GetPoint2WorldPosition (  )  [pure virtual]

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkDistanceRepresentation2D.

virtual void vtkDistanceRepresentation::SetPoint1DisplayPosition ( double  pos[3]  )  [pure virtual]

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkDistanceRepresentation2D.

virtual void vtkDistanceRepresentation::SetPoint2DisplayPosition ( double  pos[3]  )  [pure virtual]

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkDistanceRepresentation2D.

virtual void vtkDistanceRepresentation::GetPoint1DisplayPosition ( double  pos[3]  )  [pure virtual]

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkDistanceRepresentation2D.

virtual void vtkDistanceRepresentation::GetPoint2DisplayPosition ( double  pos[3]  )  [pure virtual]

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkDistanceRepresentation2D.

virtual void vtkDistanceRepresentation::SetPoint1WorldPosition ( double  pos[3]  )  [pure virtual]

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkDistanceRepresentation2D.

virtual void vtkDistanceRepresentation::SetPoint2WorldPosition ( double  pos[3]  )  [pure virtual]

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkDistanceRepresentation2D.

void vtkDistanceRepresentation::SetHandleRepresentation ( vtkHandleRepresentation handle  ) 

This method is used to specify the type of handle representation to use for the two internal vtkHandleWidgets within vtkDistanceWidget. To use this method, create a dummy vtkHandleWidget (or subclass), and then invoke this method with this dummy. Then the vtkDistanceRepresentation uses this dummy to clone two vtkHandleWidgets of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkDistance widget.)

void vtkDistanceRepresentation::InstantiateHandleRepresentation (  ) 

This method is used to specify the type of handle representation to use for the two internal vtkHandleWidgets within vtkDistanceWidget. To use this method, create a dummy vtkHandleWidget (or subclass), and then invoke this method with this dummy. Then the vtkDistanceRepresentation uses this dummy to clone two vtkHandleWidgets of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkDistance widget.)

virtual vtkHandleRepresentation* vtkDistanceRepresentation::GetPoint1Representation (  )  [virtual]

Set/Get the two handle representations used for the vtkDistanceWidget. (Note: properties can be set by grabbing these representations and setting the properties appropriately.)

virtual vtkHandleRepresentation* vtkDistanceRepresentation::GetPoint2Representation (  )  [virtual]

Set/Get the two handle representations used for the vtkDistanceWidget. (Note: properties can be set by grabbing these representations and setting the properties appropriately.)

virtual void vtkDistanceRepresentation::SetTolerance ( int   )  [virtual]

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the end points of the widget to be active.

virtual int vtkDistanceRepresentation::GetTolerance (  )  [virtual]

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the end points of the widget to be active.

virtual void vtkDistanceRepresentation::SetLabelFormat ( const char *   )  [virtual]

Specify the format to use for labelling the distance. Note that an empty string results in no label, or a format string without a "%" character will not print the distance value.

virtual char* vtkDistanceRepresentation::GetLabelFormat (  )  [virtual]

Specify the format to use for labelling the distance. Note that an empty string results in no label, or a format string without a "%" character will not print the distance value.

virtual void vtkDistanceRepresentation::BuildRepresentation (  )  [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Implements vtkWidgetRepresentation.

Reimplemented in vtkDistanceRepresentation2D.

virtual int vtkDistanceRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
) [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkDistanceRepresentation::StartWidgetInteraction ( double  e[2]  )  [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkDistanceRepresentation::WidgetInteraction ( double  e[2]  )  [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.


Member Data Documentation

Definition at line 118 of file vtkDistanceRepresentation.h.

Definition at line 119 of file vtkDistanceRepresentation.h.

Definition at line 120 of file vtkDistanceRepresentation.h.

Definition at line 123 of file vtkDistanceRepresentation.h.

Definition at line 126 of file vtkDistanceRepresentation.h.


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

Generated on Mon Sep 27 18:22:17 2010 for VTK by  doxygen 1.5.6