perform coordinate transformation, and represent position, in a variety of vtk coordinate systems More...

#include <vtkCoordinate.h>

Inheritance diagram for vtkCoordinate:

Collaboration diagram for vtkCoordinate:

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkCoordinate *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
const char *	GetCoordinateSystemAsString ()
double *	GetComputedDoubleViewportValue (vtkViewport *)
double *	GetComputedDoubleDisplayValue (vtkViewport *)
double *	GetComputedValue (vtkViewport *)

virtual void	SetCoordinateSystem (int)
virtual int	GetCoordinateSystem ()
void	SetCoordinateSystemToDisplay ()
void	SetCoordinateSystemToNormalizedDisplay ()
void	SetCoordinateSystemToViewport ()
void	SetCoordinateSystemToNormalizedViewport ()
void	SetCoordinateSystemToView ()
void	SetCoordinateSystemToWorld ()

virtual void	SetValue (double, double, double)
virtual void	SetValue (double[3])
virtual double *	GetValue ()
virtual void	GetValue (double &, double &, double &)
virtual void	GetValue (double[3])
void	SetValue (double a, double b)

virtual void	SetReferenceCoordinate (vtkCoordinate *)
virtual vtkCoordinate *	GetReferenceCoordinate ()

void	SetViewport (vtkViewport *viewport)
virtual vtkViewport *	GetViewport ()

double *	GetComputedWorldValue (vtkViewport *)
int *	GetComputedViewportValue (vtkViewport *)
int *	GetComputedDisplayValue (vtkViewport *)
int *	GetComputedLocalDisplayValue (vtkViewport *)

virtual double *	GetComputedUserDefinedValue (vtkViewport *)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCoordinate *	SafeDownCast (vtkObjectBase *o)
static vtkCoordinate *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCoordinate ()
	~vtkCoordinate ()
Protected Attributes
double	Value [3]
int	CoordinateSystem
vtkCoordinate *	ReferenceCoordinate
vtkViewport *	Viewport
double	ComputedWorldValue [3]
int	ComputedDisplayValue [2]
int	ComputedViewportValue [2]
int	Computing
double	ComputedDoubleDisplayValue [2]
double	ComputedDoubleViewportValue [2]
double	ComputedUserDefinedValue [3]

Detailed Description

perform coordinate transformation, and represent position, in a variety of vtk coordinate systems

vtkCoordinate represents position in a variety of coordinate systems, and converts position to other coordinate systems. It also supports relative positioning, so you can create a cascade of vtkCoordinate objects (no loops please!) that refer to each other. The typical usage of this object is to set the coordinate system in which to represent a position (e.g., SetCoordinateSystemToNormalizedDisplay()), set the value of the coordinate (e.g., SetValue()), and then invoke the appropriate method to convert to another coordinate system (e.g., GetComputedWorldValue()).

The coordinate systems in vtk are as follows:

   DISPLAY -             x-y pixel values in window
   NORMALIZED DISPLAY -  x-y (0,1) normalized values
   VIEWPORT -            x-y pixel values in viewport
   NORMALIZED VIEWPORT - x-y (0,1) normalized value in viewport
   VIEW -                x-y-z (-1,1) values in camera coordinates. (z is depth)
   WORLD -               x-y-z global coordinate values
   USERDEFINED -         x-y-z in User defined space

If you cascade vtkCoordinate objects, you refer to another vtkCoordinate object which in turn can refer to others, and so on. This allows you to create composite groups of things like vtkActor2D that are positioned relative to one another. Note that in cascaded sequences, each vtkCoordinate object may be specified in different coordinate systems!

See also:: vtkActor2D vtkScalarBarActor

Examples:: vtkCoordinate (Examples)

Tests:: vtkCoordinate (Tests)

Definition at line 69 of file vtkCoordinate.h.

Member Typedef Documentation

typedef vtkObject vtkCoordinate::Superclass

Reimplemented from vtkObject.

Definition at line 72 of file vtkCoordinate.h.

Constructor & Destructor Documentation

vtkCoordinate::vtkCoordinate ( ) [protected]

vtkCoordinate::~vtkCoordinate ( ) [protected]

Member Function Documentation

static int vtkCoordinate::IsTypeOf ( const char * name ) [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 vtkObject.

virtual int vtkCoordinate::IsA ( const char * name ) [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 vtkObject.

static vtkCoordinate* vtkCoordinate::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkCoordinate::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkCoordinate* vtkCoordinate::NewInstance ( ) const

Reimplemented from vtkObject.

void vtkCoordinate::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 vtkObject.

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

Creates an instance of this class with the following defaults: value of (0,0,0) in world coordinates.

Reimplemented from vtkObject.

virtual void vtkCoordinate::SetCoordinateSystem ( int ) [virtual]