QGIS/python/3d/auto_generated/symbols/qgspolygon3dsymbol.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/3d/symbols/qgspolygon3dsymbol.h                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsPolygon3DSymbol : QgsAbstract3DSymbol /NoDefaultCtors/
{
%Docstring(signature="appended")
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.
%End

%TypeHeaderCode
#include "qgspolygon3dsymbol.h"
%End
  public:
    QgsPolygon3DSymbol();
    ~QgsPolygon3DSymbol();

    virtual QString type() const;
    virtual QgsAbstract3DSymbol *clone() const /Factory/;


    virtual void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const;

    virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context );

    virtual QList< Qgis::GeometryType > compatibleGeometryTypes() const;

    virtual void setDefaultPropertiesFromLayer( const QgsVectorLayer *layer );


    static QgsAbstract3DSymbol *create() /Factory/;
%Docstring
Creates a new QgsPolygon3DSymbol.

Caller takes ownership of the returned symbol.
%End

    Qgis::AltitudeClamping altitudeClamping() const;
%Docstring
Returns method that determines altitude (whether to clamp to feature to terrain)
%End
    void setAltitudeClamping( Qgis::AltitudeClamping altClamping );
%Docstring
Sets method that determines altitude (whether to clamp to feature to terrain)
%End

    Qgis::AltitudeBinding altitudeBinding() const;
%Docstring
Returns method that determines how altitude is bound to individual vertices
%End
    void setAltitudeBinding( Qgis::AltitudeBinding altBinding );
%Docstring
Sets method that determines how altitude is bound to individual vertices
%End

 float height() const /Deprecated/;
%Docstring
Returns height (altitude) of the symbol (in map units)

.. deprecated:: 3.36

   Use :py:func:`~QgsPolygon3DSymbol.offset` instead.
%End

 void setHeight( float height ) /Deprecated/;
%Docstring
Sets height (altitude) of the symbol (in map units)

.. deprecated:: 3.36

   Use :py:func:`~QgsPolygon3DSymbol.setOffset` instead.
%End

    float offset() const;
%Docstring
Returns vertical offset of the symbol (in map units)

.. versionadded:: 3.36
%End

    void setOffset( float offset );
%Docstring
Sets vertical offset of the symbol (in map units)

.. versionadded:: 3.36
%End

    float extrusionHeight() const;
%Docstring
Returns extrusion height (in map units)
%End
    void setExtrusionHeight( float extrusionHeight );
%Docstring
Sets extrusion height (in map units)
%End

    QgsAbstractMaterialSettings *materialSettings() const;
%Docstring
Returns material settings used for shading of the symbol
%End

    void setMaterialSettings( QgsAbstractMaterialSettings *materialSettings /Transfer/ );
%Docstring
Sets the ``material`` settings used for shading of the symbol.

Ownership of ``material`` is transferred to the symbol.
%End

    Qgs3DTypes::CullingMode cullingMode() const;
%Docstring
Returns front/back culling mode
%End
    void setCullingMode( Qgs3DTypes::CullingMode mode );
%Docstring
Sets front/back culling mode
%End

    bool invertNormals() const;
%Docstring
Returns whether the normals of triangles will be inverted (useful for fixing clockwise / counter-clockwise face vertex orders)
%End
    void setInvertNormals( bool invert );
%Docstring
Sets whether the normals of triangles will be inverted (useful for fixing clockwise / counter-clockwise face vertex orders)
%End

    bool addBackFaces() const;
%Docstring
Returns whether also triangles facing the other side will be created. Useful if input data have inconsistent order of vertices

.. versionadded:: 3.2
%End

    void setAddBackFaces( bool add );
%Docstring
Sets whether also triangles facing the other side will be created. Useful if input data have inconsistent order of vertices

.. versionadded:: 3.2
%End

    bool edgesEnabled() const;
%Docstring
Returns whether edge highlighting is enabled

.. versionadded:: 3.8
%End

    void setEdgesEnabled( bool enabled );
%Docstring
Sets whether edge highlighting is enabled

.. versionadded:: 3.8
%End

    float edgeWidth() const;
%Docstring
Returns width of edge lines (in pixels)

.. versionadded:: 3.8
%End

    void setEdgeWidth( float width );
%Docstring
Sets width of edge lines (in pixels)

.. versionadded:: 3.8
%End

    QColor edgeColor() const;
%Docstring
Returns edge lines color

.. versionadded:: 3.8
%End

    void setEdgeColor( const QColor &color );
%Docstring
Sets edge lines color

.. versionadded:: 3.8
%End

    void setRenderedFacade( int side );
%Docstring
Sets which facade of the buildings is rendered (0 for None, 1 for Walls, 2 for Roofs, 3 for WallsAndRoofs)

.. versionadded:: 3.16
%End

    int renderedFacade() const;
%Docstring
Returns which facade of the buildings is rendered (0 for None, 1 for Walls, 2 for Roofs, 3 for WallsAndRoofs)

.. versionadded:: 3.16
%End


};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/3d/symbols/qgspolygon3dsymbol.h                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/