IMaskPattern

IMaskPattern is an 8x8 image pattern of 1-bit color depth (black = transparent, white = solid). The IMaskPattern class provides an 8x8 image pattern of 1-bit color depth (black = transparent, white = solid).


IMaskPattern - Member Functions and Data by Group

Constructors & Destructor

Use these constructors and destructor to create and destroy objects of class IMaskPattern.


[view class]
~IMaskPattern
public:
~IMaskPattern()
Destructor. Releases the memory allocated for data members.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IMaskPattern


Overload 1
Constructs a custom pattern using the 8x8 grid of bits supplied.
public:
IMaskPattern( unsigned char row0, unsigned char row1, unsigned char row2, unsigned char row3, unsigned char row4, unsigned char row5, unsigned char row6, unsigned char row7 )
Use this constructor to create a custom IMaskPattern object.

row{i}
The values of the eight bits on row {i}.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
Copy constructor.
public:
IMaskPattern(const IMaskPattern& source)
Use this constructor to create an object of class IMaskPattern that is copied from the given one.

source
A constant reference to the pattern to be copied.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Assignment Operator

Use this operator to assign the given mask pattern to the source one.


[view class]
operator =
public:
IMaskPattern& operator =(const IMaskPattern& source)
Assignment operator.

source
A constant reference to the pattern to copy from.

Return
A non-const reference to the left-hand side object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Predefined Patterns

These members return predefined patterns of size 8x8 with 1-bit color depth.


[view class]
cross
public:
static const IMaskPattern& cross()
Pre-defined cross pattern.

Return
The pre-defined cross pattern.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
diagonalCross
public:
static const IMaskPattern& diagonalCross()
The pre-defined diagonal cross pattern.

Return
The pre-defined diagonal cross pattern.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
diagonalDown
public:
static const IMaskPattern& diagonalDown()
Pre-defined diagonal-down pattern.

Return
The pre-defined diagonal-down pattern.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
diagonalUp
public:
static const IMaskPattern& diagonalUp()
Pre-defined diagonal-up pattern.

Return
The pre-defined diagonal-up pattern.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
horizontal
public:
static const IMaskPattern& horizontal()
Pre-defined horizontal pattern.

Return
The pre-defined horizontal pattern.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
solid
public:
static const IMaskPattern& solid()
Pre-defined solid pattern.

Return
The pre-defined solid pattern.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
vertical
public:
static const IMaskPattern& vertical()
Pre-defined vertical pattern.

Return
The pre-defined vertical pattern.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Streaming an Object In and Out

Use the operators in this group to stream an IMaskPattern object in and out.


[view class]
operator <<=
public:
IDataStream& operator <<=(IDataStream& fromWhere)
Operator that streams a mask pattern object in from the specified stream.

fromWhere
A reference to the stream to read the mask pattern data from.

Return
The original stream.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator >>=
public:
IDataStream& operator >>=(IDataStream& toWhere) const
Use this operator to stream a mask pattern object out to the given stream.

toWhere
A reference to the stream to which the mask pattern is written.

Return
The original stream.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Testing Two Mask Patterns for Equality or Inequality

Use the equality and inequality operators in this group to test two mask patterns for equality.


[view class]
operator !=
public:
bool operator !=(const IMaskPattern&) const
Tests two IMaskPattern objects for inequality.

other
A constant reference to the IMaskPattern to be compared with.

Return
True if any pair of correponding bits in the two IMaskPattern objects have different values.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator ==
public:
bool operator ==(const IMaskPattern&) const
Tests two IMaskPattern objects for equality.

other
A constant reference to the IMaskPattern to be compared with.

Return
True if all the correponding bits in the two IMaskPattern objects have same value.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IMaskPattern - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data