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

qgis · Oct 14, 2018 · 45c9ae9 · 45c9ae9
1 parent 8814e40
commit 45c9ae9
Show file tree

Hide file tree

Showing 14 changed files with 61 additions and 0 deletions.
diff --git a/python/3d/auto_generated/qgs3dtypes.sip.in b/python/3d/auto_generated/qgs3dtypes.sip.in
@@ -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
 

diff --git a/python/3d/auto_generated/qgsphongmaterialsettings.sip.in b/python/3d/auto_generated/qgsphongmaterialsettings.sip.in
@@ -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
 

diff --git a/python/3d/auto_generated/qgsvectorlayer3drenderer.sip.in b/python/3d/auto_generated/qgsvectorlayer3drenderer.sip.in
@@ -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
 

diff --git a/python/3d/auto_generated/symbols/qgsabstract3dsymbol.sip.in b/python/3d/auto_generated/symbols/qgsabstract3dsymbol.sip.in
@@ -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
 

diff --git a/python/3d/auto_generated/symbols/qgsline3dsymbol.sip.in b/python/3d/auto_generated/symbols/qgsline3dsymbol.sip.in
@@ -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
 

diff --git a/python/3d/auto_generated/symbols/qgspoint3dsymbol.sip.in b/python/3d/auto_generated/symbols/qgspoint3dsymbol.sip.in
@@ -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
 

diff --git a/python/3d/auto_generated/symbols/qgspolygon3dsymbol.sip.in b/python/3d/auto_generated/symbols/qgspolygon3dsymbol.sip.in
@@ -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
 

diff --git a/src/3d/qgs3dtypes.h b/src/3d/qgs3dtypes.h
@@ -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

diff --git a/src/3d/qgsphongmaterialsettings.h b/src/3d/qgsphongmaterialsettings.h
@@ -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

diff --git a/src/3d/qgsvectorlayer3drenderer.h b/src/3d/qgsvectorlayer3drenderer.h
@@ -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

diff --git a/src/3d/symbols/qgsabstract3dsymbol.h b/src/3d/symbols/qgsabstract3dsymbol.h
@@ -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

diff --git a/src/3d/symbols/qgsline3dsymbol.h b/src/3d/symbols/qgsline3dsymbol.h
@@ -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

diff --git a/src/3d/symbols/qgspoint3dsymbol.h b/src/3d/symbols/qgspoint3dsymbol.h
@@ -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

diff --git a/src/3d/symbols/qgspolygon3dsymbol.h b/src/3d/symbols/qgspolygon3dsymbol.h
@@ -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