Plane Class Reference

A single linear plane of component data. More...

Inherits INativeHandle.

Public Member Functions
void	Dispose ()
	IDisposable implementation.
IntPtr	GetIncrement (int dimension)
	Gets the number of elements at the given dimension .
long	GetLength (int dimension)
	Gets the number of elements at the given dimension .

Static Public Member Functions
static Plane	FromHandle (IntPtr handle, ShareObject doShare)
	Create a plane object from a handle .
static Plane	FromImagePlane (ImagePlane imagePlane, PlaneRole role)
	Creates a plane from an image plane.

Protected Member Functions
	Plane (IntPtr handle)
	Create a plane object from a handle .
	Plane (IntPtr handle, IntPtr sharedImagePlaneHandle)
	Constructor.
virtual void	Dispose (bool disposing)
	IDispose helper function.

Properties
IntPtr	Handle [get]
	Native CVB buffer handle.
bool	IsDisposed [get]
	Tests if the native handle has already been disposed.
PlaneRole	Role [get]
	Gets the PlaneRole of this plane.
DataType	DataType [get]
	Gets the CVB DataType for this plane.
IntPtr	BasePtr [get]
	Get the base address of the plane's memory.
int	Rank [get]
	Get the rank of the plane.

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

A single linear plane of component data.

Constructor & Destructor Documentation

Plane() [1/2]

Plane ( IntPtr handle )

protected

Create a plane object from a handle .

Parameters

handle

Native IBuffer handle.

Plane() [2/2]

Plane ( IntPtr handle, IntPtr sharedImagePlaneHandle )

protected

Constructor.

Parameters

handle	Native IBuffer handle.
sharedImagePlaneHandle	Native handle of the ImagePlane the handle was created with.

Member Function Documentation

Dispose() [1/2]

void Dispose

(

)

IDisposable implementation.

Call this method to release the resources allocated by this buffer immediately. Remember that after calling Dispose, any subsequent access to references to this buffer will result in an ObjectDisposedException.

Dispose() [2/2]

virtual void Dispose ( bool disposing )

protectedvirtual

IDispose helper function.

Parameters

disposing

true when called via IDisposable.Dispose, false when called by the finalizer.

FromHandle()

static Plane FromHandle ( IntPtr handle, ShareObject doShare )

static

Create a plane object from a handle .

Parameters

handle	Native IBuffer handle.
doShare	ShareObject.Yes if handle should be shared.

Returns

Newly created wrapper object.

FromImagePlane()

static Plane FromImagePlane ( ImagePlane imagePlane, PlaneRole role )

static

Creates a plane from an image plane.

Parameters

imagePlane	The image plane.
role	The role of this plane.

Returns

The created plane.

Exceptions

ArgumentException	When imagePlane does not support linear access.
CvbException	When an error during plane creation occurs.

GetIncrement()

IntPtr GetIncrement

(

int

dimension

)

Gets the number of elements at the given dimension .

Parameters

dimension

Dimension to get length for; e.g. 0 for x-values.

Returns

The number of elements in the given dimension .

GetLength()

long GetLength

(

int

dimension

)

Gets the number of elements at the given dimension .

Parameters

dimension

Dimension to get length for; e.g. 0 for x-values.

Returns

The number of elements in the given dimension .

Property Documentation

Handle

IntPtr Handle

get

Native CVB buffer handle.

It is normally not necessary to work with this handle in CVB.Net. Note that using this handle in connection with the legacy CVB managed wrappers may actually be disruptive to your application.

Implements INativeHandle.

Rank

int Rank

get

Get the rank of the plane.

The rank is the number of dimensions in the plane. E.g. 2 for an image.

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.