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

Geo interface to a camera. More...

#include <vtkGeoCamera.h>

Inheritance diagram for vtkGeoCamera:
[legend]
Collaboration diagram for vtkGeoCamera:
[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...
 
vtkGeoCameraNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual doubleGetPosition ()
 Get the world position without the origin shift. More...
 
virtual void GetPosition (double &, double &, double &)
 
virtual void GetPosition (double[3])
 
void SetLongitude (double longitude)
 Longitude is in degrees: (-180->180) Relative to absolute coordinates. More...
 
virtual double GetLongitude ()
 
void SetLatitude (double latitude)
 Latitude is in degrees: (-90->90) Relative to Longitude. More...
 
virtual double GetLatitude ()
 
void SetDistance (double Distance)
 Distance is in Meters Relative to Longitude and Latitude. More...
 
virtual double GetDistance ()
 
void SetHeading (double heading)
 Heading is in degrees: (-180->180) Relative to Longitude and Latitude. More...
 
virtual double GetHeading ()
 
void SetTilt (double tilt)
 Tilt is also know as pitch. More...
 
virtual double GetTilt ()
 
vtkCameraGetVTKCamera ()
 This vtk camera is updated to match this geo cameras state. More...
 
void InitializeNodeAnalysis (int rendererSize[2])
 We precompute some values to speed up update of the terrain. More...
 
double GetNodeCoverage (vtkGeoTerrainNode *node)
 This method estimates how much of the view is covered by the sphere. More...
 
virtual bool GetLockHeading ()
 Whether to lock the heading a particular value, or to let the heading "roam free" when performing latitude and longitude changes. More...
 
virtual void SetLockHeading (bool)
 
virtual void LockHeadingOn ()
 
virtual void LockHeadingOff ()
 
void SetOriginLatitude (double oLat)
 This point is shifted to 0,0,0 to avoid openGL issues. More...
 
virtual double GetOriginLatitude ()
 
void SetOriginLongitude (double oLat)
 
virtual double GetOriginLongitude ()
 
virtual doubleGetOrigin ()
 Get the rectilinear cooridinate location of the origin. More...
 
virtual void GetOrigin (double &, double &, double &)
 
virtual void GetOrigin (double[3])
 
void SetOrigin (double ox, double oy, double oz)
 
- 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 vtkGeoCameraNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGeoCameraSafeDownCast (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
 
 vtkGeoCamera ()
 
 ~vtkGeoCamera () override
 
void UpdateVTKCamera ()
 
void UpdateAngleRanges ()
 
void ComputeRectilinearOrigin ()
 
- 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

vtkSmartPointer< vtkCameraVTKCamera
 
vtkSmartPointer< vtkTransformTransform
 
double OriginLatitude
 
double OriginLongitude
 
double Origin [3]
 
double Longitude
 
double Latitude
 
double Distance
 
double Heading
 
double Tilt
 
bool LockHeading
 
double ForwardNormal [3]
 
double RightNormal [3]
 
double UpNormal [3]
 
double Aspect [2]
 
double LeftPlaneNormal [3]
 
double RightPlaneNormal [3]
 
double DownPlaneNormal [3]
 
double UpPlaneNormal [3]
 
double Position [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Geo interface to a camera.

I wanted to hide the normal vtkCamera API so I did not make this a subclass. The camera is a helper object. You can get a pointer to the camera, but it should be treated like a const.

View up of the camera is restricted so there is no roll relative to the earth. I am going to keep view up of the camera orthogonalized to avoid the singularity that exists when the camera is pointing straight down. In this case, view up is the same as heading.

The state of the view is specified by the vector: (Longitude,Latitude,Distance,Heading,Tilt). Longitude in degrees: (-180->180) Relative to absolute coordinates. Latitude in degrees: (-90->90) Relative to Longitude. Distance in Meters Relative to Longitude and Latitude. above sea level ???? should we make this from center of earth ???? ???? what about equatorial bulge ???? Heading in degrees: (-180->180) Relative to Longitude and Latitude. 0 is north. 90 is east. ???? what is the standard ???? 180 is south. -90 is west. Tilt in degrees: (0->90) Relative to Longitude, Latitude, Distance and Heading.

Transformation: Post concatenate. All rotations use right hand rule and are around (0,0,0) (earth center). (0,0,0,0,0) is this rectilinear point (0, EarthRadius, 0) pointing (0,0,1), view up (0,1,0).

Rotate Tilt around x axis, Rotate Heading around -y axis Center, Translate EarthRadius in y direction. Rotate Latitude around x axis by Latitude, Rotate Longitude around z axis (earth axis),

See also
vtkGeoInteractorStyle vtkCamera

Definition at line 84 of file vtkGeoCamera.h.

Member Typedef Documentation

◆ Superclass

Definition at line 88 of file vtkGeoCamera.h.

Constructor & Destructor Documentation

◆ vtkGeoCamera()

vtkGeoCamera::vtkGeoCamera ( )
protected

◆ ~vtkGeoCamera()

vtkGeoCamera::~vtkGeoCamera ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGeoCamera* vtkGeoCamera::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkGeoCamera::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 vtkGeoCamera* vtkGeoCamera::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGeoCamera::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkGeoCamera* vtkGeoCamera::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetPosition() [1/3]

virtual double* vtkGeoCamera::GetPosition ( )
virtual

Get the world position without the origin shift.

◆ GetPosition() [2/3]

virtual void vtkGeoCamera::GetPosition ( double ,
double ,
double  
)
virtual

◆ GetPosition() [3/3]

virtual void vtkGeoCamera::GetPosition ( double  [3])
virtual

◆ SetLongitude()

void vtkGeoCamera::SetLongitude ( double  longitude)

Longitude is in degrees: (-180->180) Relative to absolute coordinates.

Rotate Longitude around z axis (earth axis),

◆ GetLongitude()

virtual double vtkGeoCamera::GetLongitude ( )
virtual

◆ SetLatitude()

void vtkGeoCamera::SetLatitude ( double  latitude)

Latitude is in degrees: (-90->90) Relative to Longitude.

Rotate Latitude around x axis by Latitude,

◆ GetLatitude()

virtual double vtkGeoCamera::GetLatitude ( )
virtual

◆ SetDistance()

void vtkGeoCamera::SetDistance ( double  Distance)

Distance is in Meters Relative to Longitude and Latitude.

above sea level ???? should we make this from center of earth ???? ???? what about equatorial bulge ????

◆ GetDistance()

virtual double vtkGeoCamera::GetDistance ( )
virtual

◆ SetHeading()

void vtkGeoCamera::SetHeading ( double  heading)

Heading is in degrees: (-180->180) Relative to Longitude and Latitude.

0 is north. 90 is east. ???? what is the standard ???? 180 is south. -90 is west. Rotate Heading around -y axis Center,

◆ GetHeading()

virtual double vtkGeoCamera::GetHeading ( )
virtual

◆ SetTilt()

void vtkGeoCamera::SetTilt ( double  tilt)

Tilt is also know as pitch.

Tilt is in degrees: (0->90) Relative to Longitude, Latitude, and Heading. Rotate Tilt around x axis,

◆ GetTilt()

virtual double vtkGeoCamera::GetTilt ( )
virtual

◆ GetVTKCamera()

vtkCamera* vtkGeoCamera::GetVTKCamera ( )

This vtk camera is updated to match this geo cameras state.

It should be treated as a const and should not be modified.

◆ InitializeNodeAnalysis()

void vtkGeoCamera::InitializeNodeAnalysis ( int  rendererSize[2])

We precompute some values to speed up update of the terrain.

Unfortunately, they have to be manually/explicitly updated when the camera or renderer size changes.

◆ GetNodeCoverage()

double vtkGeoCamera::GetNodeCoverage ( vtkGeoTerrainNode node)

This method estimates how much of the view is covered by the sphere.

Returns a value from 0 to 1.

◆ GetLockHeading()

virtual bool vtkGeoCamera::GetLockHeading ( )
virtual

Whether to lock the heading a particular value, or to let the heading "roam free" when performing latitude and longitude changes.

◆ SetLockHeading()

virtual void vtkGeoCamera::SetLockHeading ( bool  )
virtual

◆ LockHeadingOn()

virtual void vtkGeoCamera::LockHeadingOn ( )
virtual

◆ LockHeadingOff()

virtual void vtkGeoCamera::LockHeadingOff ( )
virtual

◆ SetOriginLatitude()

void vtkGeoCamera::SetOriginLatitude ( double  oLat)

This point is shifted to 0,0,0 to avoid openGL issues.

◆ GetOriginLatitude()

virtual double vtkGeoCamera::GetOriginLatitude ( )
virtual

◆ SetOriginLongitude()

void vtkGeoCamera::SetOriginLongitude ( double  oLat)

◆ GetOriginLongitude()

virtual double vtkGeoCamera::GetOriginLongitude ( )
virtual

◆ GetOrigin() [1/3]

virtual double* vtkGeoCamera::GetOrigin ( )
virtual

Get the rectilinear cooridinate location of the origin.

This is used to shift the terrain points.

◆ GetOrigin() [2/3]

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

◆ GetOrigin() [3/3]

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

◆ SetOrigin()

void vtkGeoCamera::SetOrigin ( double  ox,
double  oy,
double  oz 
)
inline

Definition at line 200 of file vtkGeoCamera.h.

◆ UpdateVTKCamera()

void vtkGeoCamera::UpdateVTKCamera ( )
protected

◆ UpdateAngleRanges()

void vtkGeoCamera::UpdateAngleRanges ( )
protected

◆ ComputeRectilinearOrigin()

void vtkGeoCamera::ComputeRectilinearOrigin ( )
protected

Member Data Documentation

◆ VTKCamera

vtkSmartPointer<vtkCamera> vtkGeoCamera::VTKCamera
protected

Definition at line 213 of file vtkGeoCamera.h.

◆ Transform

vtkSmartPointer<vtkTransform> vtkGeoCamera::Transform
protected

Definition at line 214 of file vtkGeoCamera.h.

◆ OriginLatitude

double vtkGeoCamera::OriginLatitude
protected

Definition at line 217 of file vtkGeoCamera.h.

◆ OriginLongitude

double vtkGeoCamera::OriginLongitude
protected

Definition at line 218 of file vtkGeoCamera.h.

◆ Origin

double vtkGeoCamera::Origin[3]
protected

Definition at line 219 of file vtkGeoCamera.h.

◆ Longitude

double vtkGeoCamera::Longitude
protected

Definition at line 222 of file vtkGeoCamera.h.

◆ Latitude

double vtkGeoCamera::Latitude
protected

Definition at line 223 of file vtkGeoCamera.h.

◆ Distance

double vtkGeoCamera::Distance
protected

Definition at line 224 of file vtkGeoCamera.h.

◆ Heading

double vtkGeoCamera::Heading
protected

Definition at line 225 of file vtkGeoCamera.h.

◆ Tilt

double vtkGeoCamera::Tilt
protected

Definition at line 226 of file vtkGeoCamera.h.

◆ LockHeading

bool vtkGeoCamera::LockHeading
protected

Definition at line 227 of file vtkGeoCamera.h.

◆ ForwardNormal

double vtkGeoCamera::ForwardNormal[3]
protected

Definition at line 231 of file vtkGeoCamera.h.

◆ RightNormal

double vtkGeoCamera::RightNormal[3]
protected

Definition at line 232 of file vtkGeoCamera.h.

◆ UpNormal

double vtkGeoCamera::UpNormal[3]
protected

Definition at line 233 of file vtkGeoCamera.h.

◆ Aspect

double vtkGeoCamera::Aspect[2]
protected

Definition at line 234 of file vtkGeoCamera.h.

◆ LeftPlaneNormal

double vtkGeoCamera::LeftPlaneNormal[3]
protected

Definition at line 237 of file vtkGeoCamera.h.

◆ RightPlaneNormal

double vtkGeoCamera::RightPlaneNormal[3]
protected

Definition at line 238 of file vtkGeoCamera.h.

◆ DownPlaneNormal

double vtkGeoCamera::DownPlaneNormal[3]
protected

Definition at line 239 of file vtkGeoCamera.h.

◆ UpPlaneNormal

double vtkGeoCamera::UpPlaneNormal[3]
protected

Definition at line 240 of file vtkGeoCamera.h.

◆ Position

double vtkGeoCamera::Position[3]
protected

Definition at line 242 of file vtkGeoCamera.h.


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