dmIMaskBuffer Class Reference

Mask buffer and calculator. More...

#include <CCI_MaskBuffer.h>

Inherits dmINotify.

List of all members.

Public Member Functions

bool StoreMask (const dmRegion *mask, dm_uint index, dm_int op=0)
 Store a copy of the mask at buffer index index.
bool CallMask (dmRegion *mask, dm_uint index, dm_int op=0)
 Retrieve a copy of the mask at buffer index index.
bool ClearMask (dm_uint index)
 Clear the mask at buffer index index.
bool SetHeapSize (dm_uint size)
 Set the size of the mask heap.
bool GetMask (dmRegion *mask)
 Retrieve a copy of the default mask.
bool SetMask (const dmRegion *mask, dm_int op=0)
 Set the default mask.
bool KillMask ()
 Clear the default mask.
bool PushMask (const dmRegion *mask)
 Push a mask at the top of the stack.
bool QueueMask (const dmRegion *mask)
 Queue a mask at the bottom of the stack.
bool PopMask ()
 Pop the stack.
bool SwapMask (dmRegion *mask, dm_uint index=~0)
 Swap masks.
bool PopMaskOp (dm_int op, dmRegion *mask=NULL)
 do an arithmetic operation between mask and the top of the stack, then pop the stack.
bool RotateMask (dmRegion *mask)
 Rotate the stack. and involve mask as the top mask in the rotation.
bool ClearStack ()
 Clear the stack. Not that will physically destroy all the elements.
bool IsEmptyStack ()
 Check if the stack is empty.
dmRegion * TopMask ()
 Return a pointer to the top mask of the stack.
dmRegion * BottomMask ()
 Return a pointer to bottom mask of the stack.
dmRegion * DefaultMask ()
 Return a pointer to the default mask.
dm_uint HeapSize ()
 Return the size of the heap.
dm_uint MaskSize ()
 Return the size of of the default mask.
bool IsEmptyMask (dm_uint index=~0)
 Check if the mask at index is empty. If index is -1 then the default mask is checked.
dmRegion * GetBuffer (dm_uint index)
 Return a pointer to the mask at buffer index.


Detailed Description

Mask buffer and calculator.

This interface expose methods for a container for storing/retrieving masks (i.e regions) as for perfotming calulation on the stored elements. The object will hold a "Current mask" which will be used for calculation For most of the methods exposed, the mask parameter can be null, in this case, the default mask will be used unless specified otherwise.

The op parameter specifies which arithmetic operation should be performed between the source mask and the destination mask.


Member Function Documentation

bool dmIMaskBuffer::SwapMask dmRegion *  mask,
dm_uint  index = ~0
[inline]
 

Swap masks.

  • If mask is not null:
    1. If index is not -1 then swap is done between mask and the mask stored at index.
    2. If index is -1 then the swap is done between mask and the default mask.
  • If mask is null:
    1. If index is not -1 then swap is done between default mask and the mask stored at index.
    2. If index is -1 then the swap is done between the default mask and the top of the stack.


Generated on Tue May 9 12:34:57 2006 for Daim Library Module Set by  doxygen 1.4.6-NO