PyGenericCloud< GenericCloudBase > Class Template Reference

#include <cloudbase.h>

Inheritance diagram for PyGenericCloud< GenericCloudBase >:

Collaboration diagram for PyGenericCloud< GenericCloudBase >:

Public Member Functions
unsigned	size () const override
	Returns the number of points. More...
void	forEach (cloudViewer::GenericCloud::genericPointAction action) override
	Fast iteration mechanism. More...
void	getBoundingBox (CCVector3 &bbMin, CCVector3 &bbMax) override
	Returns the cloud bounding box. More...
void	placeIteratorAtBeginning () override
	Sets the cloud iterator at the beginning. More...
const CCVector3 *	getNextPoint () override
	Returns the next point (relatively to the global iterator position) More...
bool	enableScalarField () override
	Enables the scalar field associated to the cloud. More...
bool	isScalarFieldEnabled () const override
	Returns true if the scalar field is enabled, false otherwise. More...
void	setPointScalarValue (unsigned pointIndex, ScalarType value) override
	Sets the ith point associated scalar value. More...
ScalarType	getPointScalarValue (unsigned pointIndex) const override
	Returns the ith point associated scalar value. More...
Public Member Functions inherited from cloudViewer::GenericCloud
	GenericCloud ()=default
	Default constructor. More...
virtual	~GenericCloud ()=default
	Default destructor. More...
virtual bool	hasPoints () const
virtual unsigned char	testVisibility (const CCVector3 &P) const

Additional Inherited Members
Public Types inherited from cloudViewer::GenericCloud
using	genericPointAction = std::function< void(const CCVector3 &, ScalarType &)>
	Generic function applied to a point (used by foreach) More...

Detailed Description

template<class GenericCloudBase = cloudViewer::GenericCloud>
class PyGenericCloud< GenericCloudBase >

Definition at line 19 of file cloudbase.h.

Member Function Documentation

enableScalarField()

template<class GenericCloudBase = cloudViewer::GenericCloud>

bool PyGenericCloud< GenericCloudBase >::enableScalarField ( )

inlineoverridevirtual

Enables the scalar field associated to the cloud.

If the scalar field structure is not yet initialized/allocated, this method gives the signal for its creation. Otherwise, if possible the structure size should be pre-reserved with the same number of elements as the point cloud.

Implements cloudViewer::GenericCloud.

Definition at line 40 of file cloudbase.h.

forEach()

template<class GenericCloudBase = cloudViewer::GenericCloud>

void PyGenericCloud< GenericCloudBase >::forEach ( cloudViewer::GenericCloud::genericPointAction  action )

inlineoverridevirtual

Fast iteration mechanism.

Virtual method to apply a function to the whole cloud

Parameters

action

the function to apply (see GenericCloud::genericPointAction)

Implements cloudViewer::GenericCloud.

Definition at line 26 of file cloudbase.h.

getBoundingBox()

template<class GenericCloudBase = cloudViewer::GenericCloud>

void PyGenericCloud< GenericCloudBase >::getBoundingBox ( CCVector3 &  bbMin, CCVector3 &  bbMax  )

inlineoverridevirtual

Returns the cloud bounding box.

Virtual method to request the cloud bounding box limits

Parameters

bbMin	lower bounding-box limits (Xmin,Ymin,Zmin)
bbMax	higher bounding-box limits (Xmax,Ymax,Zmax)

Implements cloudViewer::GenericCloud.

Definition at line 31 of file cloudbase.h.

getNextPoint()

template<class GenericCloudBase = cloudViewer::GenericCloud>

const CCVector3* PyGenericCloud< GenericCloudBase >::getNextPoint ( )

inlineoverridevirtual

Returns the next point (relatively to the global iterator position)

Virtual method to handle the cloud global iterator. Global iterator position should be increased by one each time this method is called. Warning:

• the returned object may not be persistent!
• THIS METHOD MAY NOT BE COMPATIBLE WITH PARALLEL STRATEGIES (see the DgmOctree::executeFunctionForAllCellsAtLevel_MT and DgmOctree::executeFunctionForAllCellsAtStartingLevel_MT methods).

  Returns

  pointer on next point (or 0 if no more)

Implements cloudViewer::GenericCloud.

Definition at line 37 of file cloudbase.h.

getPointScalarValue()

template<class GenericCloudBase = cloudViewer::GenericCloud>

ScalarType PyGenericCloud< GenericCloudBase >::getPointScalarValue ( unsigned  pointIndex ) const

inlineoverridevirtual

Returns the ith point associated scalar value.

Implements cloudViewer::GenericCloud.

Definition at line 49 of file cloudbase.h.

isScalarFieldEnabled()

template<class GenericCloudBase = cloudViewer::GenericCloud>

bool PyGenericCloud< GenericCloudBase >::isScalarFieldEnabled ( ) const

inlineoverridevirtual

Returns true if the scalar field is enabled, false otherwise.

Implements cloudViewer::GenericCloud.

Definition at line 43 of file cloudbase.h.

placeIteratorAtBeginning()

template<class GenericCloudBase = cloudViewer::GenericCloud>

void PyGenericCloud< GenericCloudBase >::placeIteratorAtBeginning ( )

inlineoverridevirtual

Sets the cloud iterator at the beginning.

Virtual method to handle the cloud global iterator

Implements cloudViewer::GenericCloud.

Definition at line 34 of file cloudbase.h.

setPointScalarValue()

template<class GenericCloudBase = cloudViewer::GenericCloud>

void PyGenericCloud< GenericCloudBase >::setPointScalarValue ( unsigned  pointIndex, ScalarType  value  )

inlineoverridevirtual

Sets the ith point associated scalar value.

Implements cloudViewer::GenericCloud.

Definition at line 46 of file cloudbase.h.

size()

template<class GenericCloudBase = cloudViewer::GenericCloud>

unsigned PyGenericCloud< GenericCloudBase >::size ( ) const

inlineoverridevirtual

Returns the number of points.

Virtual method to request the cloud size

Returns

the cloud size

Implements cloudViewer::GenericCloud.

Definition at line 23 of file cloudbase.h.

---

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

• /root/ACloudViewer/libs/Python/pybind/geometry/cloudbase.h