QGIS API Documentation 4.1.0-Master (9af12b5a203)
Loading...
Searching...
No Matches
QgsMaterialContext Class Reference

Context settings for a material. More...

#include <qgsmaterial3dhandler.h>

Public Member Functions

bool isHighlighted () const
 Returns true if the material should represent a highlighted state.
bool isSelected () const
 Returns true if the material should represent a selected state.
QColor selectionColor () const
 Returns the color for representing materials in a selected state.
void setIsHighlighted (bool isHighlighted)
 Sets whether the material should represent a highlighted state.
void setIsSelected (bool isSelected)
 Sets whether the material should represent a selected state.
void setSelectionColor (const QColor &color)
 Sets the color for representing materials in a selected state.
void setTextureFilterQuality (Qgis::TextureFilterQuality quality)
 Sets the texture filtering quality.
Qgis::TextureFilterQuality textureFilterQuality () const
 Returns the texture filtering quality.

Static Public Member Functions

static QgsMaterialContext fromRenderContext (const Qgs3DRenderContext &context)
 Constructs a material context from the settings in a 3D render context.

Detailed Description

Context settings for a material.

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.
Since
QGIS 3.16

Definition at line 53 of file qgsmaterial3dhandler.h.

Member Function Documentation

◆ fromRenderContext()

QgsMaterialContext QgsMaterialContext::fromRenderContext ( const Qgs3DRenderContext & context)
static

Constructs a material context from the settings in a 3D render context.

Since
QGIS 4.2

Definition at line 35 of file qgsmaterial3dhandler.cpp.

◆ isHighlighted()

bool QgsMaterialContext::isHighlighted ( ) const
inline

Returns true if the material should represent a highlighted state.

See also
setIsHighlighted()
Since
QGIS 4.0

Definition at line 97 of file qgsmaterial3dhandler.h.

◆ isSelected()

bool QgsMaterialContext::isSelected ( ) const
inline

Returns true if the material should represent a selected state.

See also
setIsSelected()

Definition at line 68 of file qgsmaterial3dhandler.h.

◆ selectionColor()

QColor QgsMaterialContext::selectionColor ( ) const
inline

Returns the color for representing materials in a selected state.

See also
setSelectionColor()

Definition at line 82 of file qgsmaterial3dhandler.h.

◆ setIsHighlighted()

void QgsMaterialContext::setIsHighlighted ( bool isHighlighted)
inline

Sets whether the material should represent a highlighted state.

See also
isHighlighted()
Since
QGIS 4.0

Definition at line 105 of file qgsmaterial3dhandler.h.

◆ setIsSelected()

void QgsMaterialContext::setIsSelected ( bool isSelected)
inline

Sets whether the material should represent a selected state.

See also
isSelected()

Definition at line 75 of file qgsmaterial3dhandler.h.

◆ setSelectionColor()

void QgsMaterialContext::setSelectionColor ( const QColor & color)
inline

Sets the color for representing materials in a selected state.

See also
selectionColor()

Definition at line 89 of file qgsmaterial3dhandler.h.

◆ setTextureFilterQuality()

void QgsMaterialContext::setTextureFilterQuality ( Qgis::TextureFilterQuality quality)
inline

Sets the texture filtering quality.

See also
textureFilterQuality()
Since
QGIS 4.2

Definition at line 121 of file qgsmaterial3dhandler.h.

◆ textureFilterQuality()

Qgis::TextureFilterQuality QgsMaterialContext::textureFilterQuality ( ) const
inline

Returns the texture filtering quality.

See also
setTextureFilterQuality()
Since
QGIS 4.2

Definition at line 113 of file qgsmaterial3dhandler.h.


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