#include
<MDeviceState.h>
List of all
members.
Detailed Description
Input device state.
MDeviceState is a generic event class for
input devices. Input device classes (such as MPxMidiInputDevice) are responsible for
converting specific event types to an MDeviceState which Maya understands.
Constructor & Destructor Documentation
MDeviceState::~MDeviceState |
( |
|
) |
[virtual] |
Member Function Documentation
int MDeviceState::devicePosition |
( |
const unsigned short int |
axis |
) |
const |
Returns the position of the device for the specified axis.
- Parameters:
-
[in] |
axis |
The device axis to be tested |
- Returns:
- The position of the device for the specified axis
int MDeviceState::devicePosition |
( |
const MString & |
axisName |
) |
const |
Returns the position of the device for the specified axis.
- Parameters:
-
[in] |
axisName |
The name of the device axis to be tested |
- Returns:
- The position of the device for the specified axis
void MDeviceState::setDevicePosition |
( |
const int |
position, |
|
|
const unsigned short int |
axis |
|
|
) |
|
|
|
Sets the position of the device for the specified axis.
- Parameters:
-
[in] |
position |
The new position value |
[in] |
axis |
The axis of the device to be set |
void MDeviceState::setDevicePosition |
( |
const int |
position, |
|
|
const MString & |
axis |
|
|
) |
|
|
|
Sets the position of the device for the specified axis.
- Parameters:
-
[in] |
position |
The new position value |
[in] |
axis |
The name of the axis of the device to be set |
bool MDeviceState::buttonState |
( |
const unsigned short int |
button |
) |
const |
Returns the state of the given button.
- Parameters:
-
[in] |
button |
The number of the button to be tested |
- Returns:
-
- true button pressed
- false button released
bool MDeviceState::buttonState |
( |
const MString & |
buttonName |
) |
const |
Returns the state of the named button.
- Parameters:
-
[in] |
buttonName |
The name of the button to be tested |
- Returns:
-
- true button pressed
- false button released
void MDeviceState::setButtonState |
( |
const bool |
state, |
|
|
const unsigned short int |
button |
|
|
) |
|
|
|
Set the state of the specified button.
- Parameters:
-
[in] |
state |
The state to be set (true or false) |
[in] |
button |
The button number |
void MDeviceState::setButtonState |
( |
const bool |
state, |
|
|
const MString & |
buttonName |
|
|
) |
|
|
|
Set the state of the specified button.
- Parameters:
-
[in] |
state |
The state to be set (true or false) |
[in] |
buttonName |
The name of the button to be set |
int MDeviceState::maxAxis |
( |
|
) |
const |
Return the value of the axis with the largest value. This is
used to dejitter absolute devices.
- Returns:
- The value of the largest axis
bool MDeviceState::isNull |
( |
|
) |
|
Returns true if this device state is NULL;
- Returns:
-
- true The device state is NULL
- false The device state is not NULL