Skip to content
Permalink
Browse files

Add 3d doxygen group + more doxymentation

  • Loading branch information
wonder-sk committed Sep 25, 2017
1 parent 2a8ddcc commit 1eeb2ee111dacb6b384e5469667c6c7eeaeef950
Showing with 19 additions and 4 deletions.
  1. +6 −0 doc/modules.dox
  2. +1 −1 src/3d/chunks/chunkedentity.h
  3. +4 −1 src/3d/chunks/chunklist.h
  4. +8 −2 src/3d/chunks/chunkloader.h
@@ -25,6 +25,12 @@ components to QGIS.

*/

/** @defgroup 3d 3D library

The 3D library is build on top of the CORE library and Qt 3D framework. It adds support for display of GIS data in 3D scenes.

*/

/** @defgroup plugins plugin classes

Contains classes related to implementation of QGIS plugins.
@@ -39,7 +39,7 @@ class ChunkedEntity : public Qt3DCore::QEntity
ChunkedEntity( const AABB &rootBbox, float rootError, float tau, int maxLevel, ChunkLoaderFactory *loaderFactory, Qt3DCore::QNode *parent = nullptr );
~ChunkedEntity();

//!< Called when e.g. camera changes and entity may need updated
//! Called when e.g. camera changes and entity may need updated
void update( const SceneState &state );

bool needsUpdate; //!< A chunk has been loaded recently - let's display it!
@@ -3,7 +3,10 @@

class ChunkNode;

//! Element of a double-linked list
/** \ingroup 3d
* Element of a double-linked list
* \since QGIS 3.0
*/
class ChunkListEntry
{
public:
@@ -65,7 +65,10 @@ class ChunkQueueJobFactory
};


//! Base class for jobs that load chunks
/** \ingroup 3d
* Base class for jobs that load chunks
* \since QGIS 3.0
*/
class ChunkLoader : public ChunkQueueJob
{
Q_OBJECT
@@ -85,7 +88,10 @@ class ChunkLoader : public ChunkQueueJob
};


//! Factory for chunk loaders for a particular type of entity
/** \ingroup 3d
* Factory for chunk loaders for a particular type of entity
* \since QGIS 3.0
*/
class ChunkLoaderFactory
{
public:

0 comments on commit 1eeb2ee

Please sign in to comment.
You can’t perform that action at this time.