QGIS API Documentation 4.1.0-Master (376402f9aeb)
Loading...
Searching...
No Matches
Qgs3DMapExportSettings Class Reference

Manages the various settings the user can choose from when exporting a 3D scene. More...

#include <qgs3dmapexportsettings.h>

Public Member Functions

 Qgs3DMapExportSettings ()
 Constructor.
 ~Qgs3DMapExportSettings ()
 destructor (save the export settings before deallocation)
QString exportFileUri () const
 Returns the full file uri where the 3D scene will be exported.
Qgis::Export3DSceneFormat exportFormat () const
 Returns the export format for the 3D scene.
bool exportNormals () const
 Returns whether normals will be exported.
bool exportTextures () const
 Returns whether textures will be exported.
float scale () const
 Returns the scale of the exported model.
QString sceneFolderPath () const
 Returns the scene folder path.
QString sceneName () const
 Returns the scene name.
void setExportFormat (Qgis::Export3DSceneFormat exportFormat)
 Sets the export format for the 3D scene.
void setExportNormals (bool exportNormals)
 Sets whether normals should be exported.
void setExportTextures (bool exportTextures)
 Sets whether textures will be exported.
void setScale (float scale)
 Sets the scale of exported model.
void setSceneFolderPath (const QString &sceneFolderPath)
 Sets the folder path where exported 3D scene files will be saved.
void setSceneName (const QString &sceneName)
 Sets the scene name.
void setSmoothEdges (bool smoothEdges)
 Sets whether triangles edges will look smooth.
void setTerrainExportEnabled (bool enabled)
 Sets whether terrain export is enabled.
void setTerrainResolution (int resolution)
 Sets the terrain resolution.
void setTerrainTextureResolution (int resolution)
 Sets the terrain texture resolution.
bool smoothEdges () const
 Returns whether triangles edges will look smooth.
bool terrainExportEnabled () const
 Returns whether terrain export is enabled.
int terrainTextureResolution () const
 Returns the terrain texture resolution.
int terrrainResolution () const
 Returns the terrain resolution.

Detailed Description

Manages the various settings the user can choose from when exporting a 3D scene.

Since
QGIS 3.16

Definition at line 31 of file qgs3dmapexportsettings.h.

Constructor & Destructor Documentation

◆ Qgs3DMapExportSettings()

Qgs3DMapExportSettings::Qgs3DMapExportSettings ( )

Constructor.

Definition at line 25 of file qgs3dmapexportsettings.cpp.

◆ ~Qgs3DMapExportSettings()

Qgs3DMapExportSettings::~Qgs3DMapExportSettings ( )

destructor (save the export settings before deallocation)

Definition at line 38 of file qgs3dmapexportsettings.cpp.

Member Function Documentation

◆ exportFileUri()

QString Qgs3DMapExportSettings::exportFileUri ( ) const

Returns the full file uri where the 3D scene will be exported.

Since
QGIS 4.2

Definition at line 51 of file qgs3dmapexportsettings.cpp.

◆ exportFormat()

Qgis::Export3DSceneFormat Qgs3DMapExportSettings::exportFormat ( ) const
inline

Returns the export format for the 3D scene.

Since
QGIS 4.2

Definition at line 60 of file qgs3dmapexportsettings.h.

◆ exportNormals()

bool Qgs3DMapExportSettings::exportNormals ( ) const
inline

Returns whether normals will be exported.

Definition at line 49 of file qgs3dmapexportsettings.h.

◆ exportTextures()

bool Qgs3DMapExportSettings::exportTextures ( ) const
inline

Returns whether textures will be exported.

Definition at line 51 of file qgs3dmapexportsettings.h.

◆ scale()

float Qgs3DMapExportSettings::scale ( ) const
inline

Returns the scale of the exported model.

Definition at line 55 of file qgs3dmapexportsettings.h.

◆ sceneFolderPath()

QString Qgs3DMapExportSettings::sceneFolderPath ( ) const
inline

Returns the scene folder path.

Definition at line 43 of file qgs3dmapexportsettings.h.

◆ sceneName()

QString Qgs3DMapExportSettings::sceneName ( ) const
inline

Returns the scene name.

Definition at line 41 of file qgs3dmapexportsettings.h.

◆ setExportFormat()

void Qgs3DMapExportSettings::setExportFormat ( Qgis::Export3DSceneFormat exportFormat)
inline

Sets the export format for the 3D scene.

Since
QGIS 4.2

Definition at line 97 of file qgs3dmapexportsettings.h.

◆ setExportNormals()

void Qgs3DMapExportSettings::setExportNormals ( bool exportNormals)
inline

Sets whether normals should be exported.

Definition at line 86 of file qgs3dmapexportsettings.h.

◆ setExportTextures()

void Qgs3DMapExportSettings::setExportTextures ( bool exportTextures)
inline

Sets whether textures will be exported.

Definition at line 88 of file qgs3dmapexportsettings.h.

◆ setScale()

void Qgs3DMapExportSettings::setScale ( float scale)
inline

Sets the scale of exported model.

Definition at line 92 of file qgs3dmapexportsettings.h.

◆ setSceneFolderPath()

void Qgs3DMapExportSettings::setSceneFolderPath ( const QString & sceneFolderPath)
inline

Sets the folder path where exported 3D scene files will be saved.

Definition at line 80 of file qgs3dmapexportsettings.h.

◆ setSceneName()

void Qgs3DMapExportSettings::setSceneName ( const QString & sceneName)
inline

Sets the scene name.

Definition at line 78 of file qgs3dmapexportsettings.h.

◆ setSmoothEdges()

void Qgs3DMapExportSettings::setSmoothEdges ( bool smoothEdges)
inline

Sets whether triangles edges will look smooth.

Definition at line 84 of file qgs3dmapexportsettings.h.

◆ setTerrainExportEnabled()

void Qgs3DMapExportSettings::setTerrainExportEnabled ( bool enabled)
inline

Sets whether terrain export is enabled.

See also
terrainExportEnabled()
Since
QGIS 4.0

Definition at line 105 of file qgs3dmapexportsettings.h.

◆ setTerrainResolution()

void Qgs3DMapExportSettings::setTerrainResolution ( int resolution)
inline

Sets the terrain resolution.

Definition at line 82 of file qgs3dmapexportsettings.h.

◆ setTerrainTextureResolution()

void Qgs3DMapExportSettings::setTerrainTextureResolution ( int resolution)
inline

Sets the terrain texture resolution.

Definition at line 90 of file qgs3dmapexportsettings.h.

◆ smoothEdges()

bool Qgs3DMapExportSettings::smoothEdges ( ) const
inline

Returns whether triangles edges will look smooth.

Definition at line 47 of file qgs3dmapexportsettings.h.

◆ terrainExportEnabled()

bool Qgs3DMapExportSettings::terrainExportEnabled ( ) const
inline

Returns whether terrain export is enabled.

It terrain export is disabled, the terrain resolution and terrain texture resolution parameters have no effect.

See also
setTerrainExportEnabled()
Since
QGIS 4.0

Definition at line 75 of file qgs3dmapexportsettings.h.

◆ terrainTextureResolution()

int Qgs3DMapExportSettings::terrainTextureResolution ( ) const
inline

Returns the terrain texture resolution.

Definition at line 53 of file qgs3dmapexportsettings.h.

◆ terrrainResolution()

int Qgs3DMapExportSettings::terrrainResolution ( ) const
inline

Returns the terrain resolution.

Definition at line 45 of file qgs3dmapexportsettings.h.


The documentation for this class was generated from the following files: