vtkGeoProjection Class Reference

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 Member Functions
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkGeoProjection *	NewInstance () const
int	GetIndex ()
	Return the index of the current projection's type in the list of all projection types.
const char *	GetDescription ()
	Get the description of a projection.
projPJ	GetProjection ()
	Return a pointer to the PROJ.4 data structure describing this projection.
void	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	RemoveOptionalParameter (const char *)
	Remove an optional parameter to the projection that will be computed.
int	GetNumberOfOptionalParameters ()
	Return the number of optional parameters.
const char *	GetOptionalParameterKey (int index)
	Return the number of optional parameters.
const char *	GetOptionalParameterValue (int index)
	Return the number of optional parameters.
void	ClearOptionalParameters ()
	Clear all optional parameters.
virtual void	SetName (const char *)
	Set/get the short name describing the projection you wish to use.
virtual char *	GetName ()
	Set/get the short name describing the projection you wish to use.
virtual void	SetCentralMeridian (double)
	Set/get the longitude which corresponds to the central meridian of the projection.
virtual double	GetCentralMeridian ()
	Set/get the longitude which corresponds to the central meridian of the projection.
virtual void	SetPROJ4String (const char *)
	Set/Get/Clear projection string in PROJ.4 format.
virtual char *	GetPROJ4String ()
	Set/Get/Clear projection string in PROJ.4 format.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkGeoProjection *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkGeoProjection *	SafeDownCast (vtkObjectBase *o)
static int	GetNumberOfProjections ()
	Returns the number of projections that this class offers.
static const char *	GetProjectionName (int projection)
	Returns the name of one of the projections supported by this class.
static const char *	GetProjectionDescription (int projection)
	Returns a description of one of the projections supported by this class.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGeoProjection ()
	~vtkGeoProjection () override
virtual int	UpdateProjection ()
	Determine whether the current projection structure has any changes pending and apply them if necessary.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
char *	Name
double	CentralMeridian
projPJ	Projection
vtkMTimeType	ProjectionMTime
char *	PROJ4String
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Represent a projection from a sphere to a plane.

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

Definition at line 39 of file vtkGeoProjection.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkGeoProjection::Superclass

Definition at line 44 of file vtkGeoProjection.h.

Constructor & Destructor Documentation

vtkGeoProjection()

vtkGeoProjection::vtkGeoProjection ( )

protected

~vtkGeoProjection()

vtkGeoProjection::~vtkGeoProjection ( )

overrideprotected

Member Function Documentation

New()

static vtkGeoProjection * vtkGeoProjection::New ( )

static

PrintSelf()

void vtkGeoProjection::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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.

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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 vtkObjectBase.

SafeDownCast()

static vtkGeoProjection * vtkGeoProjection::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkGeoProjection::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkGeoProjection * vtkGeoProjection::NewInstance

(

)

const

GetNumberOfProjections()

static int vtkGeoProjection::GetNumberOfProjections ( )

static

Returns the number of projections that this class offers.

GetProjectionName()

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()[.

GetProjectionDescription()

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()[.

SetName()

virtual void vtkGeoProjection::SetName ( const char *  )

virtual

Set/get the short name describing the projection you wish to use.

This defaults to "latlong". To get a list of valid values, use the GetNumberOfProjections() and GetProjectionName(int) static methods.

GetName()

virtual char * vtkGeoProjection::GetName ( )

virtual

Set/get the short name describing the projection you wish to use.

This defaults to "latlong". To get a list of valid values, use the GetNumberOfProjections() and GetProjectionName(int) static methods.

GetIndex()

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()[.

GetDescription()

const char * vtkGeoProjection::GetDescription

(

)

Get the description of a projection.

This will return nullptr if the projection name is invalid.

SetCentralMeridian()

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.

GetCentralMeridian()

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.

GetProjection()

projPJ vtkGeoProjection::GetProjection

(

)

Return a pointer to the PROJ.4 data structure describing this projection.

This may return nullptr 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.

SetOptionalParameter()

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.

RemoveOptionalParameter()

void vtkGeoProjection::RemoveOptionalParameter

(

const char *

)

Remove an optional parameter to the projection that will be computed.

GetNumberOfOptionalParameters()

int vtkGeoProjection::GetNumberOfOptionalParameters

(

)

Return the number of optional parameters.

GetOptionalParameterKey()

const char * vtkGeoProjection::GetOptionalParameterKey

(

int

index

)

Return the number of optional parameters.

GetOptionalParameterValue()

const char * vtkGeoProjection::GetOptionalParameterValue

(

int

index

)

Return the number of optional parameters.

ClearOptionalParameters()

void vtkGeoProjection::ClearOptionalParameters

(

)

Clear all optional parameters.

SetPROJ4String()

virtual void vtkGeoProjection::SetPROJ4String ( const char *  )

virtual

Set/Get/Clear projection string in PROJ.4 format.

This is a special case alternative to setting the projection name and specifying parameters.

Note

If the PROJ4String is not empty, it supercedes the other parameters and is used explicitly to instantiate the projPJ projection object.

GetPROJ4String()

virtual char * vtkGeoProjection::GetPROJ4String ( )

virtual

Set/Get/Clear projection string in PROJ.4 format.

This is a special case alternative to setting the projection name and specifying parameters.

Note

If the PROJ4String is not empty, it supercedes the other parameters and is used explicitly to instantiate the projPJ projection object.

UpdateProjection()

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

Name

char* vtkGeoProjection::Name

protected

Definition at line 162 of file vtkGeoProjection.h.

CentralMeridian

double vtkGeoProjection::CentralMeridian

protected

Definition at line 163 of file vtkGeoProjection.h.

Projection

projPJ vtkGeoProjection::Projection

protected

Definition at line 164 of file vtkGeoProjection.h.

ProjectionMTime

vtkMTimeType vtkGeoProjection::ProjectionMTime

protected

Definition at line 165 of file vtkGeoProjection.h.

PROJ4String

char* vtkGeoProjection::PROJ4String

protected

Definition at line 166 of file vtkGeoProjection.h.

---

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

• Geovis/Core/vtkGeoProjection.h