QGIS API Documentation 3.27.0-Master (95e00c50d2)
Public Member Functions | List of all members
QgsColorRampPointCloud3DSymbol Class Reference

3 More...

#include <qgspointcloud3dsymbol.h>

Inheritance diagram for QgsColorRampPointCloud3DSymbol:
Inheritance graph
[legend]

Public Member Functions

 QgsColorRampPointCloud3DSymbol ()
 Constructor for QgsColorRampPointCloud3DSymbol. More...
 
QString attribute () const
 Returns the attribute used to select the color of the point cloud. More...
 
unsigned int byteStride () override
 Returns the byte stride for the geometries used to for the vertex buffer. More...
 
QgsAbstract3DSymbolclone () const override SIP_FACTORY
 
QgsColorRampShader colorRampShader () const
 Returns the color ramp shader used to render the color. More...
 
double colorRampShaderMax () const
 Returns the maximum value used when classifying colors in the color ramp shader. More...
 
double colorRampShaderMin () const
 Returns the minimum value used when classifying colors in the color ramp shader. More...
 
void fillMaterial (Qt3DRender::QMaterial *material) override SIP_SKIP
 Used to fill material object with necessary QParameters (and consequently opengl uniforms) More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
 
void setAttribute (const QString &attribute)
 Sets the attribute used to select the color of the point cloud. More...
 
void setColorRampShader (const QgsColorRampShader &colorRampShader)
 Sets the color ramp shader used to render the point cloud. More...
 
void setColorRampShaderMinMax (double min, double max)
 Sets the minimum and maximum values used when classifying colors in the color ramp shader. 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...
 
virtual unsigned int byteStride ()=0
 Returns the byte stride for the geometries used to for the vertex buffer. More...
 
void copyBaseSettings (QgsAbstract3DSymbol *destination) const override
 
virtual void fillMaterial (Qt3DRender::QMaterial *material)=0SIP_SKIP
 Used to fill material object with necessary QParameters (and consequently opengl uniforms) More...
 
float horizontalFilterThreshold () const
 Returns the threshold horizontal size value for filtering triangles. More...
 
bool horizontalTriangleFilter () const
 Returns whether triangles are filtered by horizontal size for rendering. More...
 
float pointSize () const
 Returns the point size of the point cloud. More...
 
bool renderAsTriangles () const
 Returns whether points are triangulated to render solid surface. More...
 
void setHorizontalFilterThreshold (float horizontalFilterThreshold)
 Sets the threshold horizontal size value for filtering triangles. More...
 
void setHorizontalTriangleFilter (bool horizontalTriangleFilter)
 Sets whether whether triangles are filtered by horizontal size for rendering. More...
 
void setPointSize (float size)
 Sets the point size. More...
 
void setRenderAsTriangles (bool asTriangles)
 Sets whether points are triangulated to render solid surface. More...
 
void setVerticalFilterThreshold (float verticalFilterThreshold)
 Sets the threshold vertical height value for filtering triangles. More...
 
void setVerticalTriangleFilter (bool verticalTriangleFilter)
 Sets whether triangles are filtered by vertical height for rendering. More...
 
virtual QString symbolType () const =0
 Returns a unique string identifier of the symbol type. More...
 
QString type () const override
 
float verticalFilterThreshold () const
 Returns the threshold vertical height value for filtering triangles. More...
 
bool verticalTriangleFilter () const
 Returns whether triangles are filtered by vertical height for rendering. More...
 

Additional Inherited Members

- Public Types inherited from QgsPointCloud3DSymbol
enum  RenderingStyle {
  NoRendering = 0 , SingleColor , ColorRamp , RgbRendering ,
  Classification
}
 How to render the point cloud. More...
 
- Protected Member Functions inherited from QgsPointCloud3DSymbol
void readBaseXml (const QDomElement &elem, const QgsReadWriteContext &context)
 Reads symbol configuration of this class from the given DOM element. More...
 
void writeBaseXml (QDomElement &elem, const QgsReadWriteContext &context) const
 Writes symbol configuration of this class to the given DOM element. More...
 
- Protected Attributes inherited from QgsPointCloud3DSymbol
float mHorizontalFilterThreshold = 10.0
 
bool mHorizontalTriangleFilter = false
 
float mPointSize = 3.0
 
bool mRenderAsTriangles = false
 
float mVerticalFilterThreshold = 10.0
 
bool mVerticalTriangleFilter = false
 

Detailed Description

3

3D symbol that draws point cloud geometries as 3D objects.using color ramp shader

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 241 of file qgspointcloud3dsymbol.h.

Constructor & Destructor Documentation

◆ QgsColorRampPointCloud3DSymbol()

QgsColorRampPointCloud3DSymbol::QgsColorRampPointCloud3DSymbol ( )

Constructor for QgsColorRampPointCloud3DSymbol.

Definition at line 181 of file qgspointcloud3dsymbol.cpp.

Member Function Documentation

◆ attribute()

QString QgsColorRampPointCloud3DSymbol::attribute ( ) const

Returns the attribute used to select the color of the point cloud.

See also
setAttribute()

Definition at line 227 of file qgspointcloud3dsymbol.cpp.

◆ byteStride()

unsigned int QgsColorRampPointCloud3DSymbol::byteStride ( )
inlineoverridevirtual

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

Implements QgsPointCloud3DSymbol.

Definition at line 295 of file qgspointcloud3dsymbol.h.

◆ clone()

QgsAbstract3DSymbol * QgsColorRampPointCloud3DSymbol::clone ( ) const
override

Definition at line 187 of file qgspointcloud3dsymbol.cpp.

◆ colorRampShader()

QgsColorRampShader QgsColorRampPointCloud3DSymbol::colorRampShader ( ) const

Returns the color ramp shader used to render the color.

See also
setColorRampShader( const QgsColorRampShader &colorRampShader )

Definition at line 237 of file qgspointcloud3dsymbol.cpp.

◆ colorRampShaderMax()

double QgsColorRampPointCloud3DSymbol::colorRampShaderMax ( ) const
inline

Returns the maximum value used when classifying colors in the color ramp shader.

See also
setColorRampShaderMinMax( double min, double max )

Definition at line 287 of file qgspointcloud3dsymbol.h.

◆ colorRampShaderMin()

double QgsColorRampPointCloud3DSymbol::colorRampShaderMin ( ) const
inline

Returns the minimum value used when classifying colors in the color ramp shader.

See also
setColorRampShaderMinMax( double min, double max )

Definition at line 281 of file qgspointcloud3dsymbol.h.

◆ fillMaterial()

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

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

Implements QgsPointCloud3DSymbol.

Definition at line 253 of file qgspointcloud3dsymbol.cpp.

◆ readXml()

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

Definition at line 216 of file qgspointcloud3dsymbol.cpp.

◆ setAttribute()

void QgsColorRampPointCloud3DSymbol::setAttribute ( const QString &  attribute)

Sets the attribute used to select the color of the point cloud.

See also
attribute()

Definition at line 232 of file qgspointcloud3dsymbol.cpp.

◆ setColorRampShader()

void QgsColorRampPointCloud3DSymbol::setColorRampShader ( const QgsColorRampShader colorRampShader)

Sets the color ramp shader used to render the point cloud.

See also
colorRampShader()

Definition at line 242 of file qgspointcloud3dsymbol.cpp.

◆ setColorRampShaderMinMax()

void QgsColorRampPointCloud3DSymbol::setColorRampShaderMinMax ( double  min,
double  max 
)

Sets the minimum and maximum values used when classifying colors in the color ramp shader.

See also
colorRampShaderMin() colorRampShaderMax()

Definition at line 247 of file qgspointcloud3dsymbol.cpp.

◆ symbolType()

QString QgsColorRampPointCloud3DSymbol::symbolType ( ) const
overridevirtual

Returns a unique string identifier of the symbol type.

Implements QgsPointCloud3DSymbol.

Definition at line 198 of file qgspointcloud3dsymbol.cpp.

◆ writeXml()

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

Definition at line 203 of file qgspointcloud3dsymbol.cpp.


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