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

A 3D geospatial view. More...

#include <vtkGeoView.h>

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

Public Types

typedef vtkRenderView Superclass
 
- Public Types inherited from vtkRenderView
enum  { INTERACTION_MODE_2D, INTERACTION_MODE_3D, INTERACTION_MODE_UNKNOWN }
 
enum  { SURFACE = 0, FRUSTUM = 1 }
 
enum  { NO_OVERLAP, ALL }
 
enum  { FREETYPE, QT }
 
typedef vtkRenderViewBase Superclass
 
- Public Types inherited from vtkRenderViewBase
typedef vtkView Superclass
 
- Public Types inherited from vtkView
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...
 
vtkGeoViewNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkGeoAlignedImageRepresentationAddDefaultImageRepresentation (vtkImageData *image)
 Adds an image representation with a simple terrain model using the image in the specified file as the globe terrain. More...
 
void PrepareForRendering () override
 Prepares the view for rendering. More...
 
void BuildLowResEarth (double origin[3])
 Rebuild low-res earth source; call after (re)setting origin. More...
 
virtual void SetLockHeading (bool lock)
 Whether the view locks the heading when panning. More...
 
virtual bool GetLockHeading ()
 
virtual void LockHeadingOn ()
 
virtual void LockHeadingOff ()
 
vtkGeoInteractorStyleGetGeoInteractorStyle ()
 Convenience method for obtaining the internal interactor style. More...
 
virtual void SetGeoInteractorStyle (vtkGeoInteractorStyle *style)
 Method to change the interactor style. More...
 
virtual void SetTerrain (vtkGeoTerrain *terrain)
 The terrain (geometry) model for this earth view. More...
 
virtual vtkGeoTerrainGetTerrain ()
 
void Render () override
 Update and render the view. More...
 
- Public Member Functions inherited from vtkRenderView
vtkRenderViewNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetInteractor (vtkRenderWindowInteractor *interactor) override
 The render window interactor. More...
 
virtual void SetInteractorStyle (vtkInteractorObserver *style)
 The interactor style associated with the render view. More...
 
virtual vtkInteractorObserverGetInteractorStyle ()
 Get the interactor style associated with the render view. More...
 
void SetRenderWindow (vtkRenderWindow *win) override
 Set the render window for this view. More...
 
void SetInteractionMode (int mode)
 
virtual int GetInteractionMode ()
 
virtual void SetInteractionModeTo2D ()
 Set the interaction mode for the view. More...
 
virtual void SetInteractionModeTo3D ()
 
void Render () override
 Updates the representations, then calls Render() on the render window associated with this view. More...
 
void ApplyViewTheme (vtkViewTheme *theme) override
 Applies a view theme to this view. More...
 
virtual void SetTransform (vtkAbstractTransform *transform)
 Set the view's transform. More...
 
virtual vtkAbstractTransformGetTransform ()
 
virtual void SetDisplayHoverText (bool b)
 Whether the view should display hover text. More...
 
virtual bool GetDisplayHoverText ()
 
virtual void DisplayHoverTextOn ()
 
virtual void DisplayHoverTextOff ()
 
virtual void SetSelectionMode (int)
 Sets the selection mode for the render view. More...
 
virtual int GetSelectionMode ()
 
void SetSelectionModeToSurface ()
 
void SetSelectionModeToFrustum ()
 
virtual void AddLabels (vtkAlgorithmOutput *conn)
 Add labels from an input connection with an associated text property. More...
 
virtual void RemoveLabels (vtkAlgorithmOutput *conn)
 Remove labels from an input connection. More...
 
virtual void SetIconTexture (vtkTexture *texture)
 Set the icon sheet to use for rendering icons. More...
 
virtual vtkTextureGetIconTexture ()
 
virtual void SetIconSize (int, int)
 Set the size of each icon in the icon texture. More...
 
void SetIconSize (int[2])
 
virtual intGetIconSize ()
 
virtual void GetIconSize (int &, int &)
 
virtual void GetIconSize (int[2])
 
virtual void SetDisplaySize (int, int)
 Set the display size of the icon (which may be different from the icon size). More...
 
void SetDisplaySize (int[2])
 
intGetDisplaySize ()
 
void GetDisplaySize (int &dsx, int &dsy)
 
virtual void SetLabelPlacementMode (int mode)
 Label placement mode. More...
 
virtual int GetLabelPlacementMode ()
 
virtual void SetLabelPlacementModeToNoOverlap ()
 
virtual void SetLabelPlacementModeToAll ()
 
virtual void SetLabelRenderMode (int mode)
 Label render mode. More...
 
virtual int GetLabelRenderMode ()
 
virtual void SetLabelRenderModeToFreetype ()
 
virtual void SetLabelRenderModeToQt ()
 
void SetRenderOnMouseMove (bool b)
 Whether to render on every mouse move. More...
 
virtual bool GetRenderOnMouseMove ()
 
virtual void RenderOnMouseMoveOn ()
 
virtual void RenderOnMouseMoveOff ()
 
- Public Member Functions inherited from vtkRenderViewBase
vtkRenderViewBaseNewInstance () const
 
virtual vtkRendererGetRenderer ()
 Gets the renderer for this view. More...
 
virtual void SetRenderer (vtkRenderer *ren)
 
virtual vtkRenderWindowGetRenderWindow ()
 Get a handle to the render window. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 The render window interactor. More...
 
virtual void ResetCamera ()
 Updates the representations, then calls ResetCamera() on the renderer associated with this view. More...
 
virtual void ResetCameraClippingRange ()
 Updates the representations, then calls ResetCameraClippingRange() on the renderer associated with this view. More...
 
- Public Member Functions inherited from vtkView
vtkViewNewInstance () const
 
void AddRepresentation (vtkDataRepresentation *rep)
 Adds the representation to the view. More...
 
void SetRepresentation (vtkDataRepresentation *rep)
 Set the representation to the view. More...
 
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 Convenience method which creates a simple representation with the connection and adds it to the view. More...
 
vtkDataRepresentationSetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 Convenience method which sets the representation with the connection and adds it to the view. More...
 
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
 Convenience method which creates a simple representation with the specified input and adds it to the view. More...
 
vtkDataRepresentationSetRepresentationFromInput (vtkDataObject *input)
 Convenience method which sets the representation to the specified input and adds it to the view. More...
 
void RemoveRepresentation (vtkDataRepresentation *rep)
 Removes the representation from the view. More...
 
void RemoveRepresentation (vtkAlgorithmOutput *rep)
 Removes any representation with this connection from the view. More...
 
void RemoveAllRepresentations ()
 Removes all representations from the view. More...
 
int GetNumberOfRepresentations ()
 Returns the number of representations from first port(0) in this view. More...
 
vtkDataRepresentationGetRepresentation (int index=0)
 The representation at a specified index. More...
 
bool IsRepresentationPresent (vtkDataRepresentation *rep)
 Check to see if a representation is present in the view. More...
 
virtual void Update ()
 Update the view. More...
 
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
 Apply a theme to the view. More...
 
vtkCommandGetObserver ()
 Returns the observer that the subclasses can use to listen to additional events. More...
 
void RegisterProgress (vtkObject *algorithm, const char *message=nullptr)
 Meant for use by subclasses and vtkRepresentation subclasses. More...
 
void UnRegisterProgress (vtkObject *algorithm)
 Unregister objects previously registered with RegisterProgress. More...
 
- 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 vtkGeoViewNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGeoViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderView
static vtkRenderViewNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderViewBase
static vtkRenderViewBaseNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderViewBaseSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkView
static vtkViewNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkViewSafeDownCast (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
 
 vtkGeoView ()
 
 ~vtkGeoView () override
 
- Protected Member Functions inherited from vtkRenderView
 vtkRenderView ()
 
 ~vtkRenderView () override
 
void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData) override
 Called to process events. More...
 
virtual void GenerateSelection (void *callData, vtkSelection *selection)
 Generates the selection based on the view event and the selection mode. More...
 
void PrepareForRendering () override
 Called by the view when the renderer is about to render. More...
 
virtual void UpdateHoverText ()
 Called in PrepareForRendering to update the hover text. More...
 
virtual void UpdateHoverWidgetState ()
 Enable or disable hovering based on DisplayHoverText ivar and interaction state. More...
 
void UpdatePickRender ()
 Update the pick render for queries for drag selections or hover ballooons. More...
 
- Protected Member Functions inherited from vtkRenderViewBase
 vtkRenderViewBase ()
 
 ~vtkRenderViewBase () override
 
- Protected Member Functions inherited from vtkView
 vtkView ()
 
 ~vtkView () override
 
virtual vtkDataRepresentationCreateDefaultRepresentation (vtkAlgorithmOutput *conn)
 Create a default vtkDataRepresentation for the given vtkAlgorithmOutput. More...
 
virtual void AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed. More...
 
virtual void RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 
virtual void SetReuseSingleRepresentation (bool)
 True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. More...
 
virtual bool GetReuseSingleRepresentation ()
 
virtual void ReuseSingleRepresentationOn ()
 
virtual void ReuseSingleRepresentationOff ()
 
- 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

vtkGlobeSourceLowResEarthSource
 
vtkPolyDataMapperLowResEarthMapper
 
vtkActorLowResEarthActor
 
vtkAssemblyAssembly
 
vtkGeoTerrainTerrain
 
int UsingMesaDrivers
 
- Protected Attributes inherited from vtkRenderView
int SelectionMode
 
int LabelRenderMode
 
bool DisplayHoverText
 
bool Interacting
 
bool InHoverTextRender
 
bool InPickRender
 
bool PickRenderNeedsUpdate
 
vtkAbstractTransformTransform
 
vtkTextureIconTexture
 
int IconSize [2]
 
int DisplaySize [2]
 
int InteractionMode
 
bool RenderOnMouseMove
 
vtkSmartPointer< vtkRendererLabelRenderer
 
vtkSmartPointer< vtkBalloonRepresentationBalloon
 
vtkSmartPointer< vtkLabelPlacementMapperLabelPlacementMapper
 
vtkSmartPointer< vtkTexturedActor2DLabelActor
 
vtkSmartPointer< vtkHoverWidgetHoverWidget
 
vtkSmartPointer< vtkHardwareSelectorSelector
 
- Protected Attributes inherited from vtkRenderViewBase
vtkSmartPointer< vtkRendererRenderer
 
vtkSmartPointer< vtkRenderWindowRenderWindow
 
- Protected Attributes inherited from vtkView
bool ReuseSingleRepresentation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A 3D geospatial view.

vtkGeoView is a 3D globe view. The globe may contain a multi-resolution geometry source (vtkGeoTerrain), multiple multi-resolution image sources (vtkGeoAlignedImageRepresentation), as well as other representations such as vtkRenderedGraphRepresentation. At a minimum, the view must have a terrain and one image representation. The view uses vtkGeoInteractorStyle to orbit, zoom, and tilt the view, and contains a vtkCompassWidget for manipulating the camera.

Each terrain or image representation contains a vtkGeoSource subclass which generates geometry or imagery at multiple resolutions. As the camera position changes, the terrain and/or image representations may ask its vtkGeoSource to refine the geometry. This refinement is performed on a separate thread, and the data is added to the view when it becomes available.

See also
vtkGeoTerrain vtkGeoAlignedImageRepresentation vtkGeoSource
Examples:
vtkGeoView (Examples)

Definition at line 63 of file vtkGeoView.h.

Member Typedef Documentation

◆ Superclass

Definition at line 67 of file vtkGeoView.h.

Constructor & Destructor Documentation

◆ vtkGeoView()

vtkGeoView::vtkGeoView ( )
protected

◆ ~vtkGeoView()

vtkGeoView::~vtkGeoView ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGeoView* vtkGeoView::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGeoView::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRenderView.

◆ NewInstance()

vtkGeoView* vtkGeoView::NewInstance ( ) const

◆ PrintSelf()

void vtkGeoView::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 vtkRenderViewBase.

◆ AddDefaultImageRepresentation()

vtkGeoAlignedImageRepresentation* vtkGeoView::AddDefaultImageRepresentation ( vtkImageData image)

Adds an image representation with a simple terrain model using the image in the specified file as the globe terrain.

◆ PrepareForRendering()

void vtkGeoView::PrepareForRendering ( )
overridevirtual

Prepares the view for rendering.

Reimplemented from vtkRenderViewBase.

◆ BuildLowResEarth()

void vtkGeoView::BuildLowResEarth ( double  origin[3])

Rebuild low-res earth source; call after (re)setting origin.

◆ SetLockHeading()

virtual void vtkGeoView::SetLockHeading ( bool  lock)
virtual

Whether the view locks the heading when panning.

Default is off.

◆ GetLockHeading()

virtual bool vtkGeoView::GetLockHeading ( )
virtual

◆ LockHeadingOn()

virtual void vtkGeoView::LockHeadingOn ( )
virtual

◆ LockHeadingOff()

virtual void vtkGeoView::LockHeadingOff ( )
virtual

◆ GetGeoInteractorStyle()

vtkGeoInteractorStyle* vtkGeoView::GetGeoInteractorStyle ( )

Convenience method for obtaining the internal interactor style.

◆ SetGeoInteractorStyle()

virtual void vtkGeoView::SetGeoInteractorStyle ( vtkGeoInteractorStyle style)
virtual

Method to change the interactor style.

◆ SetTerrain()

virtual void vtkGeoView::SetTerrain ( vtkGeoTerrain terrain)
virtual

The terrain (geometry) model for this earth view.

◆ GetTerrain()

virtual vtkGeoTerrain* vtkGeoView::GetTerrain ( )
virtual

◆ Render()

void vtkGeoView::Render ( )
overridevirtual

Update and render the view.

Reimplemented from vtkRenderViewBase.

Member Data Documentation

◆ LowResEarthSource

vtkGlobeSource* vtkGeoView::LowResEarthSource
protected

Definition at line 123 of file vtkGeoView.h.

◆ LowResEarthMapper

vtkPolyDataMapper* vtkGeoView::LowResEarthMapper
protected

Definition at line 124 of file vtkGeoView.h.

◆ LowResEarthActor

vtkActor* vtkGeoView::LowResEarthActor
protected

Definition at line 125 of file vtkGeoView.h.

◆ Assembly

vtkAssembly* vtkGeoView::Assembly
protected

Definition at line 126 of file vtkGeoView.h.

◆ Terrain

vtkGeoTerrain* vtkGeoView::Terrain
protected

Definition at line 127 of file vtkGeoView.h.

◆ UsingMesaDrivers

int vtkGeoView::UsingMesaDrivers
protected

Definition at line 129 of file vtkGeoView.h.


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