org.bytedeco.ale

Class Controller

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ale.Controller

All Implemented Interfaces:

AutoCloseable

@NoOffset
 @Properties(inherit=ale.class)
public class Controller
extends Pointer

A controller is a device that plugs into either the left or right controller jack of the Video Computer System (VCS). The pins of the controller jacks are mapped as follows:

------------- \ 1 2 3 4 5 / \ 6 7 8 9 / ---------

Left Controller Right Controller

pin 1 D4 PIA SWCHA D0 PIA SWCHA pin 2 D5 PIA SWCHA D1 PIA SWCHA pin 3 D6 PIA SWCHA D2 PIA SWCHA pin 4 D7 PIA SWCHA D3 PIA SWCHA pin 5 D7 TIA INPT1 (Dumped) D7 TIA INPT3 (Dumped) pin 6 D7 TIA INPT4 (Latched) D7 TIA INPT5 (Latched) pin 7 +5 +5 pin 8 GND GND pin 9 D7 TIA INPT0 (Dumped) D7 TIA INPT2 (Dumped)

Each of the pins connected to the PIA can be configured as an input or output pin. The "dumped" TIA pins are used to charge a capacitor. A potentiometer is sometimes connected to these pins for analog input.

This is a base class for all controllers. It provides a view of the controller from the perspective of the controller's jack.

Version:

$Id: Control.hxx,v 1.9 2007/02/22 02:15:46 stephena Exp $

Author:

Bradford W. Mott

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields

Modifier and Type	Field and Description
static int	AtariVox enum Controller::Type
static int	BoosterGrip enum Controller::Type
static int	Driving enum Controller::Type
static int	Five enum Controller::AnalogPin
static int	Four enum Controller::DigitalPin
static int	Joystick enum Controller::Type
static int	Keyboard enum Controller::Type
static int	Left enum Controller::Jack
static int	maximumResistance
static int	minimumResistance
static int	Nine enum Controller::AnalogPin
static int	One enum Controller::DigitalPin
static int	Paddles enum Controller::Type
static int	Right enum Controller::Jack
static int	Six enum Controller::DigitalPin
static int	Three enum Controller::DigitalPin
static int	TrakBall enum Controller::Type
static int	Two enum Controller::DigitalPin

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Controller(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static int	maximumResistance() Constant which represents maximum resistance for analog pins
static int	minimumResistance() Constant which represents minimum resistance for analog pins
boolean	read(int pin) Read the value of the specified digital pin for this controller.
void	setSystem(System system) Inform this controller about the current System.
int	type() Returns the type of this controller.
void	write(int pin, boolean value) Write the given value to the specified digital pin for this controller.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

Left

public static final int Left

enum Controller::Jack

See Also:

Constant Field Values

Right

public static final int Right

enum Controller::Jack

See Also:

Constant Field Values

BoosterGrip

public static final int BoosterGrip

enum Controller::Type

See Also:

Constant Field Values

Driving

public static final int Driving

enum Controller::Type

See Also:

Constant Field Values

Keyboard

public static final int Keyboard

enum Controller::Type

See Also:

Constant Field Values

Paddles

public static final int Paddles

enum Controller::Type

See Also:

Constant Field Values

Joystick

public static final int Joystick

enum Controller::Type

See Also:

Constant Field Values

TrakBall

public static final int TrakBall

enum Controller::Type

See Also:

Constant Field Values

AtariVox

public static final int AtariVox

enum Controller::Type

See Also:

Constant Field Values

One

public static final int One

enum Controller::DigitalPin

See Also:

Constant Field Values

Two

public static final int Two

enum Controller::DigitalPin

See Also:

Constant Field Values

Three

public static final int Three

enum Controller::DigitalPin

See Also:

Constant Field Values

Four

public static final int Four

enum Controller::DigitalPin

See Also:

Constant Field Values

Six

public static final int Six

enum Controller::DigitalPin

See Also:

Constant Field Values

Five

public static final int Five

enum Controller::AnalogPin

See Also:

Constant Field Values

Nine

public static final int Nine

enum Controller::AnalogPin

See Also:

Constant Field Values

maximumResistance

public static final int maximumResistance

minimumResistance

public static final int minimumResistance

Constructor Detail

Controller

public Controller(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

type

@Cast(value="Controller::Type")
public int type()

Returns the type of this controller.

setSystem

public void setSystem(System system)

Inform this controller about the current System.

read

@Cast(value="bool")
public boolean read(@Cast(value="Controller::DigitalPin")
                                         int pin)

Read the value of the specified digital pin for this controller.

Parameters:

pin - The pin of the controller jack to read

Returns:

The state of the pin

write

public void write(@Cast(value="Controller::DigitalPin")
                  int pin,
                  @Cast(value="bool")
                  boolean value)

Write the given value to the specified digital pin for this controller. Writing is only allowed to the pins associated with the PIA. Therefore you cannot write to pin six.

Parameters:

pin - The pin of the controller jack to write to

value - The value to write to the pin

maximumResistance

@MemberGetter
 @Cast(value="const Int32")
public static int maximumResistance()

Constant which represents maximum resistance for analog pins

minimumResistance

@MemberGetter
 @Cast(value="const Int32")
public static int minimumResistance()

Constant which represents minimum resistance for analog pins