FlightGear next
FGTerrain Class Referenceabstract

#include <terrain.hxx>

Inherited by FGPgtTerrain, and FGStgTerrain.

Public Member Functions

 FGTerrain ()=default
 
virtual ~FGTerrain ()=default
 
virtual void init (osg::Group *terrain)=0
 
virtual void reinit ()=0
 
virtual void shutdown ()=0
 
virtual void bind ()=0
 
virtual void unbind ()=0
 
virtual void update (double dt)=0
 
virtual bool get_elevation_m (const SGGeod &geod, double &alt, const simgear::BVHMaterial **material, const osg::Node *butNotFrom=0)=0
 Compute the elevation of the scenery at geodetic latitude lat, geodetic longitude lon and not higher than max_alt.
 
virtual bool get_cart_elevation_m (const SGVec3d &pos, double max_altoff, double &elevation, const simgear::BVHMaterial **material, const osg::Node *butNotFrom=0)=0
 Compute the elevation of the scenery below the cartesian point pos.
 
virtual bool get_cart_ground_intersection (const SGVec3d &start, const SGVec3d &dir, SGVec3d &nearestHit, const osg::Node *butNotFrom=0)=0
 Compute the nearest intersection point of the line starting from start going in direction dir with the terrain.
 
virtual bool scenery_available (const SGGeod &position, double range_m)=0
 Returns true if scenery is available for the given lat, lon position within a range of range_m.
 
virtual bool schedule_scenery (const SGGeod &position, double range_m, double duration=0.0)=0
 
virtual void materialLibChanged ()=0
 

Detailed Description

Definition at line 49 of file terrain.hxx.

Constructor & Destructor Documentation

◆ FGTerrain()

FGTerrain::FGTerrain ( )
default

◆ ~FGTerrain()

virtual FGTerrain::~FGTerrain ( )
virtualdefault

Member Function Documentation

◆ bind()

virtual void FGTerrain::bind ( )
pure virtual

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ get_cart_elevation_m()

virtual bool FGTerrain::get_cart_elevation_m ( const SGVec3d & pos,
double max_altoff,
double & elevation,
const simgear::BVHMaterial ** material,
const osg::Node * butNotFrom = 0 )
pure virtual

Compute the elevation of the scenery below the cartesian point pos.

you the returned scenery altitude is not higher than the position pos plus an offset given with max_altoff. If the exact flag is set to true, the scenery center is moved to gain a higher accuracy of that query. The center is restored past that to the original value. The altitude hit is returned in the alt argument. The method returns true if the scenery is available for the given lat/lon pair. If there is no scenery for that point, the altitude value is undefined. All values are meant to be in meters.

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ get_cart_ground_intersection()

virtual bool FGTerrain::get_cart_ground_intersection ( const SGVec3d & start,
const SGVec3d & dir,
SGVec3d & nearestHit,
const osg::Node * butNotFrom = 0 )
pure virtual

Compute the nearest intersection point of the line starting from start going in direction dir with the terrain.

The input and output values should be in cartesian coordinates in the usual earth centered wgs84 coordinate system. Units are meters. On success, true is returned.

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ get_elevation_m()

virtual bool FGTerrain::get_elevation_m ( const SGGeod & geod,
double & alt,
const simgear::BVHMaterial ** material,
const osg::Node * butNotFrom = 0 )
pure virtual

Compute the elevation of the scenery at geodetic latitude lat, geodetic longitude lon and not higher than max_alt.

If the exact flag is set to true, the scenery center is moved to gain a higher accuracy of that query. The center is restored past that to the original value. The altitude hit is returned in the alt argument. The method returns true if the scenery is available for the given lat/lon pair. If there is no scenery for that point, the altitude value is undefined. All values are meant to be in meters or degrees.

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ init()

virtual void FGTerrain::init ( osg::Group * terrain)
pure virtual

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ materialLibChanged()

virtual void FGTerrain::materialLibChanged ( )
pure virtual

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ reinit()

virtual void FGTerrain::reinit ( )
pure virtual

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ scenery_available()

virtual bool FGTerrain::scenery_available ( const SGGeod & position,
double range_m )
pure virtual

Returns true if scenery is available for the given lat, lon position within a range of range_m.

lat and lon are expected to be in degrees.

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ schedule_scenery()

virtual bool FGTerrain::schedule_scenery ( const SGGeod & position,
double range_m,
double duration = 0.0 )
pure virtual

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ shutdown()

virtual void FGTerrain::shutdown ( )
pure virtual

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ unbind()

virtual void FGTerrain::unbind ( )
pure virtual

Implemented in FGPgtTerrain, and FGStgTerrain.

◆ update()

virtual void FGTerrain::update ( double dt)
pure virtual

Implemented in FGPgtTerrain, and FGStgTerrain.


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