Powertek.Imaging.PtBitmapStack Class Reference

Class for handling bitmaps in a stack form. More...

List of all members.

Public Member Functions
	PtBitmapStack (int stackSize)
void	Clear ()
void	Push (Bitmap bmp)
Bitmap	GetPrevious ()
bool	PrevPossible ()
Bitmap	GetNext ()
bool	NextPossible ()
Bitmap	Pop ()
bool	GetBitmapAtIndex (int id, out Bitmap bmp)
int	GetMaxStackIndex ()
int	GetCurrentIndex ()
int	GetAddCount ()
Properties
bool	IsEmpty [get]

---

Detailed Description

---

Constructor & Destructor Documentation

Powertek.Imaging.PtBitmapStack.PtBitmapStack

(

int

stackSize

)

Init the stack.

Parameters:

stackSize

Max number of Bitmaps in the stack

---

Member Function Documentation

void Powertek.Imaging.PtBitmapStack.Clear

(

)

Clear the stack.

int Powertek.Imaging.PtBitmapStack.GetAddCount

(

)

Get the number of added bitmaps.

Returns:

bool Powertek.Imaging.PtBitmapStack.GetBitmapAtIndex	(	int	id,
		out Bitmap	bmp
	)

Returns the bitmap at the given stack index.

Parameters:

	id	Stack index
	bmp	The Bitmap at the stack index

Returns:

False on error else true

int Powertek.Imaging.PtBitmapStack.GetCurrentIndex

(

)

Get the current internal stack index.

Returns:

int Powertek.Imaging.PtBitmapStack.GetMaxStackIndex

(

)

Get the current internal maximum stack index (not equal with bitmap count).

Returns:

Bitmap Powertek.Imaging.PtBitmapStack.GetNext

(

)

Set the stackpointer one element up and return the bitmap at this position (if there is one).

Returns:

The bitmap or null, if no bitmap is available

Bitmap Powertek.Imaging.PtBitmapStack.GetPrevious

(

)

This will set the stackpointer one element down and return the bitmap at this position (if there is one) This will return null, if no bitmap is available.

Returns:

bool Powertek.Imaging.PtBitmapStack.NextPossible

(

)

Check, if there is a valid next bitmap.

Returns:

Bitmap Powertek.Imaging.PtBitmapStack.Pop

(

)

get an bitmap from stack, but only decrement the index, no bitmap will be removed

Returns:

The Bitmap or null if the stack is empty

bool Powertek.Imaging.PtBitmapStack.PrevPossible

(

)

Check, if there is a valid previous bitmap.

Returns:

void Powertek.Imaging.PtBitmapStack.Push

(

Bitmap

bmp

)

Push a bitmap on to the current stackindex (overwrite existing).

Parameters:

bmp

---

Property Documentation

bool Powertek.Imaging.PtBitmapStack.IsEmpty [get]

Check if there is a bitmap in the stack.

---

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

• pt_BitmapStack.cs