Class: QgsRuleBased3DRenderer

Rule-based 3D renderer.

Similar to rule-based 2D renderer and rule-based labeling, it allows specification of rules for 3D symbols.

Warning

This is not considered stable API, and may change in future QGIS releases. It is exposed to the Python bindings as a tech preview only.

Added in version 3.6.

Class Hierarchy

Base classes

QgsAbstractVectorLayer3DRenderer	Base class for 3D renderers that are based on vector layers.
QgsAbstract3DRenderer	Base class for all renderers that participate in 3D views.

Methods

copyBaseProperties
readXmlBaseProperties
rootRule	Returns pointer to the root rule
writeXmlBaseProperties

class qgis._3d.QgsRuleBased3DRenderer

Bases: QgsAbstractVectorLayer3DRenderer

__init__(root: QgsRuleBased3DRenderer.Rule | None)

Construct renderer with the given root rule (takes ownership)

Parameters:

root (Optional[QgsRuleBased3DRenderer.Rule])

class Rule

Bases: object

A child rule for a QgsRuleBased3DRenderer.

Added in version 3.6.

QgsRuleBased3DRenderer.Rule(symbol: Optional[QgsAbstract3DSymbol], filterExp: Optional[str] = ‘’, description: Optional[str] = ‘’, elseRule: bool = False) takes ownership of symbol, symbol may be None

Filtered = 0

Inactive = 1

class RegisterResult

Bases: int

Registered = 2

active(self) → bool

Returns if this rule is active

Return type:

bool

Returns:

True if the rule is active

appendChild(self, rule: QgsRuleBased3DRenderer.Rule | None)

add child rule, take ownership, sets this as parent

Parameters:

rule (Optional[QgsRuleBased3DRenderer.Rule])

children(self) → List[QgsRuleBased3DRenderer.Rule]

Returns all children rules of this rule

Return type:

List[QgsRuleBased3DRenderer.Rule]

Returns:

A list of rules

static create(ruleElem: QDomElement, context: QgsReadWriteContext) → QgsRuleBased3DRenderer.Rule | None

Create a rule from an XML definition

Parameters:

• ruleElem (QDomElement) – The XML rule element

• context (QgsReadWriteContext) – reading context

Return type:

Optional[QgsRuleBased3DRenderer.Rule]

Returns:

A new rule

descendants(self) → List[QgsRuleBased3DRenderer.Rule]

Returns all children, grand-children, grand-grand-children, grand-gra… you get it

Return type:

List[QgsRuleBased3DRenderer.Rule]

Returns:

A list of descendant rules

description(self) → str

A human readable description for this rule

Return type:

str

Returns:

Description

filterExpression(self) → str

A filter that will check if this rule applies

Return type:

str

Returns:

An expression

findRuleByKey(self, key: str | None) → QgsRuleBased3DRenderer.Rule | None

Try to find a rule given its unique key

Parameters:

key (Optional[str])

Return type:

Optional[QgsRuleBased3DRenderer.Rule]

insertChild(self, i: int, rule: QgsRuleBased3DRenderer.Rule | None)

add child rule, take ownership, sets this as parent

Parameters:

• i (int)

• rule (Optional[QgsRuleBased3DRenderer.Rule])

isElse(self) → bool

Check if this rule is an ELSE rule

Return type:

bool

Returns:

True if this rule is an else rule

parent(self) → QgsRuleBased3DRenderer.Rule | None

The parent rule

Return type:

Optional[QgsRuleBased3DRenderer.Rule]

Returns:

Parent rule

removeChildAt(self, i: int)

delete child rule

Parameters:

i (int)

ruleKey(self) → str

Unique rule identifier (for identification of rule within labeling, used as provider ID)

Return type:

str

save(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement

store labeling info to XML element

Parameters:

• doc (QDomDocument)

• context (QgsReadWriteContext)

Return type:

QDomElement

setActive(self, state: bool)

Sets if this rule is active

Parameters:

state (bool) – Determines if the rule should be activated or deactivated

setDescription(self, description: str | None)

Set a human readable description for this rule

Parameters:

description (Optional[str]) – Description

setFilterExpression(self, filterExp: str | None)

Set the expression used to check if a given feature shall be rendered with this rule

Parameters:

filterExp (Optional[str]) – An expression

setIsElse(self, iselse: bool)

Sets if this rule is an ELSE rule

Parameters:

iselse (bool) – If True, this rule is an ELSE rule

setRuleKey(self, key: str | None)

Override the assigned rule key (should be used just internally by rule-based renderer)

Parameters:

key (Optional[str])

setSymbol(self, symbol: QgsAbstract3DSymbol | None)

Sets new symbol (or None). Deletes old symbol if any.

Parameters:

symbol (Optional[QgsAbstract3DSymbol])

symbol(self) → QgsAbstract3DSymbol | None

Returns the labeling settings. May return None.

Return type:

Optional[QgsAbstract3DSymbol]

copyBaseProperties()

readXmlBaseProperties()

rootRule(self) → QgsRuleBased3DRenderer.Rule | None

Returns pointer to the root rule

Return type:

Optional[QgsRuleBased3DRenderer.Rule]

writeXmlBaseProperties()