Represent a projection from a sphere to a plane. More...

#include <vtkGeoProjection.h>

Inheritance diagram for vtkGeoProjection:

Collaboration diagram for vtkGeoProjection:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	IsA (const char *type)

vtkGeoProjection *	NewInstance () const

int	GetIndex ()

const char *	GetDescription ()

PROJ *	GetProjection ()

void	SetOptionalParameter (const char key, const char value)

void	RemoveOptionalParameter (const char *)

int	GetNumberOfOptionalParameters ()

const char *	GetOptionalParameterKey (int index)

const char *	GetOptionalParameterValue (int index)

void	ClearOptionalParameters ()


virtual void	SetName (const char *)

virtual char *	GetName ()


virtual void	SetCentralMeridian (double)

virtual double	GetCentralMeridian ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkGeoProjection *	New ()

static int	IsTypeOf (const char *type)

static vtkGeoProjection *	SafeDownCast (vtkObjectBase *o)

static int	GetNumberOfProjections ()

static const char *	GetProjectionName (int projection)

static const char *	GetProjectionDescription (int projection)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkGeoProjection ()

virtual	~vtkGeoProjection ()

virtual int	UpdateProjection ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	Name

double	CentralMeridian

PROJ *	Projection

vtkTimeStamp	ProjectionMTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 40 of file vtkGeoProjection.h.

Member Typedef Documentation

typedef vtkObject vtkGeoProjection::Superclass

Definition at line 45 of file vtkGeoProjection.h.

Constructor & Destructor Documentation

vtkGeoProjection::vtkGeoProjection ( )

protected

virtual vtkGeoProjection::~vtkGeoProjection ( )

protectedvirtual

Member Function Documentation

static vtkGeoProjection* vtkGeoProjection::New ( )

static

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.

static int vtkGeoProjection::IsTypeOf ( const char * type )

static

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkGeoProjection::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkGeoProjection* vtkGeoProjection::NewInstance ( ) const

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.

void vtkGeoProjection::SetOptionalParameter	(	const char *	key,
		const char *	value
	)

Add an optional parameter to the projection that will be computed or replace it if already present.

void vtkGeoProjection::RemoveOptionalParameter ( const char * )

Remove an optional parameter to the projection that will be computed

int vtkGeoProjection::GetNumberOfOptionalParameters ( )

Return the number of optional parameters

const char* vtkGeoProjection::GetOptionalParameterKey ( int index )

Return the number of optional parameters

const char* vtkGeoProjection::GetOptionalParameterValue ( int index )

Return the number of optional parameters

void vtkGeoProjection::ClearOptionalParameters ( )

Clear all optional parameters

virtual int vtkGeoProjection::UpdateProjection ( )

protectedvirtual

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.

Member Data Documentation

char* vtkGeoProjection::Name

protected

Definition at line 123 of file vtkGeoProjection.h.

double vtkGeoProjection::CentralMeridian

protected

Definition at line 124 of file vtkGeoProjection.h.

PROJ* vtkGeoProjection::Projection

protected

Definition at line 125 of file vtkGeoProjection.h.

vtkTimeStamp vtkGeoProjection::ProjectionMTime

protected

Definition at line 126 of file vtkGeoProjection.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Geovis/Core/vtkGeoProjection.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation