Key input system


Defines

#define PA_MoveSprite(sprite)   PA_MoveSpriteEx(PA_Screen, sprite, PA_GetSpriteLx(0, sprite), PA_GetSpriteLy(0, sprite))
 Move a sprite according to the stylus's position. The sprite will be 'hooked' if the stylus passes over it, and then they'll be linked together. Returns 1 if the sprite is moved. You can also get information from PA_MovedSprite.Moving (1 if you are moving a sprite), .Sprite (sprite moved), .X (X position of the center of the sprite), .Y (Y position of the center of the sprite), .Vx (horizontal speed ! useful if you want to make the sprite continue to move when you release the stylus...), and .Vy.
#define PA_StylusInZone(x1, y1, x2, y2)   ((Stylus.X>=x1)&&(Stylus.Y>=y1)&&(Stylus.X<x2)&&(Stylus.Y<y2))
 Check if the stylus is in a given zone... Returns 1 if yes, 0 if not.

Functions

void PA_UpdatePad (void)
 Update the Keypad, use it once per frame (in the VBL for example). You can then retrieve the held down keys with Pad.Held.A (or Up, Down...), Newly pressed keys with Pad.Newpress.R, and the just released keys with Pad.Released.Up...
void PA_UpdateStylus (void)
u8 PA_MoveSpritePix (u8 sprite)
 Move a sprite according to the stylus's position, only if you touch a sprite's pixel. This is similar to PA_MoveSprite, but slightly slower and requires PA_InitSpriteDraw(screen, sprite) before. The sprite will be 'hooked' if the stylus passes over it, and then they'll be linked together. Returns 1 if the sprite is moved. You can also get information from PA_MovedSprite.Moving (1 if you are moving a sprite), .Sprite (sprite moved), .X (X position of the top left corner of the sprite), .Y (Y position of the top left corner of the sprite), .Vx (horizontal speed ! useful if you want to make the sprite continue to move when you release the stylus...), and .Vy.
u8 PA_MoveSpriteEx (u8 screen, u8 sprite, u8 lx, u8 ly)
 Move a sprite according to the stylus's position. See PA_MoveSprite for more details... The difference is that here you chose the sprite dimension (lx and ly), which is useful if the sprite is smaller than the DS standard sizes... (for example 20x20...). This will also limit the 'hooking' distance.
u8 PA_MoveSpriteDistance (u8 sprite, u8 distance)
 Move a sprite according to the stylus's position. See PA_MoveSprite for more details... The difference is that here you chose the hooking distance in pixels.
u8 PA_SpriteStylusOverEx (u8 sprite, u8 lx, u8 ly)
 Check if the stylus position is over a given sprite (stylus pressed or not).
u8 PA_SpriteTouchedEx (u8 sprite, u8 lx, u8 ly)
 Check if a given sprite is touched. Returns 1 if touched... You can chose the width and height around the sprite.
u8 PA_SpriteTouched (u8 sprite)
 Check if a given sprite is touched. Returns 1 if touched...
u8 PA_SpriteStylusOver (u8 sprite)
 Check if the stylus position is over a given sprite (stylus pressed or not).
u8 PA_SpriteTouchedPix (u8 sprite)
u8 PA_Sprite16cTouchedPix (u8 sprite)

Detailed Description

Check which keys are pressed...

Define Documentation

#define PA_MoveSprite ( sprite   )     PA_MoveSpriteEx(PA_Screen, sprite, PA_GetSpriteLx(0, sprite), PA_GetSpriteLy(0, sprite))

Move a sprite according to the stylus's position. The sprite will be 'hooked' if the stylus passes over it, and then they'll be linked together. Returns 1 if the sprite is moved. You can also get information from PA_MovedSprite.Moving (1 if you are moving a sprite), .Sprite (sprite moved), .X (X position of the center of the sprite), .Y (Y position of the center of the sprite), .Vx (horizontal speed ! useful if you want to make the sprite continue to move when you release the stylus...), and .Vy.

Parameters:
sprite Object number in the sprite system

#define PA_StylusInZone ( x1,
y1,
x2,
y2   )     ((Stylus.X>=x1)&&(Stylus.Y>=y1)&&(Stylus.X<x2)&&(Stylus.Y<y2))

Check if the stylus is in a given zone... Returns 1 if yes, 0 if not.

Parameters:
x1 X value of the upper left corner
y1 Y value of the upper left corner
x2 X value of the lower right corner
y2 Y value of the lower right corner


Function Documentation

u8 PA_MoveSpriteDistance ( u8  sprite,
u8  distance 
) [inline]

Move a sprite according to the stylus's position. See PA_MoveSprite for more details... The difference is that here you chose the hooking distance in pixels.

Parameters:
sprite Object number in the sprite system
distance Hooking distance

u8 PA_MoveSpriteEx ( u8  screen,
u8  sprite,
u8  lx,
u8  ly 
)

Move a sprite according to the stylus's position. See PA_MoveSprite for more details... The difference is that here you chose the sprite dimension (lx and ly), which is useful if the sprite is smaller than the DS standard sizes... (for example 20x20...). This will also limit the 'hooking' distance.

Parameters:
screen On what screen to do it
sprite Object number in the sprite system
lx Sprite length
ly Sprite height

u8 PA_MoveSpritePix ( u8  sprite  ) 

Move a sprite according to the stylus's position, only if you touch a sprite's pixel. This is similar to PA_MoveSprite, but slightly slower and requires PA_InitSpriteDraw(screen, sprite) before. The sprite will be 'hooked' if the stylus passes over it, and then they'll be linked together. Returns 1 if the sprite is moved. You can also get information from PA_MovedSprite.Moving (1 if you are moving a sprite), .Sprite (sprite moved), .X (X position of the top left corner of the sprite), .Y (Y position of the top left corner of the sprite), .Vx (horizontal speed ! useful if you want to make the sprite continue to move when you release the stylus...), and .Vy.

Parameters:
sprite Object number in the sprite system

u8 PA_Sprite16cTouchedPix ( u8  sprite  )  [inline]

inline u8 PA_SpriteStylusOver ( u8  sprite  )  [inline]

Check if the stylus position is over a given sprite (stylus pressed or not).

Parameters:
sprite Sprite number in the sprite system

inline u8 PA_SpriteStylusOverEx ( u8  sprite,
u8  lx,
u8  ly 
) [inline]

Check if the stylus position is over a given sprite (stylus pressed or not).

Parameters:
sprite Sprite number in the sprite system
lx Wideness
ly Height

inline u8 PA_SpriteTouched ( u8  sprite  )  [inline]

Check if a given sprite is touched. Returns 1 if touched...

Parameters:
sprite Sprite number in the sprite system

inline u8 PA_SpriteTouchedEx ( u8  sprite,
u8  lx,
u8  ly 
) [inline]

Check if a given sprite is touched. Returns 1 if touched... You can chose the width and height around the sprite.

Parameters:
sprite Sprite number in the sprite system
lx Wideness
ly Height

u8 PA_SpriteTouchedPix ( u8  sprite  )  [inline]

void PA_UpdatePad ( void   ) 

Update the Keypad, use it once per frame (in the VBL for example). You can then retrieve the held down keys with Pad.Held.A (or Up, Down...), Newly pressed keys with Pad.Newpress.R, and the just released keys with Pad.Released.Up...

void PA_UpdateStylus ( void   ) 


Generated on Sat Jun 13 12:55:14 2009 for PAlib - Programmer's Arsenal by  doxygen 1.5.8