Skip to content
Permalink
Browse files

Add warnings about the QGIS 3D API being unstable / tech preview only

  • Loading branch information
wonder-sk committed Oct 14, 2018
1 parent 8814e40 commit 45c9ae97c0bee60928f575e3de2da954b53dc603
@@ -13,6 +13,11 @@ class Qgs3DTypes
%Docstring
Defines enumerations and other auxilliary types for QGIS 3D

.. warning::

This is not considered stable API, and may change in future QGIS releases. It is
exposed to the Python bindings as a tech preview only.

.. versionadded:: 3.4
%End

@@ -16,6 +16,11 @@ class QgsPhongMaterialSettings
Basic shading material used for rendering based on the Phong shading model
with three color components: ambient, diffuse and specular.

.. warning::

This is not considered stable API, and may change in future QGIS releases. It is
exposed to the Python bindings as a tech preview only.

.. versionadded:: 3.0
%End

@@ -19,6 +19,11 @@ class QgsVectorLayer3DRendererMetadata : Qgs3DRendererAbstractMetadata
%Docstring
Metadata for vector layer 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
exposed to the Python bindings as a tech preview only.

.. versionadded:: 3.0
%End

@@ -19,6 +19,11 @@ Abstract base class for 3D symbols that are used by VectorLayer3DRenderer object

3D symbol objects define appearance of GIS data.

.. warning::

This is not considered stable API, and may change in future QGIS releases. It is
exposed to the Python bindings as a tech preview only.

.. versionadded:: 3.0
%End

@@ -15,6 +15,11 @@ class QgsLine3DSymbol : QgsAbstract3DSymbol
%Docstring
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
exposed to the Python bindings as a tech preview only.

.. versionadded:: 3.0
%End

@@ -15,6 +15,11 @@ class QgsPoint3DSymbol : QgsAbstract3DSymbol
%Docstring
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
exposed to the Python bindings as a tech preview only.

.. versionadded:: 3.0
%End

@@ -15,6 +15,11 @@ class QgsPolygon3DSymbol : QgsAbstract3DSymbol
%Docstring
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
exposed to the Python bindings as a tech preview only.

.. versionadded:: 3.0
%End

@@ -21,6 +21,10 @@
/**
* \ingroup 3d
* Defines enumerations and other auxilliary types for QGIS 3D
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is
* exposed to the Python bindings as a tech preview only.
*
* \since QGIS 3.4
*/
class _3D_EXPORT Qgs3DTypes
@@ -26,6 +26,10 @@ class QDomElement;
* \ingroup 3d
* Basic shading material used for rendering based on the Phong shading model
* with three color components: ambient, diffuse and specular.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is
* exposed to the Python bindings as a tech preview only.
*
* \since QGIS 3.0
*/
class _3D_EXPORT QgsPhongMaterialSettings
@@ -35,6 +35,10 @@ class QgsVectorLayer;
/**
* \ingroup core
* Metadata for vector layer 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
* exposed to the Python bindings as a tech preview only.
*
* \since QGIS 3.0
*/
class _3D_EXPORT QgsVectorLayer3DRendererMetadata : public Qgs3DRendererAbstractMetadata
@@ -33,6 +33,9 @@ class QgsReadWriteContext;
*
* 3D symbol objects define appearance of GIS data.
*
* \warning This is not considered stable API, and may change in future QGIS releases. It is
* exposed to the Python bindings as a tech preview only.
*
* \since QGIS 3.0
*/
class _3D_EXPORT QgsAbstract3DSymbol
@@ -26,6 +26,10 @@
/**
* \ingroup 3d
* 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
* exposed to the Python bindings as a tech preview only.
*
* \since QGIS 3.0
*/
class _3D_EXPORT QgsLine3DSymbol : public QgsAbstract3DSymbol
@@ -28,6 +28,9 @@
* \ingroup 3d
* 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
* exposed to the Python bindings as a tech preview only.
*
* \since QGIS 3.0
*/
class _3D_EXPORT QgsPoint3DSymbol : public QgsAbstract3DSymbol
@@ -27,6 +27,10 @@
/**
* \ingroup 3d
* 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
* exposed to the Python bindings as a tech preview only.
*
* \since QGIS 3.0
*/
class _3D_EXPORT QgsPolygon3DSymbol : public QgsAbstract3DSymbol

0 comments on commit 45c9ae9

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