MDeviceChannel Class Reference
MDeviceChannel Class Reference
#include <MDeviceChannel.h>
Class Description
Input device channel.
Input device channel class.
Examples:
Public Member Functions | |
| MDeviceChannel (const MString &, MDeviceChannel *=NULL, int=-1) | |
| Constructor. More... | |
| ~MDeviceChannel () | |
| Class destructor. | |
| MString | name () const |
| Return the short name of the channel. More... | |
| MString | longName () const |
| Return the long name of the channel. More... | |
| int | axisIndex () const |
| Returns the device state index corresponding to this device channel. More... | |
| bool | hasChildren () const |
| Determine whether this channel has children. More... | |
| MDeviceChannel | parent () const |
| Return the parent of this channel. More... | |
| MDeviceChannel | childByIndex (int) |
| Return the specified child of this channel. More... | |
| int | numChildren () const |
| Return the number of children of this channel. More... | |
Friends | |
| class | MPxMidiInputDevice |
Constructor & Destructor Documentation
| OPENMAYA_MAJOR_NAMESPACE_OPEN MDeviceChannel | ( | const MString & | name, |
| MDeviceChannel * | parent = NULL, |
||
| int | index = -1 |
||
| ) |
Constructor.
Creates a new device channel with the given name, index and parent (optional).
- Parameters
-
[in] name the name of the channel [in] parent the parent of the channel (default is NULL) [in] index The device state index for the channel
Member Function Documentation
| MString name | ( | ) | const |
Return the short name of the channel.
- Returns
- The short name for this channel
| MString longName | ( | ) | const |
Return the long name of the channel.
- Returns
- The long name for this channel
| int axisIndex | ( | ) | const |
Returns the device state index corresponding to this device channel.
- Returns
- The device state index for this channel
| bool hasChildren | ( | ) | const |
Determine whether this channel has children.
- Returns
- true this channel has children
- false this channel does not have children
| MDeviceChannel parent | ( | ) | const |
Return the parent of this channel.
- Returns
- The parent of this channel
| MDeviceChannel childByIndex | ( | int | index | ) |
Return the specified child of this channel.
- Returns
- The child of this channel
| int numChildren | ( | ) | const |
Return the number of children of this channel.
- Returns
- The number of children of this channel
The documentation for this class was generated from the following files:
- MDeviceChannel.h
- MDeviceChannel.cpp