SFBJoystick

Wrapper Class for the IJoystick interface.

#include <SFBJoystick.h.hpp>

class SFBJoystick : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBJoystick)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	X	O	O

Reference

BREW API IFilePort

Member

Public Functions
`SFCError`	GetParm( `SInt16` parmID , `SInt32Ptr` p1 ) Get the joystick control parameters.
static `SFBJoystickSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBJoystick instance.
static `SFBJoystickSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBJoystick instance.
`SFCError`	Read( `SInt16Ptr` x , `SInt16Ptr` y ) Read signed values of the current joystick x, y positions.
`SFCError`	Read( `SFXPixelPtr` pixel ) Read signed values of the current joystick x, y positions.
`SFCError`	SetParm( `SInt16` parmID , `SInt32` p1 , `SInt32` p2 ) Set the joystick control parameters.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBJoystick::GetParm

Get the joystick control parameters.

[ public ]
SFCError GetParm(
    SInt16 parmID   // Command parameter that controls what will be set by this function
    SInt32Ptr p1    // Depends upon ParmID
);

Return value

SUCCESS: Successful. Operation is completed.
EFAILED: General failure

Reference

BREW API IJOYSTICK_GetParm

SFBJoystick::NewInstance

Create a new SFBJoystick instance.

[ public, static ]
SFBJoystickSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBJoystickSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBJoystick::Read

Read signed values of the current joystick x, y positions.

[ public ]
SFCError Read(
    SInt16Ptr x   // Pointer to the signed 16 bit x position value
    SInt16Ptr y   // Pointer to the signed 16 bit y position value
);

[ public ]
SFCError Read(
    SFXPixelPtr pixel   // Pointer to the Coordinate value
);

Return value

SUCCESS: Successful. Operation is completed.
EFAILED: General failure.

Reference

BREW API IJOYSTICK_Read

SFBJoystick::SetParm

Set the joystick control parameters.

[ public ]
SFCError SetParm(
    SInt16 parmID   // Command parameter that controls what will be set by this function
    SInt32 p1       // Depends upon nParmID
    SInt32 p2       // Depends upon nParmID
);

Return value

SUCCESS: Successful. Operation is completed.
EFAILED: General failure.

Reference

BREW API IJOYSTICK_SetParm