OOSDLJoystickManager Class Reference

#include <OOSDLJoystickManager.h>

Inheritance diagram for OOSDLJoystickManager:

Collaboration diagram for OOSDLJoystickManager:

Instance Methods
(id)	- init
(void)	- dealloc
(BOOL)	- handleSDLEvent:
(NSString *)	- nameOfJoystick:
(int16_t)	- getAxisWithStick:axis:
(JoyAxisEvent)	- makeJoyAxisEvent:
(JoyButtonEvent)	- makeJoyButtonEvent:
(JoyHatEvent)	- makeJoyHatEvent:
(NSInteger)	- getJoystickIndexFromId:
(NSUInteger)	- joystickCount [implementation]
Instance Methods inherited from OOJoystickManager
(NSPoint)	- rollPitchAxis
(NSPoint)	- viewAxis
(void)	- setFunction:withDict:
(void)	- unsetAxisFunction:
(void)	- unsetButtonFunction:
(BOOL)	- isButtonDown:stick:
(BOOL)	- getButtonState:
(double)	- getAxisState:
(double)	- getSensitivity
(void)	- setProfile:forAxis:
(OOJoystickAxisProfile *)	- getProfileForAxis:
(void)	- saveProfileForAxis:
(void)	- loadProfileForAxis:
(const BOOL *)	- getAllButtonStates
(NSArray *)	- listSticks
(NSDictionary *)	- axisFunctions
(NSDictionary *)	- buttonFunctions
(void)	- setCallback:object:hardware:
(void)	- clearCallback
(void)	- setDefaultMapping
(void)	- clearMappings
(void)	- clearStickStates
(void)	- clearStickButtonState:
(void)	- decodeAxisEvent:
(void)	- decodeButtonEvent:
(void)	- decodeHatEvent:
(void)	- saveStickSettings
(void)	- loadStickSettings
(void)	- setFunctionForAxis:function:stick: [implementation]
(void)	- setFunctionForButton:function:stick: [implementation]

Private Attributes
NSDictionary *	joystickIdMap
SDL_Joystick *	stick [MAX_STICKS]
int	stickCount

Additional Inherited Members
Class Methods inherited from OOJoystickManager
(id)	+ sharedStickHandler
(BOOL)	+ setStickHandlerClass:

Detailed Description

Definition at line 45 of file OOSDLJoystickManager.h.

Method Documentation

dealloc

- (void) dealloc

Definition at line 1 of file OOSDLJoystickManager.m.

{
    [joystickIdMap release];
    [super dealloc];
}

getAxisWithStick:axis:

- (int16_t) getAxisWithStick:		(NSUInteger)	stickNum
axis:		(NSUInteger)	axisNum

Reimplemented from OOJoystickManager.

Definition at line 1 of file OOSDLJoystickManager.m.

                            :(NSUInteger) stickNum axis:(NSUInteger) axisNum 
{
    return SDL_GetJoystickAxis(stick[stickNum], axisNum);
}

getJoystickIndexFromId:

- (NSInteger) getJoystickIndexFromId:

(SDL_JoystickID)

joystickId

Definition at line 1 of file OOSDLJoystickManager.m.

                                    : (SDL_JoystickID) joystickId
{
    NSNumber *index = [joystickIdMap valueForKey: [NSString stringWithFormat: @"%d", joystickId]];
    if (index)
    {
        return [index integerValue];
    }
    return -1;
}

handleSDLEvent:

- (BOOL) handleSDLEvent:

(SDL_Event *)

evt

Definition at line 1 of file OOSDLJoystickManager.m.

                       : (SDL_Event *)evt
{
    BOOL rc=NO;
    switch(evt->type)
    {
        case SDL_EVENT_GAMEPAD_AXIS_MOTION:
        case SDL_EVENT_JOYSTICK_AXIS_MOTION:
        {
            JoyAxisEvent joyEvt = [self makeJoyAxisEvent: (SDL_JoyAxisEvent*)evt];
            if (joyEvt.which >= 0)
            {
                [self decodeAxisEvent: &joyEvt];
                rc=YES;
            }
            break;
        }
 
        case SDL_EVENT_GAMEPAD_BUTTON_DOWN:
        case SDL_EVENT_GAMEPAD_BUTTON_UP:
        case SDL_EVENT_JOYSTICK_BUTTON_DOWN:
        case SDL_EVENT_JOYSTICK_BUTTON_UP:
        {
            JoyButtonEvent joyEvt = [self makeJoyButtonEvent: (SDL_JoyButtonEvent*)evt];
            if (joyEvt.which >= 0)
            {
                [self decodeButtonEvent: &joyEvt];
                rc=YES;
            }
            break;
        }
 
        case SDL_EVENT_JOYSTICK_HAT_MOTION:
        {
            JoyHatEvent joyEvt = [self makeJoyHatEvent: (SDL_JoyHatEvent*)evt];
            if (joyEvt.which >= 0)
            {
                [self decodeHatEvent: &joyEvt];
                rc=YES;
            }
            break;
        }
 
        default:
            OOLog(@"handleSDLEvent.unknownEvent", @"%@", @"JoystickHandler was sent an event it doesn't know");
    }
    return rc;
}

init

- (id) init

Reimplemented from OOJoystickManager.

Definition at line 1 of file OOSDLJoystickManager.m.

{
    int i;
 
    NSMutableDictionary *idMap = [[[NSMutableDictionary alloc] init] autorelease];
 
    // Find and open the sticks. Make sure that we don't fail if more joysticks than MAX_STICKS are detected.
    SDL_JoystickID *joystickIds = SDL_GetJoysticks(&stickCount);
    OOLog(@"joystick.init", @"Number of joysticks detected: %d", stickCount);
    if (stickCount > MAX_STICKS)
    {
        stickCount = MAX_STICKS;
        OOLog(@"joystick.init", @"Number of joysticks detected exceeds maximum number of joysticks allowed. Setting number of active joysticks to %d.", MAX_STICKS);
    }
    if(stickCount)
    {
        for(i = 0; i < stickCount; i++)
        {
            // it's doubtful MAX_STICKS will ever get exceeded, but
            // we need to be defensive.
            if(i > MAX_STICKS)
                break;
 
            stick[i]=SDL_OpenJoystick(joystickIds[i]);
            if(stick[i])
            {
                [idMap setObject: [NSNumber numberWithInt: i] forKey: [NSString stringWithFormat: @"%d", joystickIds[i]]];
            }
            else
            {
                OOLog(@"joystick.init", @"Failed to open joystick #%d", i);
            }
        }
        SDL_SetJoystickEventsEnabled(true);
    }
    SDL_free(joystickIds);
    joystickIdMap = [idMap copy];
    return [super init];
}

joystickCount

- (NSUInteger) joystickCount

implementation

Reimplemented from OOJoystickManager.

Definition at line 1 of file OOSDLJoystickManager.m.

{
    return stickCount;
}

makeJoyAxisEvent:

- (JoyAxisEvent) makeJoyAxisEvent:

(SDL_JoyAxisEvent*)

sdlevt

Definition at line 1 of file OOSDLJoystickManager.m.

                                 : (SDL_JoyAxisEvent*) sdlevt
{
    JoyAxisEvent evt;
    evt.type = sdlevt->type;
    evt.which = [self getJoystickIndexFromId: sdlevt->which];
    evt.axis = sdlevt->axis;
    evt.value = sdlevt->value;
    return evt;
}

makeJoyButtonEvent:

- (JoyButtonEvent) makeJoyButtonEvent:

(SDL_JoyButtonEvent*)

sdlevt

Definition at line 1 of file OOSDLJoystickManager.m.

                                     : (SDL_JoyButtonEvent*) sdlevt
{
    JoyButtonEvent evt;
    evt.type = sdlevt->type;
    evt.which = [self getJoystickIndexFromId: sdlevt->which];
    evt.button = sdlevt->button;
    evt.down = sdlevt->down;
    return evt;
}

makeJoyHatEvent:

- (JoyHatEvent) makeJoyHatEvent:

(SDL_JoyHatEvent*)

sdlevt

Definition at line 1 of file OOSDLJoystickManager.m.

                               : (SDL_JoyHatEvent*) sdlevt
{
    JoyHatEvent evt;
    evt.type = sdlevt->type;
    evt.which = [self getJoystickIndexFromId: sdlevt->which];
    evt.hat = sdlevt->hat;
    evt.value = sdlevt->value;
    return evt;
}

nameOfJoystick:

- (NSString *) nameOfJoystick:

(NSUInteger)

stickNumber

Reimplemented from OOJoystickManager.

Definition at line 1 of file OOSDLJoystickManager.m.

                             :(NSUInteger)stickNumber
{
    if (stickNumber >= stickCount)  return @"(unknown joystick)";
    return [NSString stringWithUTF8String:SDL_GetJoystickName(stick[stickNumber])];
}

Member Data Documentation

joystickIdMap

- (NSDictionary*) joystickIdMap

private

Definition at line 48 of file OOSDLJoystickManager.h.

stick

- (SDL_Joystick* stick[MAX_STICKS])

private

Definition at line 49 of file OOSDLJoystickManager.h.

stickCount

- (int) stickCount

private

Definition at line 50 of file OOSDLJoystickManager.h.

---

The documentation for this class was generated from the following files:

• src/SDL/OOSDLJoystickManager.h
• src/SDL/OOSDLJoystickManager.m