QGIS/python/3d/auto_generated/qgsskyboxsettings.sip.in
2020-08-04 07:07:51 +01:00

101 lines
3.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/3d/qgsskyboxsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsSkyboxSettings
{
%Docstring
class containing the configuration of a skybox entity
.. versionadded:: 3.16
%End
%TypeHeaderCode
#include "qgsskyboxsettings.h"
%End
public:
void readXml( const QDomElement &element, const QgsReadWriteContext &context );
%Docstring
Reads settings from a DOM ``element``
%End
void writeXml( QDomElement &element, const QgsReadWriteContext &context ) const;
%Docstring
Writes settings to a DOM ``element``
%End
bool isSkyboxEnabled() const;
%Docstring
Returns whether the skybox is enabled
%End
void setIsSkyboxEnabled( bool enabled );
%Docstring
Sets whether the skybox is enabled
%End
QgsSkyboxEntity::SkyboxType skyboxType() const;
%Docstring
Returns the type of the skybox
%End
void setSkyboxType( QgsSkyboxEntity::SkyboxType type );
%Docstring
Sets the type of the skybox
%End
QString skyboxBaseName() const;
%Docstring
Returns the base name of a skybox of type "Textures collection"
%End
void setSkyboxBaseName( const QString &baseName );
%Docstring
Sets the base name of a skybox of type "Textures collection"
%End
QString skyboxExtension() const;
%Docstring
Returns the extension of a skybox of type "Textures collection"
%End
void setSkyboxExtension( const QString &extension );
%Docstring
Sets the extension of a skybox of type "Textures collection"
%End
QString hdrTexturePath() const;
%Docstring
Returns the HDR texture path of a skybox of type "HDR texture"
%End
void setHdrTexturePath( const QString &texturePath );
%Docstring
Sets the HDR texture path of a skybox of type "HDR texture"
%End
QMap<QString, QString> cubeMapFacesPaths() const;
%Docstring
Returns a map containing the path of each texture specified by the user.
The map will contain the following keys corresponding to each face "posX", "posY", "posZ", "negX", "negY", "negZ".
%End
void setCubeMapFace( const QString &face, const QString &path );
%Docstring
Sets a face of one of the skybox 6 textures
The face parameter needs to be one of the followings: "posX", "posY", "posZ", "negX", "negY", "negZ"
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/3d/qgsskyboxsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/