Austin: MONKEYmedia User Interface Design - TECHNOLOGY: XOI: Command Summary

`xoiGetCursorX`	`Returns current x position of visible cursor.`
`xoiGetCursorY`	`Returns current y position of visible cursor.`
`xoiSetCursorXY (int x, int y)`	`Jumps visible cursor to screen position.`
`xoiSetCursorXYDampened (int x, int y)`	`Jumps visible cursor to screen position and dampens inertia.`
`xoiSetCursorCouple (int cc)`	`Toggles input device cursor mapping: 0=decoupled 1=coupled (determines whether cursor moves in response to input device)`
`xoiGetDeviceX`	`Returns absolute x position of input device.`
`xoiGetDeviceY`	`Returns absolute y position of input device.`

`xoiGetCursorVector`	`Returns instantaneous vector of visible cursor.`
`xoiGetCursorVelocity`	`Returns instantaneous velocity of visible cursor.`
`xoiGetCursorAccel`	`Returns instantaneous acceleration of visible cursor.`
`xoiGetDeviceVector`	`Returns instantaneous vector of input device.`
`xoiGetDeviceVelocity`	`Returns instantaneous velocity of input device.`
`xoiGetDeviceAccel`	`Returns instantaneous acceleration of input device.`
`xoiConstrainAxis (int vector, int range)`	`Constrains all movement in range of specified vector to that axis.`
`xoiFreeAxes`	`Removes all axis constraints.`

`xoiInstall`	`Installs persistent input device processing thread.`
`xoiRemove`	`Removes processing thread and frees memory.`
xoiSetObject (str objectName, int boundsLeft, int boundsTop, int boundsRight, int boundsBottom, int boundsShape, str boundsBitmapMemberName, int boundsMasking, int boundsBlockWrapLeft, int boundsBlockWrapTop, int boundsBlockWrapRight, int boundsBlockWrapBottom, int frictionBehavior, int frictionSlope, int frictionForce, int magnetismLeft, int magnetismTop, int magnetismRight, int magnetismBottom, int magnetismInsideShape, int magnetismDecayX, int magnetismDecayY, int magnetismForceInbound, int magnetismForceOutbound)	`Sets values for named object and adds to processing queue (if object already in queue, then replaces property values).`
`xoiRemoveOneObject (str objectName)`	`Removes object from processing queue.`
`xoiRemoveAllObjects`	`Removes all objects from processing queue.`
`xoiGetInertia`	`Returns global inertia setting: 0=Off 1=On`
`xoiSetInertia (int inertia)`	`Toggles global inertia setting: 0=Off 1=On.`
`xoiDampenInertia`	`Nullify accumulated inertia.`

Get (str objectName) Returns the value of the property with name for the named object.

-- Ex. GetObjectName("redRectangle") returns "redRectangle"

Set (str objectName, int/str value) Sets the value of the property with name for the named object to value.


  -- Ex. SetFrictionForce("redRectangle", 50) sets the frictionForce property 
  of "redRectangle" to 50.

`str objectName`	`Name of object (32 char max)`
`int boundsLeft`	`Left edge of object`
`int boundsTop`	`Top edge of object`
`int boundsRight`	`Right edge of object`
`int boundsBottom`	`Bottom edge of object`
`int boundsShape`	`0=rect 1=oval 2=bitmap`
`str boundsBitmapMemberName`	`Name of bounding bitmap (32 char max)`
`int boundsMasking`	`0=transparent 1=block background forces`
`int boundsBlockWrapLeft`	`0=free 1=block 2=wrap`
`int boundsBlockWrapTop`	`0=free 1=block 2=wrap`
`int boundsBlockWrapRight`	`0=free 1=block 2=wrap`
`int boundsBlockWrapBottom`	`0=free 1=block 2=wrap`
`int frictionBehavior`	`0=uniform 1=unidirectional 2=bidirectional`
`int frictionSlope`	`On-screen angle: 0 to 360 degrees`
`int frictionForce`	`Resistance: -100 to +100 (hot gas to solid form)`
`int magnetismLeft`	`Left edge of safe zone`
`int magnetismTop`	`Top edge of safe zone`
`int magnetismRight`	`Right edge of safe zone`
`int magnetismBottom`	`Bottom edge of safe zone`
`int magnetismInsideShape`	`Safe zone shape: 0=rect 1=oval`
`int magnetismDecayX`	`Horiz. distance from center to 0 magnetic force`
`int magnetismDecayY`	`Vert. distance from center to 0 magnetic force`
`int magnetismForceInbound`	`Inbound force: -100 to +100 (push to pull)`
`int magnetismForceOutbound`	`Outbound force: -100 to +100 (push to pull)`

Back to XOI