vtkGeoProjection Class Reference

#include <vtkGeoProjection.h>

Inheritance diagram for vtkGeoProjection:

[legend]

Collaboration diagram for vtkGeoProjection:

[legend]

List of all members.

Detailed Description

Represent a projection from a sphere to a plane.

This class uses the PROJ.4 library to represent geographic coordinate projections.

Tests:: vtkGeoProjection (Tests)

Definition at line 39 of file vtkGeoProjection.h.


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
int	GetIndex ()
const char *	GetDescription ()
PROJ *	GetProjection ()

virtual void	SetName (const char *)
virtual char *	GetName ()

virtual void	SetCentralMeridian (double)
virtual double	GetCentralMeridian ()
Static Public Member Functions
static vtkGeoProjection *	New ()
static int	IsTypeOf (const char *type)
static vtkGeoProjection *	SafeDownCast (vtkObject *o)
static int	GetNumberOfProjections ()
static const char *	GetProjectionName (int projection)
static const char *	GetProjectionDescription (int projection)
Protected Member Functions
	vtkGeoProjection ()
virtual	~vtkGeoProjection ()
virtual int	UpdateProjection ()
Protected Attributes
char *	Name
double	CentralMeridian
PROJ *	Projection
vtkTimeStamp	ProjectionMTime

Member Typedef Documentation

typedef vtkObject vtkGeoProjection::Superclass

Reimplemented from vtkObject.

Definition at line 44 of file vtkGeoProjection.h.

Constructor & Destructor Documentation

vtkGeoProjection::vtkGeoProjection ( ) [protected]

virtual vtkGeoProjection::~vtkGeoProjection ( ) [protected, virtual]

Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual void vtkGeoProjection::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.

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

Reimplemented from vtkObject.

static int vtkGeoProjection::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 vtkGeoProjection::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 vtkGeoProjection* vtkGeoProjection::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

static int vtkGeoProjection::GetNumberOfProjections ( ) [static]

Returns the number of projections that this class offers.

static const char* vtkGeoProjection::GetProjectionName ( int projection ) [static]

Returns the name of one of the projections supported by this class. You can pass these strings to SetName(char*).

Parameters:

projection

the index of a projection, must be in [0,GetNumberOfProjections()[.

static const char* vtkGeoProjection::GetProjectionDescription ( int projection ) [static]

Returns a description of one of the projections supported by this class.

Parameters:

projection

the index of a projection, must be in [0,GetNumberOfProjections()[.

virtual void vtkGeoProjection::SetName ( const char * ) [virtual]

Set/get the short name describing the projection you wish to use. This defaults to "rpoly" for no reason other than I like it. To get a list of valid values, use the GetNumberOfProjections() and GetProjectionName(int) static methods.

virtual char* vtkGeoProjection::GetName ( ) [virtual]

Set/get the short name describing the projection you wish to use. This defaults to "rpoly" for no reason other than I like it. To get a list of valid values, use the GetNumberOfProjections() and GetProjectionName(int) static methods.

int vtkGeoProjection::GetIndex ( )

Return the index of the current projection's type in the list of all projection types. On error, this will return -1. On success, it returns a number in [0,GetNumberOfProjections()[.

const char* vtkGeoProjection::GetDescription ( )

Get the description of a projection. This will return NULL if the projection name is invalid.

virtual void vtkGeoProjection::SetCentralMeridian ( double ) [virtual]

Set/get the longitude which corresponds to the central meridian of the projection. This defaults to 0, the Greenwich Meridian.

virtual double vtkGeoProjection::GetCentralMeridian ( ) [virtual]

Set/get the longitude which corresponds to the central meridian of the projection. This defaults to 0, the Greenwich Meridian.

PROJ* vtkGeoProjection::GetProjection ( )

Return a pointer to the PROJ.4 data structure describing this projection. This may return NULL if an invalid projection name or parameter set is specified. If you invoke any methods on this vtkGeoProjection object, the PROJ.4 structure this method returns may be freed, so you should not use the PROJ.4 structure after changing any parameters. Also, you should not modify the PROJ.4 structure on your own as it will then be out of sync with the vtkGeoProjection class.

virtual int vtkGeoProjection::UpdateProjection ( ) [protected, virtual]

Determine whether the current projection structure has any changes pending and apply them if necessary. Upon success, 0 is returned. When an error occurs, a nonzero value is returned.