QuesaController.h


Discussion

Declares the Quesa controller interface.

This interface is available in Quesa, but has not been implemented due to lack of available pointing device hardware.

Functions


Q3ControllerState_New


( TQ3ControllerStateObject ) Q3ControllerState_New (
    TQ3ControllerRef controllerRef
);
Discussion

Create a new controller state object.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to query.
function result
A new controller state object.

Q3ControllerState_Restore


( TQ3Status ) Q3ControllerState_Restore (
    TQ3ControllerStateObject controllerStateObject
);
Discussion

Restore the state of the controller associated with controllerStateObject.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerStateObject
The controller state object to restore.
function result
Success or failure of the operation.

Q3ControllerState_SaveAndReset


( TQ3Status ) Q3ControllerState_SaveAndReset (
    TQ3ControllerStateObject controllerStateObject
);
Discussion

Save the current state of the controller associated with controllerStateObject.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerStateObject
The controller state object to save.
function result
Success or failure of the operation.

Q3Controller_Decommission


( TQ3Status ) Q3Controller_Decommission (
    TQ3ControllerRef controllerRef
);
Discussion

Make a controller object inactive.

Any remaining references to the controller object will remain valid, however the controller will no longer be operational.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to deactivate.
function result
Success or failure of the operation.

Q3Controller_GetActivation


( TQ3Status ) Q3Controller_GetActivation (
    TQ3ControllerRef controllerRef,
    TQ3Boolean *active
);
Discussion

Get the activation state of a controller.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to query.
active
Receives the current activation state of the controller.
function result
Success or failure of the operation.

Q3Controller_GetButtons


( TQ3Status ) Q3Controller_GetButtons (
    TQ3ControllerRef controllerRef,
    TQ3Uns32 *buttons
);
Discussion

Get the button state of a controller.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to query.
buttons
Receives the button state of the controller.
function result
Success or failure of the operation.

Q3Controller_GetChannel


( TQ3Status ) Q3Controller_GetChannel (
    TQ3ControllerRef controllerRef,
    TQ3Uns32 channel,
    void *data,
    TQ3Uns32 *dataSize
);
Discussion

Get the data for a controller channel.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to query.
channel
An index into the list of channels, from 0.
data
Receives the data for the channel.
dataSize
Initialise to the number of bytes pointed to by data, and will receive the number of bytes written to data by the controller.
function result
Success or failure of the operation.

Q3Controller_GetListChanged


( TQ3Status ) Q3Controller_GetListChanged (
    TQ3Boolean *listChanged,
    TQ3Uns32 *serialNumber
);
Discussion

Determine if the list of available controllers has changed.

If the controller list has changed since the time at which the value of serialNumber was generated, listChanged will be set to true and a new serial number will be returned in serialNumber.

When calling for the first time, serialNumber should be 0.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
listChanged
Receives true or false as the list has changed.
serialNumber
Receives the current serial number, and should be initialised to the previously returned value on successive calls.
function result
Success or failure of the operation.

Q3Controller_GetSignature


( TQ3Status ) Q3Controller_GetSignature (
    TQ3ControllerRef controllerRef,
    char *signature,
    TQ3Uns32 numChars
);
Discussion

Get the signature of a controller.

At most numChars characters will be written to signature (including the NULL byte - signature will always be set to a valid C string). If there is not enough space to return the entire signature, it will be truncated.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to query.
signature
Receives the controller signature as a C string.
numChars
The number of bytes which may be written to signature.
function result
Success or failure of the operation.

Q3Controller_GetTrackerOrientation


( TQ3Status ) Q3Controller_GetTrackerOrientation (
    TQ3ControllerRef controllerRef,
    TQ3Quaternion *orientation
);
Discussion

Get the current orientation of a controller's tracker.

If no tracker is associated with the controller, the orientation of the system cursor tracker will be returned.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to query.
orientation
Receives the current orientation of the tracker.
function result
Success or failure of the operation.

Q3Controller_GetTrackerPosition


( TQ3Status ) Q3Controller_GetTrackerPosition (
    TQ3ControllerRef controllerRef,
    TQ3Point3D *position
);
Discussion

Get the position of a controller's tracker.

If no tracker is asssociated with the controller, position will be set to the position of the system cursor tracker.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to query.
position
The current position of the tracker.
function result
Success or failure of the operation.

Q3Controller_GetValueCount


( TQ3Status ) Q3Controller_GetValueCount (
    TQ3ControllerRef controllerRef,
    TQ3Uns32 *valueCount
);
Discussion

Get the number of values of a controller.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to query.
valueCount
Receives the number of values of the controller.
function result
Success or failure of the operation.

Q3Controller_GetValues


( TQ3Status ) Q3Controller_GetValues (
    TQ3ControllerRef controllerRef,
    TQ3Uns32 valueCount,
    float *values,
    TQ3Boolean *changed,
    TQ3Uns32 *serialNumber
);
Discussion

Get the list of values of a controller.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to query.
valueCount
The number of elements in the values array.
values
A pointer to an array of values to update.
changed
Receives true or false as the array of values was changed.
serialNumber
A controller serial number, or NULL.
function result
Success or failure of the operation.

Q3Controller_HasTracker


( TQ3Status ) Q3Controller_HasTracker (
    TQ3ControllerRef controllerRef,
    TQ3Boolean *hasTracker
);
Discussion

Determine if a controller is associated with a tracker.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to query.
hasTracker
Receives true or false as the controller is associated with a tracker.
function result
Success or failure of the operation.

Q3Controller_MoveTrackerOrientation


( TQ3Status ) Q3Controller_MoveTrackerOrientation (
    TQ3ControllerRef controllerRef,
    const TQ3Quaternion *delta
);
Discussion

Move the orientation of a controller's tracker by a delta.

If no tracker is associated with the controller, the delta will be added to the orientation of the system cursor tracker. Will have no effect if controllerRef is an inactive controller.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to update.
orientation
The delta to be added to the tracker orientation.
function result
Success or failure of the operation.

Q3Controller_MoveTrackerPosition


( TQ3Status ) Q3Controller_MoveTrackerPosition (
    TQ3ControllerRef controllerRef,
    const TQ3Vector3D *delta
);
Discussion

Move the position of a controller's tracker by a delta.

If no tracker is associated with the controller, the delta will be added to the position of the system cursor tracker. Will have no effect if controllerRef is an inactive controller.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to update.
delta
The delta to be added to the tracker position.
function result
Success or failure of the operation.

Q3Controller_New


( TQ3ControllerRef ) Q3Controller_New (
    const TQ3ControllerData *controllerData
);
Discussion

Create a new controller object.

The new controller object will be active, and bound to the system cursor's tracker. Its serial number will be initialised to 1.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerData
The data for the new controller.
function result
The new controller object, or NULL.

Q3Controller_Next


( TQ3Status ) Q3Controller_Next (
    TQ3ControllerRef controllerRef,
    TQ3ControllerRef *nextControllerRef
);
Discussion

Iterate through the list of available controllers.

To retrieve the first controller in the list, set controllerRef to NULL. After retrieving the last controller in the list, nextControllerRef will be set to NULL.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The current controller, or NULL.
nextControllerRef
Receives the next controller in the list, or NULL.
function result
Success or failure of the operation.

Q3Controller_SetActivation


( TQ3Status ) Q3Controller_SetActivation (
    TQ3ControllerRef controllerRef,
    TQ3Boolean active
);
Discussion

Set the activation state of a controller.

Adjusting the activation state make invoke the notify function of the tracker associated with the controller, and will increment the serial number of the list of available controllers.

A controller should be inactive if it is temporarily unavailable.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to adjust.
active
The new activatione state for the controller.
function result
Success or failure of the operation.

Q3Controller_SetButtons


( TQ3Status ) Q3Controller_SetButtons (
    TQ3ControllerRef controllerRef,
    TQ3Uns32 buttons
);
Discussion

Set the button state of a controller.

If the controller is inactive, this call has no effect. Changing the state may cause the notify function of any tracker associated with the controller to be invoked.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to update.
buttons
The new button state for the controller.
function result
Success or failure of the operation.

Q3Controller_SetChannel


( TQ3Status ) Q3Controller_SetChannel (
    TQ3ControllerRef controllerRef,
    TQ3Uns32 channel,
    const void *data,
    TQ3Uns32 dataSize
);
Discussion

Set the data for a controller channel.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to update.
channel
An index into the list of channels, from 0.
data
A pointer to the data for the channel. Pass NULL to reset the channel to a default or inactive value.
dataSize
The number of bytes pointed to by data.
function result
Success or failure of the operation.

Q3Controller_SetTracker


( TQ3Status ) Q3Controller_SetTracker (
    TQ3ControllerRef controllerRef,
    TQ3TrackerObject tracker
);
Discussion

Set the tracker associated with a controller.

If the tracker is NULL, the controller is attached to the system cursor tracker. Both the previous and new tracker's notify functions make be called.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to update.
tracker
The tracker to associate with the controller.
function result
Success or failure of the operation.

Q3Controller_SetTrackerOrientation


( TQ3Status ) Q3Controller_SetTrackerOrientation (
    TQ3ControllerRef controllerRef,
    const TQ3Quaternion *orientation
);
Discussion

Set the orientation of a controller's tracker.

If no tracker is associated with the controller, the orientation of the system cursor tracker will be updated.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to update.
orientation
The new orientation for the tracker.
function result
Success or failure of the operation.

Q3Controller_SetTrackerPosition


( TQ3Status ) Q3Controller_SetTrackerPosition (
    TQ3ControllerRef controllerRef,
    const TQ3Point3D *position
);
Discussion

Set the position of a controller's tracker.

If no tracker is asssociated with the controller, the position of the system cursor tracker will be set.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to update.
position
The new position for the tracker.
function result
Success or failure of the operation.

Q3Controller_SetValues


( TQ3Status ) Q3Controller_SetValues (
    TQ3ControllerRef controllerRef,
    const float *values,
    TQ3Uns32 valueCount
);
Discussion

Set the list of values of a controller.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller to update.
values
A pointer to an array of new values.
valueCount
The number of elements in the values array.
function result
Success or failure of the operation.

Q3Controller_Track2DCursor


( TQ3Status ) Q3Controller_Track2DCursor (
    TQ3ControllerRef controllerRef,
    TQ3Boolean *track2DCursor
);
Discussion

Determine if a controller is affecting the 2D system cursor.

If the controller is inactive or not attached to the system cursor tracker, track2DCursor will be set to false.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller reference.
track2DCursor
Receives true or false as the controller is affecting the 2D system cursor.
function result
Success or failure of the operation.

Q3Controller_Track3DCursor


( TQ3Status ) Q3Controller_Track3DCursor (
    TQ3ControllerRef controllerRef,
    TQ3Boolean *track3DCursor
);
Discussion

Determine if a controller is affecting the 3D system cursor.

If the controller is inactive or not attached to the system cursor tracker, track2DCursor will be set to false.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
controllerRef
The controller reference.
tracksDCursor
Receives true or false as the controller is affecting both the 2D system cursor and the z-axis values/orientation of the system cursor.
function result
Success or failure of the operation.

Q3CursorTracker_GetAndClearDeltas


( TQ3Status ) Q3CursorTracker_GetAndClearDeltas (
    float *depth,
    TQ3Quaternion *orientation,
    TQ3Boolean *hasOrientation,
    TQ3Boolean *changed,
    TQ3Uns32 *serialNumber
);
Discussion

Get and clear the deltas for the cursor tracker.

Note - no QD3D documentation could be found for this routine. The purpose of the function, and its parameters/result, have been assumed.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
depth
Receives the z-coordinate of the cursor tracker.
orientation
Receives the orientation of the cursor tracker.
hasOrientation
Receives true or false as the orientation result is valid.
changed
Receives true or false as the depth or orientation parameters were updated.
serialNumber
Receives the current serial number.
function result
Success or failure of the operation.

Q3CursorTracker_GetNotifyFunc


( TQ3Status ) Q3CursorTracker_GetNotifyFunc (
    TQ3CursorTrackerNotifyFunc *notifyFunc
);
Discussion

Get the notification routine for the cursor tracker.

Note - no QD3D documentation could be found for this routine. The purpose of the function, and its parameters/result, have been assumed.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
notifyFunc
Receives the notification routine.
function result
Success or failure of the operation.

Q3CursorTracker_PrepareTracking


( TQ3Status ) Q3CursorTracker_PrepareTracking (void);
Discussion

Prepare the cursor tracker for tracking.

Note - no QD3D documentation could be found for this routine. The purpose of the function, and its parameters/result, have been assumed.

This function is available, but not implemented, in Quesa.

function result
Success or failure of the operation.

Q3CursorTracker_SetNotifyFunc


( TQ3Status ) Q3CursorTracker_SetNotifyFunc (
    TQ3CursorTrackerNotifyFunc notifyFunc
);
Discussion

Set the notification routine for the cursor tracker.

Note - no QD3D documentation could be found for this routine. The purpose of the function, and its parameters/result, have been assumed.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
notifyFunc
The notification routine.
function result
Success or failure of the operation.

Q3CursorTracker_SetTrackDeltas


( TQ3Status ) Q3CursorTracker_SetTrackDeltas (
    TQ3Boolean trackDeltas
);
Discussion

Set if the cursor tracker should tracker deltas or not.

Note - no QD3D documentation could be found for this routine. The purpose of the function, and its parameters/result, have been assumed.


This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackDeltas
True or false as the cursor tracker should track deltas.
function result
Success or failure of the operation.

Q3Tracker_ChangeButtons


( TQ3Status ) Q3Tracker_ChangeButtons (
    TQ3TrackerObject trackerObject,
    TQ3ControllerRef controllerRef,
    TQ3Uns32 buttons,
    TQ3Uns32 buttonMask
);
Discussion

Change the button state of a tracker.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to update.
controllerRef
The controller associated with the tracker.
buttons
The new button state for the tracker.
buttonMask
Mask indicating which bits in buttons to apply.
function result
Success or failure of the operation.

Q3Tracker_GetActivation


( TQ3Status ) Q3Tracker_GetActivation (
    TQ3TrackerObject trackerObject,
    TQ3Boolean *active
);
Discussion

Get the activation status of a tracker.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to query.
active
Receives the activation status of the tracker.
function result
Success or failure of the operation.

Q3Tracker_GetButtons


( TQ3Status ) Q3Tracker_GetButtons (
    TQ3TrackerObject trackerObject,
    TQ3Uns32 *buttons
);
Discussion

Get the button state of a tracker.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to query.
buttons
Receives the button state of the tracker.
function result
Success or failure of the operation.

Q3Tracker_GetEventCoordinates


( TQ3Status ) Q3Tracker_GetEventCoordinates (
    TQ3TrackerObject trackerObject,
    TQ3Uns32 timeStamp,
    TQ3Uns32 *buttons,
    TQ3Point3D *position,
    TQ3Quaternion *orientation
);
Discussion

Get the coordinates of a tracker at a specified time.

Time units are unknown.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to query.
timeStamp
The time stamp.
buttons
If non-NULL, receives the button state of the tracker.
position
If non-NULL, receives the position of the tracker.
orientation
If non-NULL, receives the orientation of the tracker.
function result
Success or failure of the operation.

Q3Tracker_GetNotifyThresholds


( TQ3Status ) Q3Tracker_GetNotifyThresholds (
    TQ3TrackerObject trackerObject,
    float *positionThresh,
    float *orientationThresh
);
Discussion

Get the notify thresholds of a tracker.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to query.
positionThresh
Receives the position threshold of the tracker.
orientationThresh
Receives the orientation threshold of the tracker.
function result
Success or failure of the operation.

Q3Tracker_GetOrientation


( TQ3Status ) Q3Tracker_GetOrientation (
    TQ3TrackerObject trackerObject,
    TQ3Quaternion *orientation,
    TQ3Quaternion *delta,
    TQ3Boolean *changed,
    TQ3Uns32 *serialNumber
);
Discussion

Get the orientation of a tracker.

If serialNumber is not NULL, changed will only be set to true if a change has occurred since the specified serial number was generated.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to query.
orientation
Receives the current orientation of the tracker.
delta
If non-NULL, receives the change in orientation since the previous call to Q3Tracker_GetOrientation.
changed
Receives true or false as either orientation or delta have been updated.
serialNumber
If non-NULL, receives the current serial number.
function result
Success or failure of the operation.

Q3Tracker_GetPosition


( TQ3Status ) Q3Tracker_GetPosition (
    TQ3TrackerObject trackerObject,
    TQ3Point3D *position,
    TQ3Vector3D *delta,
    TQ3Boolean *changed,
    TQ3Uns32 *serialNumber
);
Discussion

Get the position of a tracker.

If serialNumber is not NULL, changed will only be set to true if a change has occurred since the specified serial number was generated.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to query.
position
Receives the current position of the tracker.
delta
If non-NULL, receives the change in position since the previous call to Q3Tracker_GetPosition.
changed
Receives true or false as either position or delta have been updated.
serialNumber
If non-NULL, receives the current serial number.
function result
Success or failure of the operation.

Q3Tracker_MoveOrientation


( TQ3Status ) Q3Tracker_MoveOrientation (
    TQ3TrackerObject trackerObject,
    TQ3ControllerRef controllerRef,
    const TQ3Quaternion *delta
);
Discussion

Move the orientation of a tracker by a delta.

Has no effect if the tracker is inactive.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to update.
controllerRef
The controller associated with the tracker.
delta
The delta to be added to the tracker orientation.
function result
Success or failure of the operation.

Q3Tracker_MovePosition


( TQ3Status ) Q3Tracker_MovePosition (
    TQ3TrackerObject trackerObject,
    TQ3ControllerRef controllerRef,
    const TQ3Vector3D *delta
);
Discussion

Move the position of a tracker by a delta.

Has no effect if the tracker is inactive.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to update.
controllerRef
The controller associated with the tracker.
delta
The delta to be added to the tracker position.
function result
Success or failure of the operation.

Q3Tracker_New


( TQ3TrackerObject ) Q3Tracker_New (
    TQ3TrackerNotifyFunc notifyFunc
);
Discussion

Create a new tracker object.

The new tracker is activate, and has its orientation threshold set to 0. If no notify callback is required, notifyFunc may be set to NULL.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
notifyFunc
The notification callback for the tracker, or NULL.
function result
The new tracker object.

Q3Tracker_SetActivation


( TQ3Status ) Q3Tracker_SetActivation (
    TQ3TrackerObject trackerObject,
    TQ3Boolean active
);
Discussion

Set the activation status of a tracker.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to update.
active
The new activation status of the tracker.
function result
Success or failure of the operation.

Q3Tracker_SetEventCoordinates


( TQ3Status ) Q3Tracker_SetEventCoordinates (
    TQ3TrackerObject trackerObject,
    TQ3Uns32 timeStamp,
    TQ3Uns32 buttons,
    const TQ3Point3D *position,
    const TQ3Quaternion *orientation
);
Discussion

Set the coordinates of a tracker at a specified time.

Time units are unknown.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to update.
timeStamp
The time stamp.
buttons
The button state of the tracker.
position
The position state of the tracker, or NULL.
orientation
The orientation state of the tracker, or NULL.
function result
Success or failure of the operation.

Q3Tracker_SetNotifyThresholds


( TQ3Status ) Q3Tracker_SetNotifyThresholds (
    TQ3TrackerObject trackerObject,
    float positionThresh,
    float orientationThresh
);
Discussion

Set the notify thresholds of a tracker.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to update.
positionThresh
The new position threshold.
orientationThresh
The new orientation threshold.
function result
Success or failure of the operation.

Q3Tracker_SetOrientation


( TQ3Status ) Q3Tracker_SetOrientation (
    TQ3TrackerObject trackerObject,
    TQ3ControllerRef controllerRef,
    const TQ3Quaternion *orientation
);
Discussion

Set the orientation of a tracker.

Has no effect if the tracker is inactive.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to update.
controllerRef
The controller associated with the tracker.
orientation
The new orientation for the tracker.
function result
Success or failure of the operation.

Q3Tracker_SetPosition


( TQ3Status ) Q3Tracker_SetPosition (
    TQ3TrackerObject trackerObject,
    TQ3ControllerRef controllerRef,
    const TQ3Point3D *position
);
Discussion

Set the position of a tracker.

Has no effect if the tracker is inactive.

This function is available, but not implemented, in Quesa.

Parameter Descriptions
trackerObject
The tracker to update.
controllerRef
The controller associated with the tracker.
position
The new position for the tracker.
function result
Success or failure of the operation.

Typedefs


TQ3ChannelGetMethod


typedef Q3_CALLBACK_API_C (TQ3Status, TQ3ChannelGetMethod) (
    TQ3ControllerRef controllerRef,
    TQ3Uns32 channel,
    void *data,
    TQ3Uns32 *dataSize
);

Discussion

Channel get method callback.

At most kQ3ControllerSetChannelMaxDataSize bytes of data can be returned.

Parameter Descriptions
controllerRef
The controller the callback is invoked for.
channel
An index into the list of channels, from 0.
data
Receives the data for the channel.
dataSize
Will be set to the number of bytes pointed to by data, and should receive the number of bytes written to data.
function result
Success or failure of the operation.

TQ3ChannelSetMethod


typedef Q3_CALLBACK_API_C (TQ3Status, TQ3ChannelSetMethod) (
    TQ3ControllerRef controllerRef,
    TQ3Uns32 channel,
    const void *data,
    TQ3Uns32 dataSize
);

Discussion

Channel set method callback.

At most kQ3ControllerSetChannelMaxDataSize bytes of data will be supplied.

Parameter Descriptions
controllerRef
The controller the callback is invoked for.
channel
An index into the list of channels, from 0.
data
The new data for the channel.
dataSize
The number of bytes pointed to by data.
function result
Success or failure of the operation.

TQ3CursorTrackerNotifyFunc


typedef Q3_CALLBACK_API_C (void, TQ3CursorTrackerNotifyFunc) (void);
Discussion

Cursor tracker notification callback.


TQ3TrackerNotifyFunc


typedef Q3_CALLBACK_API_C (TQ3Status, TQ3TrackerNotifyFunc) (
    TQ3TrackerObject trackerObject,
    TQ3ControllerRef controllerRef
);

Discussion

Tracker notification callback.

Parameter Descriptions
trackerObject
The tracker the callback is invoked for.
controllerRef
The controller associated with the tracker.
function result
Success or failure of the operation.

Structs


TQ3ControllerData


typedef struct TQ3ControllerData {
    char                                        *signature;
    TQ3Uns32                                    valueCount;
    TQ3Uns32                                    channelCount;
    TQ3ChannelGetMethod                         channelGetMethod;
    TQ3ChannelSetMethod                         channelSetMethod;
} TQ3ControllerData;
Discussion

State used to create new controller objects.

Field Descriptions
signature
A C string which uniquely identifies the manufacturer and model of the controller.
valueCount
The number of values supported by the controller.
channelCount
The number of channels supported by the controller.
channelGetMethod
The channel-getting method for the controller. This field is only valid if channelCount is non-zero, and may be NULL if the controller can not support this.
channelSetMethod
The channel-setting method for the controller. This field is only valid if channelCount is non-zero, and may be NULL if the controller can not support this.

© 1999-2008 Quesa Developers (Last Updated 5/10/2008)