Class: QgsAbstract3DMapBackgroundSettings

Base class for all background settings classes used in a 3D map view.

QgsAbstract3DMapBackgroundSettings subclasses are responsible for storing the configuration of different background types (skybox, gradient).

Added in version 4.2.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: clone(), readXml(), type(), writeXml()

Class Hierarchy

Inheritance diagram of qgis._3d.QgsAbstract3DMapBackgroundSettings

Subclasses

QgsFixedGradientBackgroundSettings

Background settings for a two-color vertical gradient rendered behind the 3D scene.

Abstract Methods

clone

Returns a deep copy of this background settings object.

readXml

Reads settings from a DOM element.

type

Returns the unique type for this background settings class.

writeXml

Writes settings to a DOM element.

class qgis._3d.QgsAbstract3DMapBackgroundSettings[source]

Bases: object

abstract clone(self) QgsAbstract3DMapBackgroundSettings | None[source]

Returns a deep copy of this background settings object.

Return type:

Optional[QgsAbstract3DMapBackgroundSettings]

abstract readXml(self, element: QDomElement, context: QgsReadWriteContext)[source]

Reads settings from a DOM element.

See also

writeXml()

Parameters:
abstract type(self) Qgis.Map3DBackgroundType[source]

Returns the unique type for this background settings class.

Return type:

Qgis.Map3DBackgroundType

abstract writeXml(self, element: QDomElement, context: QgsReadWriteContext)[source]

Writes settings to a DOM element.

See also

readXml()

Parameters: