QGIS/python/core/auto_generated/pointcloud/qgspointcloudlayer.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/pointcloud/qgspointcloudlayer.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/







class QgsPointCloudLayer : QgsMapLayer, QgsAbstractProfileSource
{
%Docstring(signature="appended")

Represents a map layer supporting display of point clouds

.. note::

   The API is considered EXPERIMENTAL and can be changed without a notice

.. versionadded:: 3.18
%End

%TypeHeaderCode
#include "qgspointcloudlayer.h"
%End
  public:

    struct LayerOptions
    {

      explicit LayerOptions( const QgsCoordinateTransformContext &transformContext = QgsCoordinateTransformContext( ) );
%Docstring
Constructor for LayerOptions with optional ``transformContext``.
%End

      QgsCoordinateTransformContext transformContext;

      bool loadDefaultStyle;

      bool skipCrsValidation;

      bool skipIndexGeneration;

      bool skipStatisticsCalculation;
    };


    enum class PointCloudStatisticsCalculationState
    {
      NotStarted,
      Calculating,
      Calculated
    };

    explicit QgsPointCloudLayer( const QString &uri = QString(),
                                 const QString &baseName = QString(),
                                 const QString &providerLib = QStringLiteral( "pointcloud" ),
                                 const QgsPointCloudLayer::LayerOptions &options = QgsPointCloudLayer::LayerOptions() );
%Docstring
Constructor - creates a point cloud layer
%End

    ~QgsPointCloudLayer();


    SIP_PYOBJECT __repr__();
%Docstring
QgsPointCloudLayer cannot be copied.
%End
%MethodCode
    QString str = QStringLiteral( "<QgsPointCloudLayer: '%1' (%2)>" ).arg( sipCpp->name(), sipCpp->dataProvider() ? sipCpp->dataProvider()->name() : QStringLiteral( "Invalid" ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

    virtual QgsPointCloudLayer *clone() const /Factory/;

    virtual QgsRectangle extent() const;

    virtual QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) /Factory/;

    virtual QgsAbstractProfileGenerator *createProfileGenerator( const QgsProfileRequest &request ) /Factory/;


    virtual QgsPointCloudDataProvider *dataProvider();


    virtual bool readXml( const QDomNode &layerNode, QgsReadWriteContext &context );


    virtual bool writeXml( QDomNode &layerNode, QDomDocument &doc, const QgsReadWriteContext &context ) const;


     virtual bool readSymbology( const QDomNode &node, QString &errorMessage,
                        QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories );
    virtual bool readStyle( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) ${SIP_FINAL};


     virtual bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context,
                         StyleCategories categories = AllStyleCategories ) const;
    virtual bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) const ${SIP_FINAL};


    virtual void setTransformContext( const QgsCoordinateTransformContext &transformContext );


    virtual QString encodedSource( const QString &source, const QgsReadWriteContext &context ) const;

    virtual QString decodedSource( const QString &source, const QString &dataProvider, const QgsReadWriteContext &context ) const;

    virtual QString loadDefaultStyle( bool &resultFlag /Out/ ) ${SIP_FINAL};

    virtual QString htmlMetadata() const;

    virtual QgsMapLayerElevationProperties *elevationProperties();


    QgsPointCloudAttributeCollection attributes() const;
%Docstring
Returns the attributes available from the layer.
%End

    qint64 pointCount() const;
%Docstring
Returns the total number of points available in the layer.
%End

    QgsPointCloudRenderer *renderer();
%Docstring
Returns the 2D renderer for the point cloud.

.. seealso:: :py:func:`setRenderer`
%End


    void setRenderer( QgsPointCloudRenderer *renderer /Transfer/ );
%Docstring
Sets the 2D ``renderer`` for the point cloud.

Ownership of ``renderer`` is transferred to the layer.

.. seealso:: :py:func:`renderer`
%End

    bool setSubsetString( const QString &subset );
%Docstring
Sets the string used to define a subset of the layer

:param subset: The subset string to be used in a ``:py:class:`QgsPointCloudExpression```

:return: ``True``, when setting the subset string was successful, ``False`` otherwise

.. versionadded:: 3.26
%End

    QString subsetString() const;
%Docstring
Returns the string used to define a subset of the layer.

:return: The subset string or null QString if not implemented by the provider

.. versionadded:: 3.26
%End

    void setSync3DRendererTo2DRenderer( bool sync );
%Docstring
Sets whether this layer's 3D renderer should be automatically updated
with changes applied to the layer's 2D renderer

.. versionadded:: 3.26
%End

    bool sync3DRendererTo2DRenderer() const;
%Docstring
Returns whether this layer's 3D renderer should be automatically updated
with changes applied to the layer's 2D renderer

.. versionadded:: 3.26
%End

    bool convertRenderer3DFromRenderer2D();
%Docstring
Updates the layer's 3D renderer's symbol to match that of the layer's 2D renderer

:return: ``True`` on success, ``False`` otherwise

.. versionadded:: 3.26
%End

    const QgsPointCloudStatistics statistics() const;
%Docstring
Returns the object containing statistics

.. versionadded:: 3.26
%End

    PointCloudStatisticsCalculationState statisticsCalculationState() const;
%Docstring
Returns the status of point cloud statistics calculation

.. versionadded:: 3.26
%End
  signals:

    void subsetStringChanged();
%Docstring
Emitted when the layer's subset string has changed.

.. versionadded:: 3.26
%End

    void raiseError( const QString &msg );
%Docstring
Signals an error related to this point cloud layer.

.. versionadded:: 3.26
%End

    void statisticsCalculationStateChanged( QgsPointCloudLayer::PointCloudStatisticsCalculationState state );
%Docstring
Emitted when statistics calculation state has changed

.. versionadded:: 3.26
%End

  private:
    QgsPointCloudLayer( const QgsPointCloudLayer &rhs );
};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/pointcloud/qgspointcloudlayer.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/