Class: QgsLayoutItem3DMap

Implements support of 3D map views in print layouts.

Added in version 3.4.

Class Hierarchy

Base classes

QgsLayoutItem	Base class for graphical items within a QgsLayout.
QgsLayoutObject	A base class for objects which belong to a layout.
QObject
QgsExpressionContextGenerator	Abstract interface for generating an expression context.
QGraphicsRectItem
QAbstractGraphicsShapeItem
QGraphicsItem
QgsLayoutUndoObjectInterface	Interface for layout objects which support undo/redo commands.
QgsTemporalRangeObject	Base class for objects with an associated (optional) temporal range.

class qgis._3d.QgsLayoutItem3DMap

Bases: QgsLayoutItem, QgsTemporalRangeObject

__init__(layout: QgsLayout | None)

Constructor for QgsLayoutItem3DMap, with the specified parent layout.

Ownership is transferred to the layout.

Parameters:

layout (Optional[QgsLayout])

assignFreeId(self)

Sets the map id() to a number not yet used in the layout. The existing id() is kept if it is not in use.

cameraPose(self) → QgsCameraPose

Returns camera view

Return type:

QgsCameraPose

static create(layout: QgsLayout | None) → QgsLayoutItem3DMap | None

Returns a new 3D map item for the specified layout.

The caller takes responsibility for deleting the returned object.

Parameters:

layout (Optional[QgsLayout])

Return type:

Optional[QgsLayoutItem3DMap]

virtual displayName(self) → str

overridden to show “3D Map 1” type names

Return type:

str

mapSettings(self) → Qgs3DMapSettings | None

Returns map scene. May be None if not yet configured.

Return type:

Optional[Qgs3DMapSettings]

setCameraPose(self, pose: QgsCameraPose)

Configures camera view

Parameters:

pose (QgsCameraPose)

setMapSettings(self, settings: Qgs3DMapSettings | None)

Configures map scene

Ownership is transferred to the item.

Parameters:

settings (Optional[Qgs3DMapSettings])