QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsPointCloudIndex Class Referenceabstract

Represents a indexed point clouds data in octree. More...

#include <qgspointcloudindex.h>

Inheritance diagram for QgsPointCloudIndex:
Inheritance graph
[legend]

Public Member Functions

 QgsPointCloudIndex ()
 Constructs index. More...
 
 ~QgsPointCloudIndex ()
 
QgsPointCloudAttributeCollection attributes () const
 Returns all attributes that are stored in the file. More...
 
QgsRectangle extent () const
 Returns extent of the data. More...
 
bool hasNode (const IndexedPointCloudNode &n) const
 Returns whether the octree contain given node. More...
 
virtual bool isValid () const =0
 Returns whether index is loaded and valid. More...
 
virtual void load (const QString &fileName)=0
 Loads the index from the file. More...
 
QgsPointCloudDataBounds nodeBounds (const IndexedPointCloudNode &node) const
 Returns bounds of particular node. More...
 
QList< IndexedPointCloudNodenodeChildren (const IndexedPointCloudNode &n) const
 Returns all children of node. More...
 
virtual QgsPointCloudBlocknodeData (const IndexedPointCloudNode &n, const QgsPointCloudRequest &request)=0
 Returns node data block. More...
 
float nodeError (const IndexedPointCloudNode &n) const
 Returns node's error in map units (used to determine in whether the node has enough detail for the current view) More...
 
QgsRectangle nodeMapExtent (const IndexedPointCloudNode &node) const
 Returns the extent of a node in map coordinates. More...
 
int nodePointCount (const IndexedPointCloudNode &n)
 Returns the number of poiny of indexed point cloud node n. More...
 
QgsDoubleRange nodeZRange (const IndexedPointCloudNode &node) const
 Returns the z range of a node. More...
 
QgsVector3D offset () const
 Returns offset. More...
 
IndexedPointCloudNode root ()
 Returns root node of the index. More...
 
QgsVector3D scale () const
 Returns scale. More...
 
int span () const
 Returns the number of points in one direction in a single node. More...
 
double zMax () const
 Returns z max. More...
 
double zMin () const
 Returns z min. More...
 

Protected Member Functions

void setAttributes (const QgsPointCloudAttributeCollection &attributes)
 Sets native attributes of the data. More...
 

Protected Attributes

QgsPointCloudAttributeCollection mAttributes
 
QgsRectangle mExtent
 2D extent of data More...
 
QHash< IndexedPointCloudNode, int > mHierarchy
 Data hierarchy. More...
 
QgsVector3D mOffset
 Offset of our int32 coordinates compared to CRS coords. More...
 
QgsPointCloudDataBounds mRootBounds
 Bounds of the root node's cube (in int32 coordinates) More...
 
QgsVector3D mScale
 Scale of our int32 coordinates compared to CRS coords. More...
 
int mSpan
 All native attributes stored in the file. More...
 
double mZMax = 0
 Vertical extent of data. More...
 
double mZMin = 0
 

Detailed Description

Represents a indexed point clouds data in octree.

Note
The API is considered EXPERIMENTAL and can be changed without a notice
Since
QGIS 3.18

Definition at line 148 of file qgspointcloudindex.h.

Constructor & Destructor Documentation

◆ QgsPointCloudIndex()

QgsPointCloudIndex::QgsPointCloudIndex ( )
explicitdefault

Constructs index.

◆ ~QgsPointCloudIndex()

QgsPointCloudIndex::~QgsPointCloudIndex ( )
default

Member Function Documentation

◆ attributes()

QgsPointCloudAttributeCollection QgsPointCloudIndex::attributes ( ) const

Returns all attributes that are stored in the file.

Definition at line 172 of file qgspointcloudindex.cpp.

◆ extent()

QgsRectangle QgsPointCloudIndex::extent ( ) const
inline

Returns extent of the data.

Definition at line 187 of file qgspointcloudindex.h.

◆ hasNode()

bool QgsPointCloudIndex::hasNode ( const IndexedPointCloudNode n) const
inline

Returns whether the octree contain given node.

Definition at line 166 of file qgspointcloudindex.h.

◆ isValid()

virtual bool QgsPointCloudIndex::isValid ( ) const
pure virtual

Returns whether index is loaded and valid.

◆ load()

virtual void QgsPointCloudIndex::load ( const QString &  fileName)
pure virtual

Loads the index from the file.

◆ nodeBounds()

QgsPointCloudDataBounds QgsPointCloudIndex::nodeBounds ( const IndexedPointCloudNode node) const

Returns bounds of particular node.

Definition at line 177 of file qgspointcloudindex.cpp.

◆ nodeChildren()

QList< IndexedPointCloudNode > QgsPointCloudIndex::nodeChildren ( const IndexedPointCloudNode n) const

Returns all children of node.

Definition at line 153 of file qgspointcloudindex.cpp.

◆ nodeData()

virtual QgsPointCloudBlock* QgsPointCloudIndex::nodeData ( const IndexedPointCloudNode n,
const QgsPointCloudRequest request 
)
pure virtual

Returns node data block.

e.g. positions (needs to be scaled and offset applied to get coordinates) or classification, intensity or custom attributes

It is caller responsibility to free the block.

May return nullptr in case the node is not present or any other problem with loading

◆ nodeError()

float QgsPointCloudIndex::nodeError ( const IndexedPointCloudNode n) const

Returns node's error in map units (used to determine in whether the node has enough detail for the current view)

Definition at line 206 of file qgspointcloudindex.cpp.

◆ nodeMapExtent()

QgsRectangle QgsPointCloudIndex::nodeMapExtent ( const IndexedPointCloudNode node) const

Returns the extent of a node in map coordinates.

See also
nodeZRange()

Definition at line 196 of file qgspointcloudindex.cpp.

◆ nodePointCount()

int QgsPointCloudIndex::nodePointCount ( const IndexedPointCloudNode n)

Returns the number of poiny of indexed point cloud node n.

Definition at line 232 of file qgspointcloudindex.cpp.

◆ nodeZRange()

QgsDoubleRange QgsPointCloudIndex::nodeZRange ( const IndexedPointCloudNode node) const

Returns the z range of a node.

See also
nodeMapExtent()

Definition at line 201 of file qgspointcloudindex.cpp.

◆ offset()

QgsVector3D QgsPointCloudIndex::offset ( ) const

Returns offset.

Definition at line 217 of file qgspointcloudindex.cpp.

◆ root()

IndexedPointCloudNode QgsPointCloudIndex::root ( )
inline

Returns root node of the index.

Definition at line 163 of file qgspointcloudindex.h.

◆ scale()

QgsVector3D QgsPointCloudIndex::scale ( ) const

Returns scale.

Definition at line 212 of file qgspointcloudindex.cpp.

◆ setAttributes()

void QgsPointCloudIndex::setAttributes ( const QgsPointCloudAttributeCollection attributes)
protected

Sets native attributes of the data.

Definition at line 222 of file qgspointcloudindex.cpp.

◆ span()

int QgsPointCloudIndex::span ( ) const

Returns the number of points in one direction in a single node.

Definition at line 227 of file qgspointcloudindex.cpp.

◆ zMax()

double QgsPointCloudIndex::zMax ( ) const
inline

Returns z max.

Definition at line 192 of file qgspointcloudindex.h.

◆ zMin()

double QgsPointCloudIndex::zMin ( ) const
inline

Returns z min.

Definition at line 190 of file qgspointcloudindex.h.

Member Data Documentation

◆ mAttributes

QgsPointCloudAttributeCollection QgsPointCloudIndex::mAttributes
protected

Definition at line 241 of file qgspointcloudindex.h.

◆ mExtent

QgsRectangle QgsPointCloudIndex::mExtent
protected

2D extent of data

Definition at line 234 of file qgspointcloudindex.h.

◆ mHierarchy

QHash<IndexedPointCloudNode, int> QgsPointCloudIndex::mHierarchy
protected

Data hierarchy.

Definition at line 237 of file qgspointcloudindex.h.

◆ mOffset

QgsVector3D QgsPointCloudIndex::mOffset
protected

Offset of our int32 coordinates compared to CRS coords.

Definition at line 239 of file qgspointcloudindex.h.

◆ mRootBounds

QgsPointCloudDataBounds QgsPointCloudIndex::mRootBounds
protected

Bounds of the root node's cube (in int32 coordinates)

Definition at line 240 of file qgspointcloudindex.h.

◆ mScale

QgsVector3D QgsPointCloudIndex::mScale
protected

Scale of our int32 coordinates compared to CRS coords.

Definition at line 238 of file qgspointcloudindex.h.

◆ mSpan

int QgsPointCloudIndex::mSpan
protected

All native attributes stored in the file.

Number of points in one direction in a single node

Definition at line 242 of file qgspointcloudindex.h.

◆ mZMax

double QgsPointCloudIndex::mZMax = 0
protected

Vertical extent of data.

Definition at line 235 of file qgspointcloudindex.h.

◆ mZMin

double QgsPointCloudIndex::mZMin = 0
protected

Definition at line 235 of file qgspointcloudindex.h.


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