MCursor Class Reference
[OpenMayaUI - API module for user interface]

#include <MCursor.h>

Collaboration diagram for MCursor:

[legend]

List of all members.

---

Detailed Description

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.

Examples:

lassoTool.cpp.

Public Member Functions
	MCursor (short width, short height, short hotSpotX, short hotSpotY, unsigned char *bits, unsigned char *mask)
	MCursor (const MCursor &other)
	~MCursor ()
MCursor &	operator= (const MCursor &)
bool	operator== (const MCursor &) const
bool	operator!= (const MCursor &) const
Static Public Attributes
static MCursor	defaultCursor
	Maya default cursor, the left arrow.
static MCursor	crossHairCursor
	'+' cursor.
static MCursor	doubleCrossHairCursor
	'+' cursor with double lines.
static MCursor	editCursor
	Wedge-shaped arrow pointing left.
static MCursor	pencilCursor
	Pencil shape.
static MCursor	handCursor
	Open hand shaped cursor.

---

Constructor & Destructor Documentation

MCursor::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.

Parameters:

[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

MCursor::MCursor

(

const MCursor &

other

)

Copy constructor. Create a new MCursor instance and initialize it with the given cursor.

Parameters:

[in]

other

the MCursor to copy from.

MCursor::~MCursor

(

)

The class destructor.

---

Member Function Documentation

MCursor & MCursor::operator=

(

const MCursor &

other

)

Assignment operator. Allows assignment between MCursor instances.

Parameters:

[in]

other

the MCursor to copy from.

bool MCursor::operator==

(

const MCursor &

other

)

const

Equality operator. Allows 2 MCursors to be compared to see if they are identical.

Parameters:

[in]

other

the MCursor object to be compared with.

Returns:

• true if the objects are same.
• false if the objects are different.

bool MCursor::operator!=

(

const MCursor &

other

)

const

Inequality operator. Allows 2 MCursors to be compared to see if they are not the same.

Parameters:

[in]

other

the MCursor object to be compared with.

Returns:

• true if the objects are different.
• false if the objects are same.