IMCControl Class Reference

Search for all occurrences

#include <mcapdev.h>

Inheritance diagram for IMCControl:

---

Class Description

See also:

Class Control, Class MCDeviceBinding.

Description:

If a motion capture controller has one of the following class IDs, then it can be cast into this class to give access to the controller's parameters.

POS_MOTION_CLASS_ID

ROT_MOTION_CLASS_ID

SCALE_MOTION_CLASS_ID

FLOAT_MOTION_CLASS_ID

POINT3_MOTION_CLASS_ID

Note that normally a developer will not call these methods.

All methods of this class are implemented by the system.

Public Member Functions
virtual BOOL	IsLiveOn ()=0
virtual BOOL	IsRecordOn ()=0
virtual int	NumDeviceBindings ()=0
virtual MCDeviceBinding *	GetDeviceBinding (int i)=0
virtual void	SetDeviceBinding (int i, MCDeviceBinding *b)=0
virtual void	GetValueLive (TimeValue t, void *val, GetSetMethod method)=0

---

Member Function Documentation

virtual BOOL IsLiveOn

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns TRUE if Live mode is on; otherwise FALSE. Live mode is invoked by pressing the 'Test' button in the Motion Capture user interface.

virtual BOOL IsRecordOn

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns TRUE if Record mode is on; otherwise FALSE. Record mode is set by pressin the 'Start' button in the Motion Capture user interface.

virtual int NumDeviceBindings

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the number of device bindings.

virtual MCDeviceBinding* GetDeviceBinding

(

int

i

)

[pure virtual]

Search for all occurrences

Remarks:

Returns a pointer to the 'i-th' device binding.

Parameters:

int i

Specifies which device binding to return.

virtual void SetDeviceBinding	(	int	i,
		MCDeviceBinding *	b
	)		[pure virtual]

Search for all occurrences

Remarks:

Sets the 'i-th' device bindings.

Parameters:

int i

Specifies which device binding to set.

MCDeviceBinding *b

Points to the device binding to set.

virtual void GetValueLive	(	TimeValue	t,
		void *	val,
		GetSetMethod	method
	)		[pure virtual]

Search for all occurrences

Remarks:

This method retrieves the value based on the current state of the device (not the value of the controller). For instance, say you have done some motion capture using a joystick plugged into a position motion capture controller. You can call GetValue() on the controller to get its recorded value (just like a keyframe controller), or you can call this method to get the actual state of the joystick.

Parameters:

TimeValue t

Specifies the time to update the value.

void *val

Points to the value that is updated. See Control::GetValue() for the data types returned here.

GetSetMethod method

One of the following values:

CTRL_RELATIVE

Indicates the plug-in should apply the value of the controller to *val.

CTRL_ABSOLUTE

Indicates the controller should simply store its value in *val.