QGIS/python/3d/auto_generated/lights/qgslightsource.sip.in

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

73 lines
2.3 KiB
Plaintext
Raw Normal View History

2022-04-24 15:51:05 +10:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/3d/lights/qgslightsource.h *
* *
2024-08-11 07:55:04 +10:00
* Do not edit manually ! Edit header and run scripts/sipify.py again *
2022-04-24 15:51:05 +10:00
************************************************************************/
2022-04-24 16:12:27 +10:00
class QgsLightSource /Abstract/
2022-04-24 15:51:05 +10:00
{
%Docstring(signature="appended")
Base class for light sources in 3d scenes.
2022-04-25 07:39:37 +10:00
.. versionadded:: 3.26
2022-04-24 15:51:05 +10:00
%End
%TypeHeaderCode
#include "qgslightsource.h"
%End
public:
virtual ~QgsLightSource();
2022-04-25 07:39:37 +10:00
virtual Qgis::LightSourceType type() const = 0;
%Docstring
Returns the light source type.
%End
virtual QgsLightSource *clone() const = 0 /Factory/;
%Docstring
Returns a copy of the light source.
%End
2022-04-24 16:12:27 +10:00
2022-04-25 07:39:37 +10:00
virtual QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const = 0;
2022-04-24 16:12:27 +10:00
%Docstring
Writes the light source's configuration to a new DOM element and returns it.
.. seealso:: :py:func:`readXml`
%End
2022-04-25 07:39:37 +10:00
virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context = QgsReadWriteContext() ) = 0;
2022-04-24 16:12:27 +10:00
%Docstring
Reads configuration from a DOM element previously written using :py:func:`~QgsLightSource.writeXml`.
.. seealso:: :py:func:`writeXml`
2022-04-25 07:39:37 +10:00
%End
virtual void resolveReferences( const QgsProject &project );
%Docstring
After reading from XML, resolve references to any layers that have been read as layer IDs.
%End
static QgsLightSource *createFromXml( const QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
%Docstring
Creates a new light source from an XML element.
2022-04-24 16:12:27 +10:00
%End
2022-04-24 15:51:05 +10:00
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/3d/lights/qgslightsource.h *
* *
2024-08-11 07:55:04 +10:00
* Do not edit manually ! Edit header and run scripts/sipify.py again *
2022-04-24 15:51:05 +10:00
************************************************************************/