Base class for point clouds. More...

Inherited by DensePointCloud, and SparsePointCloud.

Public Member Functions
void	Dispose ()
	IDisposable implementation.

PointCloud	Clone ()
	Creates a new point cloud which is a copy of this point cloud.

IEnumerable< T >	TryEnumeratePointsAs< T > ()
	Tries to get the points of this point cloud.

Static Public Member Functions
static PointCloud	FromFile (string fileName)
	Loads a point cloud from the given fileName .

static PointCloud	FromFile (string fileName, PointCloudFlags flags)
	Loads a point cloud from the given fileName with the specified flags .

static PointCloud	FromComposite (Composite obj)
	Create a point cloud from the given Composite obj .

static PointCloud	FromHandle (IntPtr handle, ShareObject doShare)
	Creates a point cloud from the given handle .

static PointCloud	FromMemory< T > (byte[] buffer, FileFormat fileFormat)
	Creates a point cloud from the given buffer buffer.

static PointCloud	FromMemory (byte[] buffer, PointCloudFlags flags, FileFormat fileFormat)
	Creates a point cloud from the given buffer buffer.

static PointCloud	FromMemory< T > (IntPtr buffer, long bufferSize, FileFormat fileFormat)
	Creates a point cloud from the given buffer buffer.

static PointCloud	FromMemory (IntPtr buffer, long bufferSize, PointCloudFlags flags, FileFormat fileFormat)
	Creates a point cloud from the given buffer buffer.

Protected Member Functions
	PointCloud (IntPtr handle)
	Constructor.

	PointCloud (IntPtr handle, UseMemoryPressure useMemoryPressure)
	Constructor.

virtual void	Dispose (bool disposing)
	IDisposable helper function.

Properties
IntPtr	Handle `[get]`
	Native handle of the PointCloud.

bool	IsDisposed `[get]`
	Gets if the native handle has been disposed.

PointCloudLayout	Layout `[get]`
	The layout of the buffer / planes.

DataType	DataType `[get]`
	The data type.

long	NumPoints `[get]`
	Number of points.

ComponentsPointer3D	PointComponents `[get]`
	The pointer components for the points.

PlaneEnumerator	Planes `[get]`
	Gets all the component planes of this point cloud.

Events
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method.

Events inherited from INativeHandle
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method.

Detailed Description

Base class for point clouds.

Constructor & Destructor Documentation

◆ PointCloud() [1/2]

PointCloud ( IntPtr handle )

protected

Constructor.

Parameters

handle Native handle to the PointCloud.

Exceptions

ArgumentException When handle is IntPtr.Zero.

◆ PointCloud() [2/2]

PointCloud	(	IntPtr	handle,
		UseMemoryPressure	useMemoryPressure )

protected

Constructor.

Parameters

handle	Native handle to the PointCloud.
useMemoryPressure	Guesses memory pressure if UseMemoryPressure.Yes is set.

Exceptions

ArgumentException When handle is IntPtr.Zero.

Member Function Documentation

◆ Clone()

PointCloud Clone ( )

Creates a new point cloud which is a copy of this point cloud.

Attention: The duplicated point cloud may have a different point cloud layout.

Returns: Copy of this point cloud.

Exceptions

CvbException When duplicating the point cloud failed.

◆ Dispose()

virtual void Dispose ( bool disposing )

protectedvirtual

IDisposable helper function.

Parameters

disposing

◆ FromComposite()

static PointCloud FromComposite ( Composite obj )

static

Create a point cloud from the given Composite obj .

Parameters

obj	Composite from which a point cloud is to be created.

Returns: New PointCloud object.

◆ FromFile() [1/2]

static PointCloud FromFile ( string fileName )

static

Loads a point cloud from the given fileName .

Parameters

fileName File to load the point cloud from.

Returns: Loaded point cloud.

Exceptions

CvbException When loading the point cloud failed.

◆ FromFile() [2/2]

static PointCloud FromFile	(	string	fileName,
		PointCloudFlags	flags )

static

Loads a point cloud from the given fileName with the specified flags .

Parameters

fileName	File to load the point cloud from.
flags	Flags to load the point cloud with.

Returns: Loaded point cloud.

Exceptions

CvbException When loading the point cloud failed.

◆ FromHandle()

static PointCloud FromHandle	(	IntPtr	handle,
		ShareObject	doShare )

static

Creates a point cloud from the given handle .

Parameters

handle	Handle to create point cloud with.
doShare	Share ownership or adopt it.

Returns: Created point cloud.

Exceptions

ArgumentException When handle is IntPtr.Zero.

◆ FromMemory() [1/2]

static PointCloud FromMemory	(	byte[]	buffer,
		PointCloudFlags	flags,
		FileFormat	fileFormat )

static

Creates a point cloud from the given buffer buffer.

Parameters

buffer	Buffer containing the point cloud data.
flags	Flags of the point cloud to create.
fileFormat	File format of the buffer data.

Returns: Created point cloud.

Exceptions

ArgumentNullException	When buffer is null.
ArgumentException	When buffer is empty.
CvbException	When an error during point cloud creation occurs.

◆ FromMemory() [2/2]

static PointCloud FromMemory	(	IntPtr	buffer,
		long	bufferSize,
		PointCloudFlags	flags,
		FileFormat	fileFormat )

static

Creates a point cloud from the given buffer buffer.

Parameters

buffer	Buffer containing the point cloud data.
bufferSize	Size of the buffer .
flags	Flags of the point cloud to create.
fileFormat	File format of the buffer data.

Returns: Created point cloud.

Exceptions

CvbException When an error during point cloud creation occurs.

◆ FromMemory< T >() [1/2]

static PointCloud FromMemory< T >	(	byte[]	buffer,
		FileFormat	fileFormat )

static

Creates a point cloud from the given buffer buffer.

Template Parameters

T	Point type used by the cloud.

Parameters

buffer	Buffer containing the point cloud data.
fileFormat	File format of the buffer data.

Returns: Created point cloud.

Exceptions

ArgumentNullException	When buffer is null.
ArgumentException	When buffer is empty.
CvbException	When an error during point cloud creation occurs.

Type Constraints

T

:

struct

◆ FromMemory< T >() [2/2]

static PointCloud FromMemory< T >	(	IntPtr	buffer,
		long	bufferSize,
		FileFormat	fileFormat )

static

Creates a point cloud from the given buffer buffer.

Template Parameters

T	Point type used by the cloud.

Parameters

buffer	Buffer containing the point cloud data.
bufferSize	Size of the buffer .
fileFormat	File format of the buffer data.

Returns: Created point cloud.

Exceptions

CvbException When an error during point cloud creation occurs.

Type Constraints

T

:

struct

◆ TryEnumeratePointsAs< T >()

IEnumerable< T > TryEnumeratePointsAs< T > ( )

Tries to get the points of this point cloud.

Template Parameters

T	Type to try to get the points in.

Returns: The points (or empty IEnumerable<T>, when the points could not be gotten).

Type Constraints

T

:

struct

Event Documentation

◆ ObjectDisposing

NativeHandleEventDelegate ObjectDisposing

Raised when this object is about to be disposed via the IDisposable.Dispose method.

This event is raised right before this object is disposed. The dispose itself cannot be canceled.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ PointCloud() [1/2]

◆ PointCloud() [2/2]

Member Function Documentation

◆ Clone()

◆ Dispose()

◆ FromComposite()

◆ FromFile() [1/2]

◆ FromFile() [2/2]

◆ FromHandle()

◆ FromMemory() [1/2]

◆ FromMemory() [2/2]

◆ FromMemory< T >() [1/2]

◆ FromMemory< T >() [2/2]

◆ TryEnumeratePointsAs< T >()

Event Documentation

◆ ObjectDisposing