Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkCoordinate Class Reference

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

#include <vtkCoordinate.h>

Inheritance diagram for vtkCoordinate:

Inheritance graph
Collaboration diagram for vtkCoordinate:

Collaboration graph
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetCoordinateSystem (int)
virtual int GetCoordinateSystem ()
void SetCoordinateSystemToDisplay ()
void SetCoordinateSystemToNormalizedDisplay ()
void SetCoordinateSystemToViewport ()
void SetCoordinateSystemToNormalizedViewport ()
void SetCoordinateSystemToView ()
void SetCoordinateSystemToWorld ()
const char * GetCoordinateSystemAsString ()
virtual void SetValue (float, float, float)
virtual void SetValue (float[3])
virtual float * GetValue ()
virtual void GetValue (float &, float &, float &)
virtual void GetValue (float[3])
void SetValue (float a, float b)
virtual void SetReferenceCoordinate (vtkCoordinate *)
virtual vtkCoordinate * GetReferenceCoordinate ()
void SetViewport (vtkViewport *viewport)
virtual vtkViewportGetViewport ()
float * GetComputedWorldValue (vtkViewport *)
int * GetComputedViewportValue (vtkViewport *)
int * GetComputedDisplayValue (vtkViewport *)
int * GetComputedLocalDisplayValue (vtkViewport *)
float * GetComputedFloatViewportValue (vtkViewport *)
float * GetComputedFloatDisplayValue (vtkViewport *)
float * GetComputedValue (vtkViewport *)
virtual float * GetComputedUserDefinedValue (vtkViewport *)

Static Public Methods

int IsTypeOf (const char *type)
vtkCoordinate * SafeDownCast (vtkObject *o)
vtkCoordinate * New ()

Protected Methods

 vtkCoordinate ()
 ~vtkCoordinate ()
 vtkCoordinate (const vtkCoordinate &)
void operator= (const vtkCoordinate &)

Protected Attributes

float Value [3]
int CoordinateSystem
vtkCoordinate * ReferenceCoordinate
float ComputedWorldValue [3]
int ComputedDisplayValue [2]
int ComputedViewportValue [2]
int Computing
float ComputedFloatDisplayValue [2]
float ComputedFloatViewportValue [2]
float ComputedUserDefinedValue [3]

Detailed Description

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

2000/12/10 20:08:07
Thanks to Matt Turek who developed this class.
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:
vtkProp2D vtkActor2D vtkScalarBarActor
vtkCoordinate (examples)

Definition at line 93 of file vtkCoordinate.h.

Constructor & Destructor Documentation

vtkCoordinate::vtkCoordinate   [protected]

vtkCoordinate::~vtkCoordinate   [protected]

vtkCoordinate::vtkCoordinate const vtkCoordinate &    [inline, protected]

Definition at line 162 of file vtkCoordinate.h.

Member Function Documentation

virtual const char* vtkCoordinate::GetClassName   [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

int vtkCoordinate::IsTypeOf const char *    type [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 *    type [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.

vtkCoordinate* vtkCoordinate::SafeDownCast vtkObject   o [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

void vtkCoordinate::PrintSelf ostream &    os,
vtkIndent    indent

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.

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]

Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.

virtual int vtkCoordinate::GetCoordinateSystem   [virtual]

void vtkCoordinate::SetCoordinateSystemToDisplay   [inline]

Definition at line 108 of file vtkCoordinate.h.

void vtkCoordinate::SetCoordinateSystemToNormalizedDisplay   [inline]

Definition at line 109 of file vtkCoordinate.h.

void vtkCoordinate::SetCoordinateSystemToViewport   [inline]

Definition at line 111 of file vtkCoordinate.h.

void vtkCoordinate::SetCoordinateSystemToNormalizedViewport   [inline]

Definition at line 113 of file vtkCoordinate.h.

void vtkCoordinate::SetCoordinateSystemToView   [inline]

Definition at line 115 of file vtkCoordinate.h.

void vtkCoordinate::SetCoordinateSystemToWorld   [inline]

Definition at line 116 of file vtkCoordinate.h.

const char* vtkCoordinate::GetCoordinateSystemAsString  

virtual void vtkCoordinate::SetValue float   ,
float   ,

Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.

virtual void vtkCoordinate::SetValue float   [3] [virtual]

virtual float* vtkCoordinate::GetValue   [virtual]

virtual void vtkCoordinate::GetValue float &   ,
float &   ,
float &   

virtual void vtkCoordinate::GetValue float   [3] [virtual]

void vtkCoordinate::SetValue float    a,
float    b

Definition at line 124 of file vtkCoordinate.h.

virtual void vtkCoordinate::SetReferenceCoordinate vtkCoordinate *    [virtual]

If this coordinate is relative to another coordinate, then specify that coordinate as the ReferenceCoordinate. If this is NULL the coordinate is assumed to be absolute.

virtual vtkCoordinate* vtkCoordinate::GetReferenceCoordinate   [virtual]

void vtkCoordinate::SetViewport vtkViewport   viewport

If you want this coordinate to be relative to a specific vtkViewport (vtkRenderer, vtkImager) then you can specify that here.

virtual vtkViewport* vtkCoordinate::GetViewport   [virtual]

float* vtkCoordinate::GetComputedWorldValue vtkViewport  

Return the computed value in a specified coordinate system.

int* vtkCoordinate::GetComputedViewportValue vtkViewport  

int* vtkCoordinate::GetComputedDisplayValue vtkViewport  

int* vtkCoordinate::GetComputedLocalDisplayValue vtkViewport  

float* vtkCoordinate::GetComputedFloatViewportValue vtkViewport  

float* vtkCoordinate::GetComputedFloatDisplayValue vtkViewport  

float* vtkCoordinate::GetComputedValue vtkViewport  

GetComputedValue() will return either World, Viewport or Display based on what has been set as the coordinate system. This is good for objects like vtkLineSource, where the user might want to use them as World or Viewport coordinates

virtual float* vtkCoordinate::GetComputedUserDefinedValue vtkViewport   [inline, virtual]

GetComputedUserDefinedValue() is to be used only when the coordinate system is VTK_USERDEFINED. The user must subclass vtkCoordinate and override this function, when set as the TransformCoordinate in 2D-Mappers, the user can customize display of 2D polygons

Definition at line 156 of file vtkCoordinate.h.

void vtkCoordinate::operator= const vtkCoordinate &    [inline, protected]

Definition at line 163 of file vtkCoordinate.h.

Member Data Documentation

float vtkCoordinate::Value[3] [protected]

Definition at line 165 of file vtkCoordinate.h.

int vtkCoordinate::CoordinateSystem [protected]

Definition at line 166 of file vtkCoordinate.h.

vtkCoordinate* vtkCoordinate::ReferenceCoordinate [protected]

Definition at line 167 of file vtkCoordinate.h.

vtkViewport* vtkCoordinate::Viewport [protected]

Definition at line 168 of file vtkCoordinate.h.

float vtkCoordinate::ComputedWorldValue[3] [protected]

Definition at line 169 of file vtkCoordinate.h.

int vtkCoordinate::ComputedDisplayValue[2] [protected]

Definition at line 170 of file vtkCoordinate.h.

int vtkCoordinate::ComputedViewportValue[2] [protected]

Definition at line 171 of file vtkCoordinate.h.

int vtkCoordinate::Computing [protected]

Definition at line 172 of file vtkCoordinate.h.

float vtkCoordinate::ComputedFloatDisplayValue[2] [protected]

Definition at line 174 of file vtkCoordinate.h.

float vtkCoordinate::ComputedFloatViewportValue[2] [protected]

Definition at line 175 of file vtkCoordinate.h.

float vtkCoordinate::ComputedUserDefinedValue[3] [protected]

Definition at line 176 of file vtkCoordinate.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:47:04 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001