QGIS API Documentation  3.23.0-Master (dd0cd13a00)
Public Member Functions | List of all members
QgsRgbPointCloud3DSymbol Class Reference

3 More...

#include <qgspointcloud3dsymbol.h>

Inheritance diagram for QgsRgbPointCloud3DSymbol:
Inheritance graph
[legend]

Public Member Functions

 QgsRgbPointCloud3DSymbol ()
 Constructor for QgsRGBPointCloud3DSymbol. More...
 
 QgsRgbPointCloud3DSymbol (const QgsRgbPointCloud3DSymbol &other)=delete
 QgsRgbPointCloud3DSymbol cannot be copied - use clone() instead. More...
 
QString blueAttribute () const
 Returns the attribute to use for the blue channel. More...
 
QgsContrastEnhancementblueContrastEnhancement ()
 Returns the contrast enhancement to use for the blue channel. More...
 
unsigned int byteStride () override
 Returns the byte stride for the geometries used to for the vertex buffer. More...
 
QgsAbstract3DSymbolclone () const override SIP_FACTORY
 
void fillMaterial (Qt3DRender::QMaterial *material) override SIP_SKIP
 Used to fill material object with necessary QParameters (and consequently opengl uniforms) More...
 
QString greenAttribute () const
 Returns the attribute to use for the green channel. More...
 
QgsContrastEnhancementgreenContrastEnhancement ()
 Returns the contrast enhancement to use for the green channel. More...
 
QgsRgbPointCloud3DSymboloperator= (const QgsRgbPointCloud3DSymbol &other)=delete
 QgsRgbPointCloud3DSymbol cannot be copied - use clone() instead. More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
 
QString redAttribute () const
 Returns the attribute to use for the red channel. More...
 
QgsContrastEnhancementredContrastEnhancement ()
 Returns the contrast enhancement to use for the red channel. More...
 
void setBlueAttribute (const QString &attribute)
 Sets the attribute to use for the blue channel. More...
 
void setBlueContrastEnhancement (QgsContrastEnhancement *enhancement SIP_TRANSFER)
 Sets the contrast enhancement to use for the blue channel. More...
 
void setGreenAttribute (const QString &attribute)
 Sets the attribute to use for the green channel. More...
 
void setGreenContrastEnhancement (QgsContrastEnhancement *enhancement SIP_TRANSFER)
 Sets the contrast enhancement to use for the green channel. More...
 
void setRedAttribute (const QString &attribute)
 Sets the attribute to use for the red channel. More...
 
void setRedContrastEnhancement (QgsContrastEnhancement *enhancement SIP_TRANSFER)
 Sets the contrast enhancement to use for the red channel. More...
 
QString symbolType () const override
 Returns a unique string identifier of the symbol type. More...
 
void writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
 
- Public Member Functions inherited from QgsPointCloud3DSymbol
 QgsPointCloud3DSymbol ()
 Constructor for QgsPointCloud3DSymbol. More...
 
 ~QgsPointCloud3DSymbol () override
 Destructor for QgsPointCloud3DSymbol. More...
 
float pointSize () const
 Returns the point size of the point cloud. More...
 
void setPointSize (float size)
 Sets the point size. More...
 
QString type () const override
 

Additional Inherited Members

- Public Types inherited from QgsPointCloud3DSymbol
enum  RenderingStyle { NoRendering = 0 , SingleColor , ColorRamp , RgbRendering }
 How to render the point cloud. More...
 
- Protected Attributes inherited from QgsPointCloud3DSymbol
float mPointSize = 2.0
 

Detailed Description

3

3D symbol that draws point cloud geometries as 3D objects using RGB colors in the dataset

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.18

Definition at line 213 of file qgspointcloud3dsymbol.h.

Constructor & Destructor Documentation

◆ QgsRgbPointCloud3DSymbol() [1/2]

QgsRgbPointCloud3DSymbol::QgsRgbPointCloud3DSymbol ( )

Constructor for QgsRGBPointCloud3DSymbol.

Definition at line 196 of file qgspointcloud3dsymbol.cpp.

◆ QgsRgbPointCloud3DSymbol() [2/2]

QgsRgbPointCloud3DSymbol::QgsRgbPointCloud3DSymbol ( const QgsRgbPointCloud3DSymbol other)
delete

QgsRgbPointCloud3DSymbol cannot be copied - use clone() instead.

Member Function Documentation

◆ blueAttribute()

QString QgsRgbPointCloud3DSymbol::blueAttribute ( ) const

Returns the attribute to use for the blue channel.

See also
greenAttribute()
redAttribute()
setBlueAttribute()

Definition at line 330 of file qgspointcloud3dsymbol.cpp.

◆ blueContrastEnhancement()

QgsContrastEnhancement * QgsRgbPointCloud3DSymbol::blueContrastEnhancement ( )

Returns the contrast enhancement to use for the blue channel.

See also
setBlueContrastEnhancement()
redContrastEnhancement()
greenContrastEnhancement()

Definition at line 360 of file qgspointcloud3dsymbol.cpp.

◆ byteStride()

unsigned int QgsRgbPointCloud3DSymbol::byteStride ( )
inlineoverridevirtual

Returns the byte stride for the geometries used to for the vertex buffer.

Implements QgsPointCloud3DSymbol.

Definition at line 231 of file qgspointcloud3dsymbol.h.

◆ clone()

QgsAbstract3DSymbol * QgsRgbPointCloud3DSymbol::clone ( ) const
override

Definition at line 207 of file qgspointcloud3dsymbol.cpp.

◆ fillMaterial()

void QgsRgbPointCloud3DSymbol::fillMaterial ( Qt3DRender::QMaterial *  material)
overridevirtual

Used to fill material object with necessary QParameters (and consequently opengl uniforms)

Implements QgsPointCloud3DSymbol.

Definition at line 301 of file qgspointcloud3dsymbol.cpp.

◆ greenAttribute()

QString QgsRgbPointCloud3DSymbol::greenAttribute ( ) const

Returns the attribute to use for the green channel.

See also
redAttribute()
blueAttribute()
setGreenAttribute()

Definition at line 320 of file qgspointcloud3dsymbol.cpp.

◆ greenContrastEnhancement()

QgsContrastEnhancement * QgsRgbPointCloud3DSymbol::greenContrastEnhancement ( )

Returns the contrast enhancement to use for the green channel.

See also
setGreenContrastEnhancement()
redContrastEnhancement()
blueContrastEnhancement()

Definition at line 350 of file qgspointcloud3dsymbol.cpp.

◆ operator=()

QgsRgbPointCloud3DSymbol& QgsRgbPointCloud3DSymbol::operator= ( const QgsRgbPointCloud3DSymbol other)
delete

QgsRgbPointCloud3DSymbol cannot be copied - use clone() instead.

◆ readXml()

void QgsRgbPointCloud3DSymbol::readXml ( const QDomElement &  elem,
const QgsReadWriteContext context 
)
override

Definition at line 263 of file qgspointcloud3dsymbol.cpp.

◆ redAttribute()

QString QgsRgbPointCloud3DSymbol::redAttribute ( ) const

Returns the attribute to use for the red channel.

See also
greenAttribute()
blueAttribute()
setRedAttribute()

Definition at line 310 of file qgspointcloud3dsymbol.cpp.

◆ redContrastEnhancement()

QgsContrastEnhancement * QgsRgbPointCloud3DSymbol::redContrastEnhancement ( )

Returns the contrast enhancement to use for the red channel.

See also
setRedContrastEnhancement()
greenContrastEnhancement()
blueContrastEnhancement()

Definition at line 340 of file qgspointcloud3dsymbol.cpp.

◆ setBlueAttribute()

void QgsRgbPointCloud3DSymbol::setBlueAttribute ( const QString &  attribute)

Sets the attribute to use for the blue channel.

See also
setRedAttribute()
setGreenAttribute()
blueAttribute()

Definition at line 335 of file qgspointcloud3dsymbol.cpp.

◆ setBlueContrastEnhancement()

void QgsRgbPointCloud3DSymbol::setBlueContrastEnhancement ( QgsContrastEnhancement *enhancement  SIP_TRANSFER)

Sets the contrast enhancement to use for the blue channel.

Ownership of enhancement is transferred.

See also
blueContrastEnhancement()
setRedContrastEnhancement()
setGreenContrastEnhancement()

Definition at line 365 of file qgspointcloud3dsymbol.cpp.

◆ setGreenAttribute()

void QgsRgbPointCloud3DSymbol::setGreenAttribute ( const QString &  attribute)

Sets the attribute to use for the green channel.

See also
setRedAttribute()
setBlueAttribute()
greenAttribute()

Definition at line 325 of file qgspointcloud3dsymbol.cpp.

◆ setGreenContrastEnhancement()

void QgsRgbPointCloud3DSymbol::setGreenContrastEnhancement ( QgsContrastEnhancement *enhancement  SIP_TRANSFER)

Sets the contrast enhancement to use for the green channel.

Ownership of enhancement is transferred.

See also
greenContrastEnhancement()
setRedContrastEnhancement()
setBlueContrastEnhancement()

Definition at line 355 of file qgspointcloud3dsymbol.cpp.

◆ setRedAttribute()

void QgsRgbPointCloud3DSymbol::setRedAttribute ( const QString &  attribute)

Sets the attribute to use for the red channel.

See also
setGreenAttribute()
setBlueAttribute()
redAttribute()

Definition at line 315 of file qgspointcloud3dsymbol.cpp.

◆ setRedContrastEnhancement()

void QgsRgbPointCloud3DSymbol::setRedContrastEnhancement ( QgsContrastEnhancement *enhancement  SIP_TRANSFER)

Sets the contrast enhancement to use for the red channel.

Ownership of enhancement is transferred.

See also
redContrastEnhancement()
setGreenContrastEnhancement()
setBlueContrastEnhancement()

Definition at line 345 of file qgspointcloud3dsymbol.cpp.

◆ symbolType()

QString QgsRgbPointCloud3DSymbol::symbolType ( ) const
overridevirtual

Returns a unique string identifier of the symbol type.

Implements QgsPointCloud3DSymbol.

Definition at line 202 of file qgspointcloud3dsymbol.cpp.

◆ writeXml()

void QgsRgbPointCloud3DSymbol::writeXml ( QDomElement &  elem,
const QgsReadWriteContext context 
) const
override

Definition at line 231 of file qgspointcloud3dsymbol.cpp.


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