QGIS/python/core/auto_generated/qgstessellator.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

125 lines
3.9 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgstessellator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsTessellator
{
%Docstring(signature="appended")
Tessellates polygons into triangles.
It is expected that client code will create the tessellator object, then
repeatedly call :py:func:`~addPolygon` method that will generate
triangles, and finally call :py:func:`~data` to get final vertex data.
Optionally provides extrusion by adding triangles that serve as walls
when extrusion height is non-zero.
%End
%TypeHeaderCode
#include "qgstessellator.h"
%End
public:
QgsTessellator( double originX, double originY, bool addNormals, bool invertNormals = false, bool addBackFaces = false, bool noZ = false,
bool addTextureCoords = false, int facade = 3, float textureRotation = 0.0f );
%Docstring
Creates tessellator with a specified origin point of the world (in map
coordinates)
%End
QgsTessellator( const QgsRectangle &bounds, bool addNormals, bool invertNormals = false, bool addBackFaces = false, bool noZ = false,
bool addTextureCoords = false, int facade = 3, float textureRotation = 0.0f );
%Docstring
Creates tessellator with a specified ``bounds`` of input geometry
coordinates. This constructor allows the tessellator to map input
coordinates to a desirable range for numerical stability during
calculations.
If ``noZ`` is ``True``, then a 2-dimensional tessellation only will be
performed and all z coordinates will be ignored.
.. versionadded:: 3.10
%End
void setOutputZUp( bool zUp );
%Docstring
Sets whether the "up" direction should be the Z axis on output
(``True``), otherwise the "up" direction will be the Y axis (``False``).
The default value is ``False`` (to keep compatibility for existing
tessellator use cases).
.. versionadded:: 3.42
%End
bool isOutputZUp() const;
%Docstring
Returns whether the "up" direction should be the Z axis on output
(``True``), otherwise the "up" direction will be the Y axis (``False``).
The default value is ``False`` (to keep compatibility for existing
tessellator use cases).
.. versionadded:: 3.42
%End
void addPolygon( const QgsPolygon &polygon, float extrusionHeight );
%Docstring
Tessellates a triangle and adds its vertex entries to the output data
array
%End
QVector<float> data() const;
%Docstring
Returns array of triangle vertex data
Vertice coordinates are stored as (x, z, -y)
%End
int dataVerticesCount() const;
%Docstring
Returns the number of vertices stored in the output data array
%End
int stride() const;
%Docstring
Returns size of one vertex entry in bytes
%End
float zMinimum() const;
%Docstring
Returns minimal Z value of the data (in world coordinates)
.. versionadded:: 3.12
%End
float zMaximum() const;
%Docstring
Returns maximal Z value of the data (in world coordinates)
.. versionadded:: 3.12
%End
QString error() const;
%Docstring
Returns a descriptive error string if the tessellation failed.
.. versionadded:: 3.34
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgstessellator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/