vtkGeoSource Class Reference

A multi-resolution geographic data source. More...

#include <vtkGeoSource.h>

Inheritance diagram for vtkGeoSource:

Collaboration diagram for vtkGeoSource:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkGeoSource *	NewInstance () const
	vtkGeoSource ()
	~vtkGeoSource ()
void	Initialize (int numThreads=1)
void	ShutDown ()
void	WorkerThread ()
virtual vtkAbstractTransform *	GetTransform ()
virtual bool	FetchRoot (vtkGeoTreeNode *root)=0
virtual bool	FetchChild (vtkGeoTreeNode *node, int index, vtkGeoTreeNode *child)=0
virtual void	RequestChildren (vtkGeoTreeNode *node)
virtual vtkCollection *	GetRequestedNodes (vtkGeoTreeNode *node)
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 ()
virtual void	PrintSelf (ostream &os, vtkIndent indent)
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 int	IsTypeOf (const char *type)
static vtkGeoSource *	SafeDownCast (vtkObjectBase *o)
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
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
vtkCollection *	InputSet
vtkCollection *	ProcessingSet
vtkMutexLock *	Lock
vtkConditionVariable *	Condition
vtkMultiThreader *	Threader
bool	StopThread
bool	Initialized
implementation *	Implementation
vtkMutexLock *	InputSetLock
vtkMutexLock *	ProcessingSetLock
vtkMutexLock *	OutputSetLock
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

A multi-resolution geographic data source.

vtkGeoSource is an abstract superclass for all multi-resolution data sources shown in a geographic view like vtkGeoView or vtkGeoView2D. vtkGeoSource subclasses need to implement the FetchRoot() method, which fills a vtkGeoTreeNode with the low-res data at the root, and FetchChild(), which produces a refinement of a parent node. Other geovis classes such as vtkGeoTerrain, vtkGeoTerrain2D, and vtkGeoAlignedImageSource use a vtkGeoSource subclass to build their geometry or image caches which are stored in trees. The source itself does not maintain the tree, but simply provides a mechanism for generating refined tree nodes.

Sources are multi-threaded. Each source may have one or more worker threads associated with it, which this superclass manages. It is essential that the FetchChild() method is thread-safe, since it may be called from multiple workers simultaneously.

Tests:

vtkGeoSource (Tests)

Definition at line 56 of file vtkGeoSource.h.

Member Typedef Documentation

typedef vtkObject vtkGeoSource::Superclass

Definition at line 59 of file vtkGeoSource.h.

Constructor & Destructor Documentation

vtkGeoSource::vtkGeoSource

(

)

vtkGeoSource::~vtkGeoSource

(

)

Member Function Documentation

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

static

virtual int vtkGeoSource::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.

Reimplemented in vtkGeoAlignedImageSource, vtkGeoFileImageSource, vtkGeoFileTerrainSource, vtkGeoProjectionSource, and vtkGeoGlobeSource.

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

static

virtual vtkObjectBase* vtkGeoSource::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkGeoAlignedImageSource, vtkGeoFileImageSource, vtkGeoFileTerrainSource, vtkGeoProjectionSource, and vtkGeoGlobeSource.

vtkGeoSource* vtkGeoSource::NewInstance

(

)

const

virtual bool vtkGeoSource::FetchRoot ( vtkGeoTreeNode *  root )

pure virtual

Blocking access methods to be implemented in subclasses.

Implemented in vtkGeoAlignedImageSource, vtkGeoProjectionSource, vtkGeoFileImageSource, vtkGeoFileTerrainSource, and vtkGeoGlobeSource.

virtual bool vtkGeoSource::FetchChild ( vtkGeoTreeNode *  node, int  index, vtkGeoTreeNode *  child  )

pure virtual

Blocking access methods to be implemented in subclasses.

Implemented in vtkGeoAlignedImageSource, vtkGeoFileImageSource, vtkGeoFileTerrainSource, vtkGeoProjectionSource, and vtkGeoGlobeSource.

virtual void vtkGeoSource::RequestChildren ( vtkGeoTreeNode *  node )

virtual

Non-blocking methods for to use from the main application. After calling RequestChildren() for a certain node, GetRequestedNodes() will after a certain period of time return a non-null pointer to a collection of four vtkGeoTreeNode objects, which are the four children of the requested node. The collection is reference counted, so you need to eventually call Delete() on the returned collection pointer (if it is non-null).

virtual vtkCollection* vtkGeoSource::GetRequestedNodes ( vtkGeoTreeNode *  node )

virtual

Non-blocking methods for to use from the main application. After calling RequestChildren() for a certain node, GetRequestedNodes() will after a certain period of time return a non-null pointer to a collection of four vtkGeoTreeNode objects, which are the four children of the requested node. The collection is reference counted, so you need to eventually call Delete() on the returned collection pointer (if it is non-null).

void vtkGeoSource::Initialize

(

int

numThreads = 1

)

Spawn worker threads.

void vtkGeoSource::ShutDown

(

)

Shut down the source. This terminates the thread and releases memory.

void vtkGeoSource::WorkerThread

(

)

virtual vtkAbstractTransform* vtkGeoSource::GetTransform ( )

inlinevirtual

Return the projection transformation used by this source.

Reimplemented in vtkGeoProjectionSource.

Definition at line 91 of file vtkGeoSource.h.

Member Data Documentation

vtkCollection* vtkGeoSource::InputSet

protected

Definition at line 95 of file vtkGeoSource.h.

vtkCollection* vtkGeoSource::ProcessingSet

protected

Definition at line 96 of file vtkGeoSource.h.

vtkMutexLock* vtkGeoSource::InputSetLock

protected

Locks the set for reading or writing

Definition at line 100 of file vtkGeoSource.h.

vtkMutexLock* vtkGeoSource::ProcessingSetLock

protected

Locks the set for reading or writing

Definition at line 101 of file vtkGeoSource.h.

vtkMutexLock* vtkGeoSource::OutputSetLock

protected

Locks the set for reading or writing

Definition at line 102 of file vtkGeoSource.h.

vtkMutexLock* vtkGeoSource::Lock

protected

Definition at line 105 of file vtkGeoSource.h.

vtkConditionVariable* vtkGeoSource::Condition

protected

Definition at line 107 of file vtkGeoSource.h.

vtkMultiThreader* vtkGeoSource::Threader

protected

Definition at line 109 of file vtkGeoSource.h.

bool vtkGeoSource::StopThread

protected

Definition at line 110 of file vtkGeoSource.h.

bool vtkGeoSource::Initialized

protected

Definition at line 111 of file vtkGeoSource.h.

implementation* vtkGeoSource::Implementation

protected

Definition at line 114 of file vtkGeoSource.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/vtkGeoSource.h