class MDeviceChannel

Jump to documentation

Input device channel (OpenMayaUI) (OpenMayaUI.py)

public members:

MDeviceChannel ( const MString &, MDeviceChannel * = NULL, int = -1 )
~MDeviceChannel ()
MString name () const
MString longName () const
int axisIndex () const
bool hasChildren () const
MDeviceChannel parent () const
MDeviceChannel childByIndex ( int )
int numChildren () const

Documentation

Description

Input device channel class.

Functions

MDeviceChannel:: MDeviceChannel ( const MString & name , MDeviceChannel * parent , int index )

Description

Constructor.
Creates a new device channel with the given name, index and parent (optional).

Arguments

  • name the name of the channel
  • parent the parent of the channel (default is NULL)
  • index The device state index for the channel

MDeviceChannel:: ~MDeviceChannel ()

Description

Class destructor.

MString MDeviceChannel:: name () const

Description

Return the short name of the channel.

Return value

  • The short name for this channel

MString MDeviceChannel:: longName () const

Description

Return the int name of the channel.

Return value

  • The int name for this channel

int MDeviceChannel:: axisIndex () const

Description

Returns the device state index corresponding to this device channel.

Return value

  • The device state index for this channel

bool MDeviceChannel:: hasChildren () const

Description

Determine whether this channel has children.

Return value

  • true this channel has children
  • false this channel does not have children

MDeviceChannel MDeviceChannel:: parent () const

Description

Return the parent of this channel.

Return value

  • The parent of this channel

MDeviceChannel MDeviceChannel:: childByIndex ( int index )

Description

Return the specified child of this channel.

Return value

  • The child of this channel

int MDeviceChannel:: numChildren () const

Description

Return the number of children of this channel.

Return value

  • The number of children of this channel

This class has no child classes.


Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright