vtkCoordinate Class Reference

#include <vtkCoordinate.h>

Inheritance diagram for vtkCoordinate:

Inheritance graph
[legend]
Collaboration diagram for vtkCoordinate:

Collaboration graph
[legend]

List of all members.


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


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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 vtkCoordinateGetReferenceCoordinate ()
void SetViewport (vtkViewport *viewport)
virtual vtkViewportGetViewport ()
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 vtkCoordinateSafeDownCast (vtkObject *o)
static vtkCoordinateNew ()

Protected Member Functions

 vtkCoordinate ()
 ~vtkCoordinate ()

Protected Attributes

double Value [3]
int CoordinateSystem
vtkCoordinateReferenceCoordinate
vtkViewportViewport
double ComputedWorldValue [3]
int ComputedDisplayValue [2]
int ComputedViewportValue [2]
int Computing
double ComputedDoubleDisplayValue [2]
double ComputedDoubleViewportValue [2]
double ComputedUserDefinedValue [3]

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 71 of file vtkCoordinate.h.


Constructor & Destructor Documentation

vtkCoordinate::vtkCoordinate (  )  [protected]

vtkCoordinate::~vtkCoordinate (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkObject.

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 ( vtkObject o  )  [static]

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]

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]

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

void vtkCoordinate::SetCoordinateSystemToDisplay (  )  [inline]

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

Definition at line 84 of file vtkCoordinate.h.

void vtkCoordinate::SetCoordinateSystemToNormalizedDisplay (  )  [inline]

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

Definition at line 85 of file vtkCoordinate.h.

void vtkCoordinate::SetCoordinateSystemToViewport (  )  [inline]

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

Definition at line 87 of file vtkCoordinate.h.

void vtkCoordinate::SetCoordinateSystemToNormalizedViewport (  )  [inline]

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

Definition at line 89 of file vtkCoordinate.h.

void vtkCoordinate::SetCoordinateSystemToView (  )  [inline]

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

Definition at line 91 of file vtkCoordinate.h.

void vtkCoordinate::SetCoordinateSystemToWorld (  )  [inline]

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

Definition at line 92 of file vtkCoordinate.h.

const char* vtkCoordinate::GetCoordinateSystemAsString (  ) 

virtual void vtkCoordinate::SetValue ( double  ,
double  ,
double   
) [virtual]

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 ( double  [3]  )  [virtual]

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

virtual double* vtkCoordinate::GetValue (  )  [virtual]

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::GetValue ( double &  ,
double &  ,
double &   
) [virtual]

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::GetValue ( double  [3]  )  [virtual]

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

void vtkCoordinate::SetValue ( double  a,
double  b 
) [inline]

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

Definition at line 102 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]

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.

void vtkCoordinate::SetViewport ( vtkViewport viewport  ) 

If you want this coordinate to be relative to a specific vtkViewport (vtkRenderer) then you can specify that here. NOTE: this is a raw pointer, not a weak pointer not a reference counted object to avoid reference cycle loop between rendering classes and filter classes.

virtual vtkViewport* vtkCoordinate::GetViewport (  )  [virtual]

If you want this coordinate to be relative to a specific vtkViewport (vtkRenderer) then you can specify that here. NOTE: this is a raw pointer, not a weak pointer not a reference counted object to avoid reference cycle loop between rendering classes and filter classes.

double* vtkCoordinate::GetComputedWorldValue ( vtkViewport  ) 

Return the computed value in a specified coordinate system.

int* vtkCoordinate::GetComputedViewportValue ( vtkViewport  ) 

Return the computed value in a specified coordinate system.

int* vtkCoordinate::GetComputedDisplayValue ( vtkViewport  ) 

Return the computed value in a specified coordinate system.

int* vtkCoordinate::GetComputedLocalDisplayValue ( vtkViewport  ) 

Return the computed value in a specified coordinate system.

double* vtkCoordinate::GetComputedDoubleViewportValue ( vtkViewport  ) 

double* vtkCoordinate::GetComputedDoubleDisplayValue ( vtkViewport  ) 

double* 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 double* 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 144 of file vtkCoordinate.h.


Member Data Documentation

double vtkCoordinate::Value[3] [protected]

Definition at line 152 of file vtkCoordinate.h.

Definition at line 153 of file vtkCoordinate.h.

Definition at line 154 of file vtkCoordinate.h.

Definition at line 155 of file vtkCoordinate.h.

double vtkCoordinate::ComputedWorldValue[3] [protected]

Definition at line 156 of file vtkCoordinate.h.

Definition at line 157 of file vtkCoordinate.h.

Definition at line 158 of file vtkCoordinate.h.

int vtkCoordinate::Computing [protected]

Definition at line 159 of file vtkCoordinate.h.

Definition at line 161 of file vtkCoordinate.h.

Definition at line 162 of file vtkCoordinate.h.

Definition at line 163 of file vtkCoordinate.h.


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

Generated on Wed Aug 24 11:32:30 2011 for VTK by  doxygen 1.5.6