class MPxMidiInputDevice

Jump to documentation

public members:

	MPxMidiInputDevice ()
virtual	~MPxMidiInputDevice ()
virtual MStatus	openDevice ()
virtual void	closeDevice ()
virtual void	nameAxes ()
virtual void	nameButtons ()
virtual MDeviceState *	deviceState ()
virtual MDeviceState *	deviceState ( MDevent& )
virtual MStatus	sendMessage ( const char* const messageType, const char* const messageParams )
virtual char*	getMessage ( const char* const messageType, char* messageResponse )
virtual void	doButtonEvents ( bool = true )
virtual void	doMovementEvents ( bool = true )
	MPxMidiInputDevice ( void * init )

protected members:

MStatus	setNamedButton ( const MString &, unsigned short )
MStatus	addChannel ( MDeviceChannel & )
MStatus	setDegreesOfFreedom ( int freedom )
MStatus	setNumberOfButtons ( int buttons )

Documentation

Description

This is the base class for user defined MIDI input devices.

Child classes of MPxMidiInputDevice should define:

• a constructor which defines number of buttons and axes
• nameAttributes() which names the buttons and axes (optional)
• deviceState() which turns a midi event into an MDeviceState or returns NULL if it is not a midi event from this device

Functions

MPxMidiInputDevice:: MPxMidiInputDevice ()

Description

MPxMidiInputDevice:: MPxMidiInputDevice ( void * init )

Description

MPxMidiInputDevice:: ~MPxMidiInputDevice ()

Description

MStatus MPxMidiInputDevice:: openDevice ()

Description

Open the midi device.

void MPxMidiInputDevice:: closeDevice ()

Description

Close the midi device.

void MPxMidiInputDevice:: nameAxes ()

Description

Assign names to the axes of the device.

void MPxMidiInputDevice:: nameButtons ()

Description

Assign names to the buttons of the device.

MDeviceState * MPxMidiInputDevice:: deviceState ()

Description

Return the current state of the input device.

MDeviceState * MPxMidiInputDevice:: deviceState ( MDevent& )

Description

If this midi event belongs to this device then fiil up the MDeviceState. Otherwise return NULL.
The user should override this method.

MStatus MPxMidiInputDevice:: sendMessage ( const char* const messageType, const char* const messageParams )

Description

User should override this method.

char* MPxMidiInputDevice:: getMessage ( const char* const messageType, char* messageResponse )

Description

User should override this method.

void MPxMidiInputDevice:: doButtonEvents ( bool val )

Description

This method is used to specify whether this device is accepting button events from its child.

void MPxMidiInputDevice:: doMovementEvents ( bool val )

Description

This method is used to specify whether this device is accepting movement input from its child.

MStatus MPxMidiInputDevice:: setNamedButton ( const MString & buttonName, unsigned short button )

Description

Set the name of the specified button.

MStatus MPxMidiInputDevice:: addChannel ( MDeviceChannel & channel )

Description

Add the given channel to this device.

MStatus MPxMidiInputDevice:: setDegreesOfFreedom ( int freedom )

Description

Set the degrees of freedom for this device.

MStatus MPxMidiInputDevice:: setNumberOfButtons ( int buttons )

Description

Set the number of buttons for this device.

This class has no child classes.