Added doxygen comments explaining read file callback functionality.

This commit is contained in:
Robert Osfield 2011-07-18 12:41:22 +00:00
parent 09b5e95d65
commit 695fcda726
3 changed files with 23 additions and 3 deletions

View File

@ -21,7 +21,14 @@
namespace osgSim {
/** Helper class for setting up and acquiring height above terrain intersections with terrain.*/
/** Helper class for setting up and acquiring height above terrain intersections with terrain.
* By default assigns a osgSim::DatabaseCacheReadCallback that enables automatic loading
* of external PagedLOD tiles to ensure that the highest level of detail is used in intersections.
* This automatic loading of tiles is done by the intersection traversal that is done within
* the computeIntersections(..) method, so can result in long intersection times when external
* tiles have to be loaded.
* The external loading of tiles can be disabled by removing the read callback, this is done by
* calling the setDatabaseCacheReadCallback(DatabaseCacheReadCallback*) method with a value of 0.*/
class OSGSIM_EXPORT ElevationSlice
{
public :

View File

@ -21,7 +21,14 @@
namespace osgSim {
/** Helper class for setting up and acquiring height above terrain intersections with terrain.*/
/** Helper class for setting up and acquiring height above terrain intersections with terrain.
* By default assigns a osgSim::DatabaseCacheReadCallback that enables automatic loading
* of external PagedLOD tiles to ensure that the highest level of detail is used in intersections.
* This automatic loading of tiles is done by the intersection traversal that is done within
* the computeIntersections(..) method, so can result in long intersection times when external
* tiles have to be loaded.
* The external loading of tiles can be disabled by removing the read callback, this is done by
* calling the setDatabaseCacheReadCallback(DatabaseCacheReadCallback*) method with a value of 0.*/
class OSGSIM_EXPORT HeightAboveTerrain
{
public :

View File

@ -44,7 +44,13 @@ class OSGSIM_EXPORT DatabaseCacheReadCallback : public osgUtil::IntersectionVisi
};
/** Helper class for setting up and acquiring line of sight intersections with terrain.
* Supports automatic paging in of PagedLOD tiles. */
* By default assigns a osgSim::DatabaseCacheReadCallback that enables automatic loading
* of external PagedLOD tiles to ensure that the highest level of detail is used in intersections.
* This automatic loading of tiles is done by the intersection traversal that is done within
* the computeIntersections(..) method, so can result in long intersection times when external
* tiles have to be loaded.
* The external loading of tiles can be disabled by removing the read callback, this is done by
* calling the setDatabaseCacheReadCallback(DatabaseCacheReadCallback*) method with a value of 0.*/
class OSGSIM_EXPORT LineOfSight
{
public :