VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkGeoTerrain Class Reference

A 3D terrain model for the globe. More...

#include <vtkGeoTerrain.h>

Inheritance diagram for vtkGeoTerrain:
[legend]
Collaboration diagram for vtkGeoTerrain:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkGeoTerrainNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkGeoSourceGetSource ()
 The source used to obtain geometry patches. More...
 
virtual void SetSource (vtkGeoSource *source)
 
void SaveDatabase (const char *path, int depth)
 Save the set of patches up to a given maximum depth. More...
 
void AddActors (vtkRenderer *ren, vtkAssembly *assembly, vtkCollection *imageReps)
 Update the actors in an assembly used to render the globe. More...
 
virtual void SetOrigin (double, double, double)
 The world-coordinate origin offset used to eliminate precision errors when zoomed in to a particular region of the globe. More...
 
virtual void SetOrigin (double[3])
 
virtual doubleGetOrigin ()
 
virtual void GetOrigin (double &, double &, double &)
 
virtual void GetOrigin (double[3])
 
virtual void SetMaxLevel (int)
 The maximum level of the terrain tree. More...
 
virtual int GetMaxLevel ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkGeoTerrainNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGeoTerrainSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGeoTerrain ()
 
 ~vtkGeoTerrain () override
 
virtual void SetGeoSource (vtkGeoSource *source)
 
void Initialize ()
 Initialize the terrain with a new source. More...
 
virtual void InitializeNodeAnalysis (vtkRenderer *ren)
 AddActors() calls this to setup parameters for evaluating nodes. More...
 
virtual bool NodeInViewport (vtkGeoTerrainNode *node)
 AddActors() calls this to determine if a node is in the current viewport. More...
 
virtual int EvaluateNode (vtkGeoTerrainNode *node)
 AddActors() calls to to evaluate whether a node should be refined (1), coarsened (-1), or remain at the same level (0). More...
 
void PrintTree (ostream &os, vtkIndent indent, vtkGeoTerrainNode *node)
 Print the tree of terrain nodes. More...
 
virtual void SetGeoCamera (vtkGeoCamera *camera)
 
- 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. More...
 
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

vtkGeoSourceGeoSource
 
vtkGeoTerrainNodeRoot
 
vtkGeoTreeNodeCacheCache
 
double Origin [3]
 
vtkExtractSelectedFrustumExtractor
 
vtkGeoCameraGeoCamera
 
int MaxLevel
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A 3D terrain model for the globe.

vtkGeoTerrain contains a multi-resolution tree of geometry representing the globe. It uses a vtkGeoSource subclass to generate the terrain, such as vtkGeoGlobeSource. This source must be set before using the terrain in a vtkGeoView. The terrain also contains an AddActors() method which will update the set of actors representing the globe given the current camera position.

Definition at line 49 of file vtkGeoTerrain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 53 of file vtkGeoTerrain.h.

Constructor & Destructor Documentation

◆ vtkGeoTerrain()

vtkGeoTerrain::vtkGeoTerrain ( )
protected

◆ ~vtkGeoTerrain()

vtkGeoTerrain::~vtkGeoTerrain ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGeoTerrain* vtkGeoTerrain::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkGeoTerrain::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.

Reimplemented in vtkGeoTerrain2D.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGeoTerrain::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkGeoTerrain2D.

◆ NewInstance()

vtkGeoTerrain* vtkGeoTerrain::NewInstance ( ) const

◆ PrintSelf()

void vtkGeoTerrain::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.

Reimplemented in vtkGeoTerrain2D.

◆ GetSource()

virtual vtkGeoSource* vtkGeoTerrain::GetSource ( )
inlinevirtual

The source used to obtain geometry patches.

Definition at line 59 of file vtkGeoTerrain.h.

◆ SetSource()

virtual void vtkGeoTerrain::SetSource ( vtkGeoSource source)
virtual

◆ SaveDatabase()

void vtkGeoTerrain::SaveDatabase ( const char *  path,
int  depth 
)

Save the set of patches up to a given maximum depth.

◆ AddActors()

void vtkGeoTerrain::AddActors ( vtkRenderer ren,
vtkAssembly assembly,
vtkCollection imageReps 
)

Update the actors in an assembly used to render the globe.

ren is the current renderer, and imageReps holds the collection of vtkGeoAlignedImageRepresentations that will be blended together to form the image on the globe.

◆ SetOrigin() [1/2]

virtual void vtkGeoTerrain::SetOrigin ( double  ,
double  ,
double   
)
virtual

The world-coordinate origin offset used to eliminate precision errors when zoomed in to a particular region of the globe.

◆ SetOrigin() [2/2]

virtual void vtkGeoTerrain::SetOrigin ( double  [3])
virtual

◆ GetOrigin() [1/3]

virtual double* vtkGeoTerrain::GetOrigin ( )
virtual

◆ GetOrigin() [2/3]

virtual void vtkGeoTerrain::GetOrigin ( double ,
double ,
double  
)
virtual

◆ GetOrigin() [3/3]

virtual void vtkGeoTerrain::GetOrigin ( double  [3])
virtual

◆ SetMaxLevel()

virtual void vtkGeoTerrain::SetMaxLevel ( int  )
virtual

The maximum level of the terrain tree.

◆ GetMaxLevel()

virtual int vtkGeoTerrain::GetMaxLevel ( )
virtual

◆ SetGeoSource()

virtual void vtkGeoTerrain::SetGeoSource ( vtkGeoSource source)
protectedvirtual

◆ Initialize()

void vtkGeoTerrain::Initialize ( )
protected

Initialize the terrain with a new source.

◆ InitializeNodeAnalysis()

virtual void vtkGeoTerrain::InitializeNodeAnalysis ( vtkRenderer ren)
protectedvirtual

AddActors() calls this to setup parameters for evaluating nodes.

Reimplemented in vtkGeoTerrain2D.

◆ NodeInViewport()

virtual bool vtkGeoTerrain::NodeInViewport ( vtkGeoTerrainNode node)
protectedvirtual

AddActors() calls this to determine if a node is in the current viewport.

Reimplemented in vtkGeoTerrain2D.

◆ EvaluateNode()

virtual int vtkGeoTerrain::EvaluateNode ( vtkGeoTerrainNode node)
protectedvirtual

AddActors() calls to to evaluate whether a node should be refined (1), coarsened (-1), or remain at the same level (0).

Reimplemented in vtkGeoTerrain2D.

◆ PrintTree()

void vtkGeoTerrain::PrintTree ( ostream &  os,
vtkIndent  indent,
vtkGeoTerrainNode node 
)
protected

Print the tree of terrain nodes.

◆ SetGeoCamera()

virtual void vtkGeoTerrain::SetGeoCamera ( vtkGeoCamera camera)
protectedvirtual

Member Data Documentation

◆ GeoSource

vtkGeoSource* vtkGeoTerrain::GeoSource
protected

Definition at line 101 of file vtkGeoTerrain.h.

◆ Root

vtkGeoTerrainNode* vtkGeoTerrain::Root
protected

Definition at line 102 of file vtkGeoTerrain.h.

◆ Cache

vtkGeoTreeNodeCache* vtkGeoTerrain::Cache
protected

Definition at line 103 of file vtkGeoTerrain.h.

◆ Origin

double vtkGeoTerrain::Origin[3]
protected

Definition at line 132 of file vtkGeoTerrain.h.

◆ Extractor

vtkExtractSelectedFrustum* vtkGeoTerrain::Extractor
protected

Definition at line 133 of file vtkGeoTerrain.h.

◆ GeoCamera

vtkGeoCamera* vtkGeoTerrain::GeoCamera
protected

Definition at line 135 of file vtkGeoTerrain.h.

◆ MaxLevel

int vtkGeoTerrain::MaxLevel
protected

Definition at line 136 of file vtkGeoTerrain.h.


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