C++ API Reference
|
Manipulate Cursors. More...
#include <MCursor.h>
Public Member Functions | |
MCursor (short width, short height, short hotSpotX, short hotSpotY, unsigned char *bits, unsigned char *mask) | |
Class constructor. More... | |
MCursor (const MCursor &other) | |
Copy constructor. More... | |
~MCursor () | |
The class destructor. | |
MCursor & | operator= (const MCursor &) |
Assignment operator. More... | |
bool | operator== (const MCursor &) const |
Equality operator. More... | |
bool | operator!= (const MCursor &) const |
Inequality operator. More... | |
Static Public Attributes | |
static const MCursor | defaultCursor |
Maya default cursor, the left arrow. | |
static const MCursor | crossHairCursor |
'+' cursor. | |
static const MCursor | doubleCrossHairCursor |
'+' cursor with double lines. | |
static const MCursor | editCursor |
Wedge-shaped arrow pointing left. | |
static const MCursor | pencilCursor |
Pencil shape. | |
static const MCursor | handCursor |
Open hand shaped cursor. | |
Manipulate Cursors.
The MCursor class implements a cursor class, and is used to pass all cursor arguments to Maya API methods.
The cursor image and mask are stored in xbm format to the constructor along with the cursor dimensions and the cursor hotspot.
MCursor | ( | short | width, |
short | height, | ||
short | hotSpotX, | ||
short | hotSpotY, | ||
unsigned char * | bits, | ||
unsigned char * | mask | ||
) |
Class constructor.
Create a new instance of an MCursor and initialize it with the given values.
[in] | width | the width of the cursor |
[in] | height | the height of the cursor |
[in] | hotSpotX | the x position of the hot spot (left is 1) |
[in] | hotSpotY | the y position of the hot spot (top is 1) |
[in] | bits | the cursor bitmap in xbm format |
[in] | mask | the cursor mask in xbm format |
bool operator== | ( | const MCursor & | other | ) | const |
Equality operator.
Allows 2 MCursors to be compared to see if they are identical.
[in] | other | the MCursor object to be compared with. |
bool operator!= | ( | const MCursor & | other | ) | const |
Inequality operator.
Allows 2 MCursors to be compared to see if they are not the same.
[in] | other | the MCursor object to be compared with. |