Manages the data of each object of the scene (positions, normals, texture coordinates ...) since each object. More...

#include <qgs3dexportobject.h>

Public Types
enum	ObjectType { TriangularFaces , LineStrip , Points }
	The type of exported geometry. More...

Public Member Functions
	Qgs3DExportObject (const QString &name)
	Qgs3DExportObject Constructs an export object that will be filled with coordinates later.
QVector< unsigned int >	indexes () const
	Returns the vertex indexes.
QString	name () const
	Returns the object name.
QVector< float >	normals () const
	Returns the vertex normal coordinates.
void	objectBounds (float &minX, float &minY, float &minZ, float &maxX, float &maxY, float &maxZ) const
	Updates the box bounds explained with the current object bounds This expands the bounding box if the current object outside the bounds of the already established bounds.
QString	saveMaterial (QTextStream &mtlOut, const QString &folder) const
	saves the texture of the object and material information
void	saveTo (QTextStream &out, float scale, const QVector3D &center, const Qgis::Export3DSceneFormat &exportFormat=Qgis::Export3DSceneFormat::Obj, int precision=6, QString materialName=QString()) const
	Exports the 3D object to an OBJ or STL compatible output stream.
void	setName (const QString &name)
	Sets the object name.
void	setSmoothEdges (bool smoothEdges)
	Sets whether triangles edges will look smooth.
void	setTextureImage (const QImage &image)
	Sets the texture image used by the object.
void	setupLine (const QVector< float > &positionsBuffer)
	sets line indexes and positions coordinates
void	setupMaterial (QgsAbstractMaterialSettings *material)
	Sets the material parameters (diffuse color, shininess...) to be exported in the .mtl file.
void	setupNormalCoordinates (const QVector< float > &normalsBuffer, const QMatrix4x4 &transform)
	Sets normal coordinates for each vertex.
void	setupPoint (const QVector< float > &positionsBuffer)
	sets point positions coordinates
void	setupTextureCoordinates (const QVector< float > &texturesBuffer)
	Sets texture coordinates for each vertex.
void	setupTriangle (const QVector< float > &positionsBuffer, const QVector< uint > &facesIndexes, const QMatrix4x4 &transform)
	sets triangle indexes and positions coordinates
bool	smoothEdges () const
	Returns whether object edges will look smooth.
QImage	textureImage () const
	Returns the texture image used by the object.
QVector< float >	texturesUV () const
	Returns the vertex texture coordinates.
ObjectType	type () const
	Returns the object type.
QVector< float >	vertexPosition () const
	Returns the vertex coordinates.

Detailed Description

Manages the data of each object of the scene (positions, normals, texture coordinates ...) since each object.

Note: Not available in Python bindings

Since: QGIS 3.16

Definition at line 42 of file qgs3dexportobject.h.

Member Enumeration Documentation

◆ ObjectType

enum Qgs3DExportObject::ObjectType

The type of exported geometry.

Enumerator
TriangularFaces
LineStrip
Points

Definition at line 46 of file qgs3dexportobject.h.

Constructor & Destructor Documentation

◆ Qgs3DExportObject()

Qgs3DExportObject::Qgs3DExportObject ( const QString & name )

inline

Qgs3DExportObject Constructs an export object that will be filled with coordinates later.

Parameters

name	The name of the parent (Will be useful to define scene hierarchy)

Definition at line 58 of file qgs3dexportobject.h.

Member Function Documentation

◆ indexes()

QVector< unsigned int > Qgs3DExportObject::indexes ( ) const

inline

Returns the vertex indexes.

Definition at line 136 of file qgs3dexportobject.h.

◆ name()

QString Qgs3DExportObject::name ( ) const

inline

Returns the object name.

Definition at line 63 of file qgs3dexportobject.h.

◆ normals()

QVector< float > Qgs3DExportObject::normals ( ) const

inline

Returns the vertex normal coordinates.

Definition at line 130 of file qgs3dexportobject.h.

◆ objectBounds()

void Qgs3DExportObject::objectBounds	(	float &	minX,
		float &	minY,
		float &	minZ,
		float &	maxX,
		float &	maxY,
		float &	maxZ ) const

Updates the box bounds explained with the current object bounds This expands the bounding box if the current object outside the bounds of the already established bounds.

Definition at line 124 of file qgs3dexportobject.cpp.

◆ saveMaterial()

QString Qgs3DExportObject::saveMaterial	(	QTextStream &	mtlOut,
		const QString &	folder ) const

saves the texture of the object and material information

Definition at line 287 of file qgs3dexportobject.cpp.

◆ saveTo()

void Qgs3DExportObject::saveTo	(	QTextStream &	out,
		float	scale,
		const QVector3D &	center,
		const Qgis::Export3DSceneFormat &	exportFormat = Qgis::Export3DSceneFormat::Obj,
		int	precision = 6,
		QString	materialName = QString() ) const

Exports the 3D object to an OBJ or STL compatible output stream.

This function writes the 3D object's geometry to the specified output stream, applying a uniform scaling and translating it so that the model is centered and properly visible in the exported scene.

Parameters

out	The output text stream where the data will be written.
scale	The uniform scale factor applied to all vertices.
center	The target center position to which the object will be translated.
exportFormat	The desired export format (OBJ or STL). Defaults to OBJ.
precision	The number of decimal digits used when writing floating-point values (default: 6).
materialName	Optional name of the material to associate with the object (default: empty). This parameter has no effect when exporting to STL, as this format does not support materials.

Definition at line 140 of file qgs3dexportobject.cpp.

◆ setName()

void Qgs3DExportObject::setName ( const QString & name )

inline

Sets the object name.

Definition at line 65 of file qgs3dexportobject.h.

◆ setSmoothEdges()

void Qgs3DExportObject::setSmoothEdges ( bool smoothEdges )

inline

Sets whether triangles edges will look smooth.

Definition at line 73 of file qgs3dexportobject.h.

◆ setTextureImage()

void Qgs3DExportObject::setTextureImage ( const QImage & image )

inline

Sets the texture image used by the object.

Definition at line 92 of file qgs3dexportobject.h.

◆ setupLine()

void Qgs3DExportObject::setupLine ( const QVector< float > & positionsBuffer )

sets line indexes and positions coordinates

Definition at line 63 of file qgs3dexportobject.cpp.

◆ setupMaterial()

void Qgs3DExportObject::setupMaterial ( QgsAbstractMaterialSettings * material )

Sets the material parameters (diffuse color, shininess...) to be exported in the .mtl file.

Definition at line 114 of file qgs3dexportobject.cpp.

◆ setupNormalCoordinates()

void Qgs3DExportObject::setupNormalCoordinates	(	const QVector< float > &	normalsBuffer,
		const QMatrix4x4 &	transform )

Sets normal coordinates for each vertex.

Definition at line 80 of file qgs3dexportobject.cpp.

◆ setupPoint()

void Qgs3DExportObject::setupPoint ( const QVector< float > & positionsBuffer )

sets point positions coordinates

Definition at line 74 of file qgs3dexportobject.cpp.

◆ setupTextureCoordinates()

void Qgs3DExportObject::setupTextureCoordinates ( const QVector< float > & texturesBuffer )

Sets texture coordinates for each vertex.

Definition at line 108 of file qgs3dexportobject.cpp.

◆ setupTriangle()

void Qgs3DExportObject::setupTriangle	(	const QVector< float > &	positionsBuffer,
		const QVector< uint > &	facesIndexes,
		const QMatrix4x4 &	transform )

sets triangle indexes and positions coordinates

Definition at line 44 of file qgs3dexportobject.cpp.

◆ smoothEdges()

bool Qgs3DExportObject::smoothEdges ( ) const

inline

Returns whether object edges will look smooth.

Definition at line 71 of file qgs3dexportobject.h.

◆ textureImage()

QImage Qgs3DExportObject::textureImage ( ) const

inline

Returns the texture image used by the object.

Definition at line 94 of file qgs3dexportobject.h.

◆ texturesUV()

QVector< float > Qgs3DExportObject::texturesUV ( ) const

inline

Returns the vertex texture coordinates.

Definition at line 133 of file qgs3dexportobject.h.

◆ type()

ObjectType Qgs3DExportObject::type ( ) const

inline

Returns the object type.

Definition at line 68 of file qgs3dexportobject.h.

◆ vertexPosition()

QVector< float > Qgs3DExportObject::vertexPosition ( ) const

inline

Returns the vertex coordinates.

Definition at line 127 of file qgs3dexportobject.h.

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

/build/qgis-4.1.0+git20260503+376402f9aeb+99sid/src/3d/qgs3dexportobject.h
/build/qgis-4.1.0+git20260503+376402f9aeb+99sid/src/3d/qgs3dexportobject.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ObjectType

Constructor & Destructor Documentation

◆ Qgs3DExportObject()

Member Function Documentation

◆ indexes()

◆ name()

◆ normals()

◆ objectBounds()

◆ saveMaterial()

◆ saveTo()

◆ setName()

◆ setSmoothEdges()

◆ setTextureImage()

◆ setupLine()

◆ setupMaterial()

◆ setupNormalCoordinates()

◆ setupPoint()

◆ setupTextureCoordinates()

◆ setupTriangle()

◆ smoothEdges()

◆ textureImage()

◆ texturesUV()

◆ type()

◆ vertexPosition()