net.java.games.input.AbstractComponent Maven / Gradle / Ivy
/*
* %W% %E%
*
* Copyright 2002 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
/*****************************************************************************
* Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistribution of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* - Redistribution in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materails provided with the distribution.
*
* Neither the name Sun Microsystems, Inc. or the names of the contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* This software is provided "AS IS," without a warranty of any kind.
* ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING
* ANY IMPLIED WARRANT OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
* NON-INFRINGEMEN, ARE HEREBY EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND
* ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS
* A RESULT OF USING, MODIFYING OR DESTRIBUTING THIS SOFTWARE OR ITS
* DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST
* REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL,
* INCIDENTAL OR PUNITIVE DAMAGES. HOWEVER CAUSED AND REGARDLESS OF THE THEORY
* OF LIABILITY, ARISING OUT OF THE USE OF OUR INABILITY TO USE THIS SOFTWARE,
* EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
*
* You acknowledge that this software is not designed or intended for us in
* the design, construction, operation or maintenance of any nuclear facility
*
*****************************************************************************/
package net.java.games.input;
import java.io.IOException;
/**
* Skeleton implementation of a named axis.
*/
public abstract class AbstractComponent implements Component {
/**
* Human-readable name for this Axis
*/
private final String name;
private final Identifier id;
private boolean has_polled;
private float value;
private float event_value;
/**
* Protected constructor
* @param name A name for the axis
*/
protected AbstractComponent(String name, Identifier id) {
this.name = name;
this.id = id;
}
/**
* Returns the type or identifier of the axis.
*/
public Identifier getIdentifier() {
return id;
}
/**
* Returns whether or not the axis is analog, or false if it is digital.
* @return false by default, can be overridden
*/
public boolean isAnalog() {
return false;
}
/**
* Returns the suggested dead zone for this axis. Dead zone is the
* amount polled data can vary before considered a significant change
* in value. An application can safely ignore changes less than this
* value in the positive or negative direction.
* @return 0.0f by default, can be overridden
*/
public float getDeadZone() {
return 0.0f;
}
/**
* Returns the data from the last time the control has been polled.
* If this axis is a button, the value returned will be either 0.0f or 1.0f.
* If this axis is normalised, the value returned will be between -1.0f and
* 1.0f.
* @return The data from the last time the control has been polled.
*/
public final float getPollData() {
if (!has_polled && !isRelative()) {
has_polled = true;
try {
setPollData(poll());
} catch (IOException e) {
ControllerEnvironment.log("Failed to poll component: " + e);
}
}
return value;
}
final void resetHasPolled() {
has_polled = false;
}
final void setPollData(float value) {
this.value = value;
}
final float getEventValue() {
return event_value;
}
final void setEventValue(float event_value) {
this.event_value = event_value;
}
/**
* Returns a human-readable name for this axis.
*/
public String getName() {
return name;
}
/**
* Returns a non-localized string description of this axis.
*/
public String toString() {
return name;
}
protected abstract float poll() throws IOException;
} // AbstractAxis