sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-10-04 00:04:03 -04:00
Code Issues Packages Projects Releases Wiki Activity

Change doxygen "3d" group to "qgis_3d"

Browse Source 
Doxygen chokes on the initial digit in "3d", resulting in corrupted
documentation for classes in the 3d group
This commit is contained in:
Nyall Dawson 2025-03-29 07:34:57 +10:00
parent 64ccd4dd2e
commit 739bf854bd
104 changed files with 136 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/modules.dox
View File

@ -25,7 +25,7 @@ components to QGIS.
*/
/** @defgroup 3d 3D library
/** @defgroup qgis_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.

2
src/3d/chunks/qgschunkboundsentity_p.h
View File

@ -38,7 +38,7 @@ class Qgs3DWiredMesh;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Draws bounds of axis aligned bounding boxes
* \note Not available in Python bindings
*/

2
src/3d/chunks/qgschunkedentity.h
View File

@ -56,7 +56,7 @@ namespace QgsRayCastingUtils
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Implementation of entity that handles chunks of data organized in quadtree with loading data when necessary
* based on data error and unloading of data when data are not necessary anymore
*/

4
src/3d/chunks/qgschunklist_p.h
View File

@ -32,7 +32,7 @@
class QgsChunkNode;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Element of a double-linked list
*
* \note Not available in Python bindings
@ -53,7 +53,7 @@ struct QgsChunkListEntry
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Double linked list of chunks.
*
* The list does not own entries.

8
src/3d/chunks/qgschunkloader.h
View File

@ -34,7 +34,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for jobs that load chunks
*
* \note Not available in Python bindings
@ -57,7 +57,7 @@ class QgsChunkLoader : public QgsChunkQueueJob
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Factory for chunk loaders for a particular type of entity
*/
class QgsChunkLoaderFactory : public QObject
@ -117,7 +117,7 @@ class QgsChunkLoaderFactory : public QObject
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for factories where the hierarchy is a quadtree where all leaves
* are in the same depth.
*
@ -145,7 +145,7 @@ class _3D_EXPORT QgsQuadtreeChunkLoaderFactory : public QgsChunkLoaderFactory
};
/**
* \ingroup 3d
* \ingroup qgis_3d
* Factory that uses a chunk loader factory for in-place updates
* of loaded nodes. Use it with QgsChunkedEntity::updateNodes()
* to rebuild entity of an existing node.

2
src/3d/chunks/qgschunknode.h
View File

@ -105,7 +105,7 @@ struct QgsChunkNodeId
};
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Data structure for keeping track of chunks of data for 3D entities that use "out of core" rendering,
* i.e. not all of the data are available in the memory all the time.
*

4
src/3d/chunks/qgschunkqueuejob.h
View File

@ -39,7 +39,7 @@ namespace Qt3DCore
#include <QObject>
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for chunk queue jobs.
*
* Job implementations start their work when they are created
@ -85,7 +85,7 @@ class QgsChunkQueueJob : public QObject
};
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for factories of chunk queue jobs.
*
* Derived classes need to implement createJob() method that will create a specific job for given chunk node.

2
src/3d/framegraph/qgs3daxisrenderview.h
View File

@ -51,7 +51,7 @@ class Qgs3DAxis;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3d axis render view class
*
* \note Not available in Python bindings

2
src/3d/framegraph/qgsabstractrenderview.h
View File

@ -30,7 +30,7 @@ namespace Qt3DRender
} // namespace Qt3DRender
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for 3D render view
*
* An instance of QgsAbstractRenderView is a branch (ie. a render pass, ie. a render view) of the framegraph.

2
src/3d/framegraph/qgsambientocclusionblurentity.h
View File

@ -21,7 +21,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief An entity that is responsible for blurring the ambient occlusion factor texture.
*
* \note Not available in Python bindings

2
src/3d/framegraph/qgsambientocclusionrenderentity.h
View File

@ -21,7 +21,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief An entity that is responsible for producing an ambient occlusion factor map.
*
* \note Not available in Python bindings

2
src/3d/framegraph/qgsforwardrenderview.h
View File

@ -38,7 +38,7 @@ namespace Qt3DRender
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Container class that holds different objects related to forward rendering
* \note Not available in Python bindings
*

2
src/3d/framegraph/qgsframegraph.h
View File

@ -54,7 +54,7 @@ class QgsShadowSettings;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Container class that holds different objects related to frame graph of 3D scenes
*
* A frame graph captures configuration of rendering passes when 3D scene gets rendered.

2
src/3d/framegraph/qgsframegraphutils.h
View File

@ -40,7 +40,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Util class to dump Qt3D framegraph or scenegraph.
* \since QGIS 3.40
*/

2
src/3d/framegraph/qgspostprocessingentity.h
View File

@ -25,7 +25,7 @@ class QgsDirectionalLightSettings;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief An entity that is responsible for applying post processing effect.
*
* \note Not available in Python bindings

4
src/3d/framegraph/qgspreviewquad.h
View File

@ -24,7 +24,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Material component for QgsPreviewQuad object
*
* \note Not available in Python bindings
@ -49,7 +49,7 @@ class QgsPreviewQuadMaterial : public Qt3DRender::QMaterial
};
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Rectangular quad entity used for debugging depth maps
*
* \note Not available in Python bindings

2
src/3d/framegraph/qgsrenderpassquad.h
View File

@ -28,7 +28,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief An entity that is responsible for rendering a screen quad for a specific rendering pass.
*
* \note Not available in Python bindings

2
src/3d/framegraph/qgsshadowrenderview.h
View File

@ -57,7 +57,7 @@ class QgsLightSource;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Container class that holds different objects related to shadow rendering
*
* \note Not available in Python bindings

2
src/3d/lights/qgsdirectionallightsettings.h
View File

@ -25,7 +25,7 @@ class QDomDocument;
class QDomElement;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Definition of a directional light in a 3D map scene
*
* \since QGIS 3.16

2
src/3d/lights/qgslightsource.h
View File

@ -38,7 +38,7 @@ namespace Qt3DCore
#endif
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for light sources in 3d scenes.
*
* \since QGIS 3.26

2
src/3d/lights/qgspointlightsettings.h
View File

@ -26,7 +26,7 @@ class QDomDocument;
class QDomElement;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Definition of a point light in a 3D map scene
*
* Total light at the distance D from a point light with intensity I

6
src/3d/materials/qgsabstractmaterialsettings.h
View File

@ -44,7 +44,7 @@ namespace Qt3DCore
/**
* \brief Material rendering techniques
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.16
*/
enum class QgsMaterialSettingsRenderingTechnique SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsAbstractMaterialSettings, RenderingTechnique ) : int
@ -60,7 +60,7 @@ enum class QgsMaterialSettingsRenderingTechnique SIP_MONKEYPATCH_SCOPEENUM_UNNES
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Context settings for a material.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is
@ -107,7 +107,7 @@ class _3D_EXPORT QgsMaterialContext
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Abstract base class for material settings.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/materials/qgsgoochmaterialsettings.h
View File

@ -25,7 +25,7 @@
class QDomElement;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Basic shading material used for rendering based on the Phong shading model
* with three color components: ambient, diffuse and specular.
*

2
src/3d/materials/qgsmaterial.h
View File

@ -30,7 +30,7 @@ namespace Qt3DRender
}
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for all materials used within QGIS 3D views.
* It provides common functionality (such as clipping) that all materials should support (where applicable).
* \since QGIS 3.40

2
src/3d/materials/qgsmetalroughmaterial.h
View File

@ -41,7 +41,7 @@ namespace Qt3DRender
///@cond PRIVATE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief A PBR metal rough material.
* \since QGIS 3.36
*/

2
src/3d/materials/qgsmetalroughmaterialsettings.h
View File

@ -24,7 +24,7 @@
class QDomElement;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief A PBR metal rough shading material used for rendering.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/materials/qgsnullmaterialsettings.h
View File

@ -25,7 +25,7 @@
class QDomElement;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Null shading material used for rendering models and scenes with native textures.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/materials/qgsphongmaterialsettings.h
View File

@ -25,7 +25,7 @@
class QDomElement;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Basic shading material used for rendering based on the Phong shading model
* with three color components: ambient, diffuse and specular.
*

2
src/3d/materials/qgsphongtexturedmaterial.h
View File

@ -34,7 +34,7 @@ namespace Qt3DRender
///@cond PRIVATE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief A diffuseSpecular material adapted from Qt's qdiffusespecularmaterial.h
* \since QGIS 3.40
*/

2
src/3d/materials/qgsphongtexturedmaterialsettings.h
View File

@ -25,7 +25,7 @@
class QDomElement;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief A phong shading model with diffuse texture map.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/materials/qgssimplelinematerialsettings.h
View File

@ -26,7 +26,7 @@
class QDomElement;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Basic shading material used for rendering simple lines as solid line components.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/materials/qgstexturematerial.h
View File

@ -39,7 +39,7 @@ namespace Qt3DRender
///@cond PRIVATE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief A unlit texture material
* \since QGIS 3.40
*/

2
src/3d/mesh/qgsmesh3dmaterial_p.h
View File

@ -44,7 +44,7 @@
class QgsMeshLayer;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Implementation of material used to render the mesh layer
* \since QGIS 3.12
*/

2
src/3d/mesh/qgsmeshterraingenerator.h
View File

@ -26,7 +26,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Implementation of terrain generator that uses the Z values of a mesh layer to build a terrain
* \since QGIS 3.12
*/

2
src/3d/qgs3danimationsettings.h
View File

@ -29,7 +29,7 @@ class QgsReadWriteContext;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Class that holds information about animation in 3D view. The animation is defined
* as a series of keyframes
* \note Not available in Python bindings

2
src/3d/qgs3daxis.h
View File

@ -40,7 +40,7 @@ class Qgs3DMapScene;
class Qgs3DAxisRenderView;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Display 3D ortho axis in the main 3D view.
*
* Axis are displayed in a dedicated viewport which can be placed all around the main viewport.

2
src/3d/qgs3daxissettings.h
View File

@ -29,7 +29,7 @@ class QDomElement;
/**
* \brief Contains the configuration of a 3d axis.
*
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.26
*/
class _3D_EXPORT Qgs3DAxisSettings

2
src/3d/qgs3dexportobject.h
View File

@ -34,7 +34,7 @@ class QgsAbstractMaterialSettings;
*
* \note Not available in Python bindings
*
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.16
*/
class _3D_EXPORT Qgs3DExportObject

2
src/3d/qgs3dmapcanvas.h
View File

@ -70,7 +70,7 @@ class QgsRubberBand3D;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Qgs3DMapCanvas is a convenience wrapper to simplify the creation of a 3D window ready to be used with QGIS.
*
* \note This is a port of qtwindow3d which does not set the default surface when initialized.

2
src/3d/qgs3dmapexportsettings.h
View File

@ -24,7 +24,7 @@
/**
* \brief Manages the various settings the user can choose from when exporting a 3D scene
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.16
*/
class _3D_EXPORT Qgs3DMapExportSettings

2
src/3d/qgs3dmapscene.h
View File

@ -61,7 +61,7 @@ class Qgs3DMapSceneEntity;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Entity that encapsulates our 3D scene - contains all other entities (such as terrain) as children.
*/
#ifndef SIP_RUN

2
src/3d/qgs3dmapsceneentity.h
View File

@ -40,7 +40,7 @@ class Qgs3DMapSettings;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Abstract entity that all entities rendered in a Qgs3DMapScene inherit
* \since QGIS 3.32
*/

2
src/3d/qgs3dmapsettings.h
View File

@ -45,7 +45,7 @@ class QgsProject;
class QDomElement;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Definition of the world.
*
* \warning Qgs3DMapSettings are a QObject subclass, and accordingly are not

2
src/3d/qgs3dmaptool.h
View File

@ -29,7 +29,7 @@ class QWheelEvent;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for map tools operating on 3D map canvas.
* \note Not available in Python bindings
* \since QGIS 3.36 (since QGIS 3.4 in QGIS_APP library)

2
src/3d/qgs3drendercontext.h
View File

@ -33,7 +33,7 @@ class Qgs3DMapSettings;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Rendering context for preparation of 3D entities.
*
* Contains a snapshot of properties from Qgs3DMapSettings, in a thread-safe, cheap-to-copy structure.

2
src/3d/qgs3dsceneexporter.h
View File

@ -51,7 +51,7 @@ class TestQgs3DRendering;
*
* \note Not available in Python bindings
*
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.16
*/
class _3D_EXPORT Qgs3DSceneExporter : public Qt3DCore::QEntity

2
src/3d/qgs3dtypes.h
View File

@ -19,7 +19,7 @@
#include "qgis_3d.h"
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Defines enumerations and other auxiliary types for QGIS 3D
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/qgs3dutils.h
View File

@ -51,7 +51,7 @@ class QSurface;
class Qgs3DRenderContext;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Miscellaneous utility functions used from 3D code.
* \note Not available in Python bindings
*/

2
src/3d/qgs3dwiredmesh_p.h
View File

@ -41,7 +41,7 @@ class QgsAABB;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Geometry renderer for lines, draws a wired mesh
*
* \since QGIS 3.26

2
src/3d/qgsaabb.h
View File

@ -27,7 +27,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Axis-aligned bounding box - in world coords.
* \note Not available in Python bindings
*/

2
src/3d/qgsabstract3dengine.h
View File

@ -42,7 +42,7 @@ namespace Qt3DRender
class QgsFrameGraph;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for 3D engine implementation. A 3D engine is responsible for setting up
* rendering with Qt3D. This means mainly:
*

4
src/3d/qgsabstractvectorlayer3drenderer.h
View File

@ -25,7 +25,7 @@
class QgsVectorLayer;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief This class defines configuration of how a vector layer gets tiled for 3D rendering.
*
* Zoom levels count tells how deep will be the quadtree and thus how many tiles will
@ -68,7 +68,7 @@ class _3D_EXPORT QgsVectorLayer3DTilingSettings
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for 3D renderers that are based on vector layers.
*
* \since QGIS 3.12

2
src/3d/qgsambientocclusionsettings.h
View File

@ -28,7 +28,7 @@ class QDomElement;
/**
* \brief class containing the configuration of ambient occlusion rendering
* \ingroup 3d
* \ingroup qgis_3d
* \note Not available in Python bindings
* \since QGIS 3.28
*/

2
src/3d/qgscameracontroller.h
View File

@ -50,7 +50,7 @@ class QgsWindow3DEngine;
class Qgs3DMapScene;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Object that controls camera movement based on user input
*/
#ifndef SIP_RUN

2
src/3d/qgscamerapose.h
View File

@ -31,7 +31,7 @@ class QDomDocument;
class QDomElement;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Class that encapsulates camera pose in a 3D scene.
*
* The pose is defined with the following parameters:

2
src/3d/qgsfeature3dhandler_p.h
View File

@ -37,7 +37,7 @@ class QgsFeature;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Interface to be implemented by 3D symbol implementations in order to generate 3D entities.
*/
class QgsFeature3DHandler

2
src/3d/qgsgltf3dutils.h
View File

@ -45,7 +45,7 @@ namespace Qt3DCore
}
/**
* \ingroup 3d
* \ingroup qgis_3d
*
* Utility functions for dealing with GLTF models in 3D map views.
*

2
src/3d/qgsimagetexture.h
View File

@ -30,7 +30,7 @@
*
* \note Not available in Python bindings
*
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.16
*/
class _3D_EXPORT QgsImageTexture : public Qt3DRender::QPaintedTextureImage

2
src/3d/qgslayoutitem3dmap.h
View File

@ -35,7 +35,7 @@ class Qgs3DMapSettings;
class QgsOffscreen3DEngine;
/**
* \ingroup 3d
* \ingroup qgis_3d
*
* \brief Implements support of 3D map views in print layouts
*

2
src/3d/qgsoffscreen3dengine.h
View File

@ -50,7 +50,7 @@ namespace Qt3DLogic
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Off-screen 3D engine implementation. It is useful for recording rendered 3D scenes of arbitrary size.
*
* \note While the on-screen 3D engine also allows capturing of images, its limitation is that

6
src/3d/qgspointcloudlayerchunkloader_p.h
View File

@ -48,7 +48,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief This loader factory is responsible for creation of loaders for individual tiles
* of QgsQgsPointCloudLayerChunkedEntity whenever a new tile is requested by the entity.
*
@ -83,7 +83,7 @@ class QgsPointCloudLayerChunkLoaderFactory : public QgsChunkLoaderFactory
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief This loader class is responsible for async loading of data for a single tile
* of QgsPointCloudLayerChunkedEntity and creation of final 3D entity from the data
* previously prepared in a worker thread.
@ -114,7 +114,7 @@ class QgsPointCloudLayerChunkLoader : public QgsChunkLoader
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D entity used for rendering of point cloud layers with a single 3D symbol for all points.
*
* It is implemented using tiling approach with QgsChunkedEntity. Internally it uses

2
src/3d/qgsrubberband3d.h
View File

@ -69,7 +69,7 @@ namespace Qt3DRender
} // namespace Qt3DRender
/**
* \ingroup 3d
* \ingroup qgis_3d
* Rubber band implementation for use in 3D map views.
*
* Coordinates are expected to be passed in map CRS and the 3D entity generated by this

6
src/3d/qgsrulebased3drenderer.h
View File

@ -29,7 +29,7 @@ class QgsFeature3DHandler;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Metadata for rule-based 3D renderer to allow creation of its instances from XML
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is
@ -48,7 +48,7 @@ class _3D_EXPORT QgsRuleBased3DRendererMetadata : public Qgs3DRendererAbstractMe
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Rule-based 3D renderer.
*
* Similar to rule-based 2D renderer and rule-based labeling, it allows specification of rules for 3D symbols.
@ -66,7 +66,7 @@ class _3D_EXPORT QgsRuleBased3DRenderer : public QgsAbstractVectorLayer3DRendere
typedef QHash<const QgsRuleBased3DRenderer::Rule *, QgsFeature3DHandler *> RuleToHandlerMap;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief A child rule for a QgsRuleBased3DRenderer
* \since QGIS 3.6
*/

6
src/3d/qgsrulebasedchunkloader_p.h
View File

@ -47,7 +47,7 @@ namespace Qt3DCore
}
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief This loader factory is responsible for creation of loaders for individual tiles
* of QgsRuleBasedChunkedEntity whenever a new tile is requested by the entity.
*
@ -73,7 +73,7 @@ class QgsRuleBasedChunkLoaderFactory : public QgsQuadtreeChunkLoaderFactory
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief This loader class is responsible for async loading of data for a single tile
* of QgsRuleBasedChunkedEntity and creation of final 3D entity from the data
* previously prepared in a worker thread.
@ -104,7 +104,7 @@ class QgsRuleBasedChunkLoader : public QgsChunkLoader
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D entity used for rendering of vector layers using a hierarchy of rules (just like
* in case of 2D rule-based rendering or labeling).
*

2
src/3d/qgsshadowsettings.h
View File

@ -28,7 +28,7 @@ class QDomElement;
/**
* \brief class containing the configuration of shadows rendering
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.16
*/
class _3D_EXPORT QgsShadowSettings

6
src/3d/qgsskyboxentity.h
View File

@ -38,7 +38,7 @@ class QgsImageTexture;
* \brief Base class for all skybox types.
*
* It holds the common member data between different skybox entity types
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.16
*/
class _3D_EXPORT QgsSkyboxEntity : public Qt3DCore::QEntity
@ -73,7 +73,7 @@ class _3D_EXPORT QgsSkyboxEntity : public Qt3DCore::QEntity
/**
* \brief A skybox constructed from a panoramic image.
*
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.16
*/
class _3D_EXPORT QgsPanoramicSkyboxEntity : public QgsSkyboxEntity
@ -101,7 +101,7 @@ class _3D_EXPORT QgsPanoramicSkyboxEntity : public QgsSkyboxEntity
/**
* \brief A skybox constructed from a 6 cube faces.
*
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.16
*/
class _3D_EXPORT QgsCubeFacesSkyboxEntity : public QgsSkyboxEntity

2
src/3d/qgsskyboxsettings.h
View File

@ -30,7 +30,7 @@ class QDomElement;
/**
* \brief Contains the configuration of a skybox entity.
*
* \ingroup 3d
* \ingroup qgis_3d
* \since QGIS 3.16
*/
class _3D_EXPORT QgsSkyboxSettings

2
src/3d/qgstessellatedpolygongeometry.h
View File

@ -48,7 +48,7 @@ namespace Qt3DCore
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Class derived from Qt3DRender::QGeometry that represents polygons tessellated into 3D geometry.
*
* Takes a list of polygons as input, internally it does tessellation and writes output to the internal

6
src/3d/qgstiledscenechunkloader_p.h
View File

@ -44,7 +44,7 @@ class QgsTiledSceneChunkLoaderFactory;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief This loader class is responsible for async loading of data for a single tile
* of tiled scene chunk entity and creation of final 3D entity from the data
* previously prepared in a worker thread.
@ -70,7 +70,7 @@ class QgsTiledSceneChunkLoader : public QgsChunkLoader
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief This loader factory is responsible for creation of loaders for individual tiles
* of tiled scene chunk entity whenever a new tile is requested by the entity.
*
@ -107,7 +107,7 @@ class QgsTiledSceneChunkLoaderFactory : public QgsChunkLoaderFactory
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D entity used for rendering of tiled scene layers.
*
* It is implemented using tiling approach with QgsChunkedEntity. Internally it uses

4
src/3d/qgstiledscenelayer3drenderer.h
View File

@ -27,7 +27,7 @@ class QgsTiledSceneLayer;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Metadata for tiled scene layer 3D renderer to allow creation of its instances from XML
*
* \since QGIS 3.34
@ -43,7 +43,7 @@ class _3D_EXPORT QgsTiledSceneLayer3DRendererMetadata : public Qgs3DRendererAbst
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D renderer that renders content of a tiled scene layer
*
* \since QGIS 3.34

2
src/3d/qgstilingscheme.h
View File

@ -27,7 +27,7 @@ struct QgsChunkNodeId;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief The class encapsulates tiling scheme (just like with WMTS / TMS / XYZ layers).
*
* The origin (tile [0,0]) is in bottom-left corner.

6
src/3d/qgsvectorlayerchunkloader_p.h
View File

@ -48,7 +48,7 @@ namespace Qt3DCore
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief This loader factory is responsible for creation of loaders for individual tiles
* of QgsVectorLayerChunkedEntity whenever a new tile is requested by the entity.
*
@ -73,7 +73,7 @@ class QgsVectorLayerChunkLoaderFactory : public QgsQuadtreeChunkLoaderFactory
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief This loader class is responsible for async loading of data for a single tile
* of QgsVectorLayerChunkedEntity and creation of final 3D entity from the data
* previously prepared in a worker thread.
@ -104,7 +104,7 @@ class QgsVectorLayerChunkLoader : public QgsChunkLoader
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D entity used for rendering of vector layers with a single 3D symbol for all features.
*
* It is implemented using tiling approach with QgsChunkedEntity. Internally it uses

2
src/3d/qgsvirtualpointcloudentity_p.h
View File

@ -43,7 +43,7 @@ class Qgs3DMapSettings;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Implementation of entity that handles virtual point cloud sub indexes
*
* This entity is parent to a QgsChunkBoundsEntity that renders all sub indexes' bounding boxes, as well as all individual

2
src/3d/qgswindow3dengine.h
View File

@ -34,7 +34,7 @@ class QWindow;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief On-screen 3D engine: it creates OpenGL window (QWindow) and displays rendered 3D scene there.
* The window can be embedded into a QWidget-based application with QWidget::createWindowContainer().
*

2
src/3d/symbols/qgsbillboardgeometry.h
View File

@ -30,7 +30,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Geometry of the billboard rendering for points in 3D map view.
*
* \note Not available in Python bindings

2
src/3d/symbols/qgsline3dsymbol.h
View File

@ -24,7 +24,7 @@
class QgsAbstractMaterialSettings;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D symbol that draws linestring geometries as planar polygons (created from lines using a buffer with given thickness).
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/symbols/qgslinematerial_p.h
View File

@ -34,7 +34,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Implementation of material that renders 3D linestrings.
*
* Supports:

2
src/3d/symbols/qgslinevertexdata_p.h
View File

@ -55,7 +55,7 @@ class QgsLineString;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Helper class to store vertex buffer and index buffer data that will be used to render
* lines (either using "line strip" or "line strip with adjacency" primitive.
*

2
src/3d/symbols/qgsmesh3dsymbol.h
View File

@ -27,7 +27,7 @@
class QgsAbstractMaterialSettings;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D symbol that draws mesh geometry as planar triangles.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/symbols/qgspoint3dbillboardmaterial.h
View File

@ -27,7 +27,7 @@ class QgsMarkerSymbol;
class Qgs3DRenderContext;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Material of the billboard rendering for points in 3D map view.
*
* \note Not available in Python bindings

2
src/3d/symbols/qgspoint3dsymbol.h
View File

@ -28,7 +28,7 @@ class QgsAbstractMaterialSettings;
class QgsMarkerSymbol;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D symbol that draws point geometries as 3D objects using one of the predefined shapes.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

10
src/3d/symbols/qgspointcloud3dsymbol.h
View File

@ -27,7 +27,7 @@
#include "qgspointcloudclassifiedrenderer.h"
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D symbol that draws point cloud geometries as 3D objects.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is
@ -186,7 +186,7 @@ class _3D_EXPORT QgsPointCloud3DSymbol : public QgsAbstract3DSymbol SIP_ABSTRACT
};
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D symbol that draws point cloud geometries as 3D objects.using one color
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is
@ -226,7 +226,7 @@ class _3D_EXPORT QgsSingleColorPointCloud3DSymbol : public QgsPointCloud3DSymbol
};
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D symbol that draws point cloud geometries as 3D objects.using color ramp shader
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is
@ -299,7 +299,7 @@ class _3D_EXPORT QgsColorRampPointCloud3DSymbol : public QgsPointCloud3DSymbol
};
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D symbol that draws point cloud geometries as 3D objects using RGB colors in the dataset
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is
@ -456,7 +456,7 @@ class _3D_EXPORT QgsRgbPointCloud3DSymbol : public QgsPointCloud3DSymbol
};
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D symbol that draws point cloud geometries as 3D objects using classification of the dataset
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/symbols/qgspolygon3dsymbol.h
View File

@ -26,7 +26,7 @@
class QgsAbstractMaterialSettings;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief 3D symbol that draws polygon geometries as planar polygons, optionally extruded (with added walls).
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/terrain/qgsabstractterrainsettings.h
View File

@ -28,7 +28,7 @@ class QgsTerrainGenerator;
class Qgs3DRenderContext;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for all terrain settings classes.
*
* QgsAbstractTerrainSettings subclasses are responsible for storing the configuration

2
src/3d/terrain/qgsdemterraingenerator.h
View File

@ -28,7 +28,7 @@ class QgsDemHeightMapGenerator;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Implementation of terrain generator that uses a raster layer with DEM to build terrain.
*
* \note Not available in Python bindings

2
src/3d/terrain/qgsdemterrainsettings.h
View File

@ -24,7 +24,7 @@
class QgsRasterLayer;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Terrain settings for a terrain generator that uses a raster DEM layer to build terrain.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/terrain/qgsdemterraintilegeometry_p.h
View File

@ -59,7 +59,7 @@ namespace QgsRayCastingUtils
}
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Stores attributes and vertex/index buffers for one terrain tile based on DEM.
*/
#if QT_VERSION < QT_VERSION_CHECK( 6, 0, 0 )

4
src/3d/terrain/qgsdemterraintileloader_p.h
View File

@ -46,7 +46,7 @@ class QgsCoordinateTransformContext;
class QgsTerrainGenerator;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Chunk loader for DEM terrain tiles.
*/
class QgsDemTerrainTileLoader : public QgsTerrainTileLoader
@ -72,7 +72,7 @@ class QgsDemTerrainTileLoader : public QgsTerrainTileLoader
class QgsTerrainDownloader;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Utility class to asynchronously create heightmaps from DEM raster for given tiles of terrain.
*/
class QgsDemHeightMapGenerator : public QObject

2
src/3d/terrain/qgsflatterraingenerator.h
View File

@ -44,7 +44,7 @@ class FlatTerrainChunkLoader : public QgsTerrainTileLoader
///@endcond
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Terrain generator that creates a simple square flat area.
*
*/

2
src/3d/terrain/qgsflatterrainsettings.h
View File

@ -26,7 +26,7 @@ class QgsReadWriteContext;
class QgsProject;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Terrain settings for a simple flat area terrain.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/terrain/qgsmeshterrainsettings.h
View File

@ -28,7 +28,7 @@ class QgsMeshLayer;
class QgsMesh3DSymbol;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Terrain settings for a terrain generator that uses uses the Z values of a mesh layer to build a terrain.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/terrain/qgsonlinedemterrainsettings.h
View File

@ -22,7 +22,7 @@
#include "qgsrectangle.h"
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Terrain settings for a terrain generator that uses an online DEM to build terrain.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/terrain/qgsonlineterraingenerator.h
View File

@ -27,7 +27,7 @@ class QgsDemHeightMapGenerator;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Implementation of terrain generator that uses online resources to download heightmaps.
*
* \note Not available in Python bindings

2
src/3d/terrain/qgsquantizedmeshterraingenerator.h
View File

@ -29,7 +29,7 @@
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Terrain generator using a Quantized Mesh tile layer
* \since QGIS 3.40
*/

2
src/3d/terrain/qgsquantizedmeshterrainsettings.h
View File

@ -27,7 +27,7 @@ class QgsProject;
class QgsTiledSceneLayer;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Terrain settings for a terrain generator that uses uses a quantized mesh tile layer to build a terrain.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is

2
src/3d/terrain/qgsterraindownloader.h
View File

@ -32,7 +32,7 @@ class QgsCoordinateTransformContext;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Takes care of downloading terrain data from a publicly available data source.
*
* Currently using terrain tiles in Terrarium format hosted on AWS. More info:

2
src/3d/terrain/qgsterrainentity.h
View File

@ -48,7 +48,7 @@ class QgsTerrainGenerator;
class TerrainMapUpdateJobFactory;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Controller for terrain - decides on what terrain tiles to show based on camera position
* and creates them using map's terrain tile generator.
*/

2
src/3d/terrain/qgsterraingenerator.h
View File

@ -35,7 +35,7 @@ class QgsProject;
#define SIP_NO_FILE
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Base class for generators of terrain.
*
* All terrain generators are tile based

2
src/3d/terrain/qgsterraintexturegenerator_p.h
View File

@ -43,7 +43,7 @@ class QgsRasterLayer;
class Qgs3DMapSettings;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Class responsible for rendering map images in background for the purposes of their use
* as textures for terrain's tiles.
*

2
src/3d/terrain/qgsterraintextureimage_p.h
View File

@ -36,7 +36,7 @@
class QgsTerrainTextureGenerator;
/**
* \ingroup 3d
* \ingroup qgis_3d
* \brief Class that stores an image with a rendered map. The image is used as a texture for one map tile.
*
* The texture is provided to Qt 3D through the implementation of dataGenerator() method.

Some files were not shown because too many files have changed in this diff Show More