city.cs.engine

Class Sensor

java.lang.Object

city.cs.engine.Fixture

city.cs.engine.Sensor

public class Sensor
extends Fixture

A sensor component of a rigid body. A sensor generates collision events but the collisions have no effect on the parent body's motion. Sensors are not displayed.

Constructor Summary

Constructors

Constructor and Description
Sensor(Body body, Shape shape) Create a sensor from a shape.
Sensor(Body body, Shape shape, float density) Create a sensor from a shape.

Method Summary

Modifier and Type	Method and Description
void	addSensorListener(SensorListener listener) Register a sensor listener.
void	removeAllSensorListeners() Deregister all sensor listeners.
void	removeSensorListener(SensorListener listener) Deregister a sensor listener.

Methods inherited from class city.cs.engine.Fixture

contains, destroy, getBody, getDensity, intersects, intersects, setDensity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Sensor

public Sensor(Body body,
              Shape shape,
              float density)

Create a sensor from a shape.

Parameters:

body - the body the sensor is part of

shape - the shape of the sensor

density - the density of the sensor (in kg/square metre)

Sensor

public Sensor(Body body,
              Shape shape)

Create a sensor from a shape. Default: density = 1.0.

Parameters:

body - the body the sensor is part of

shape - the shape of the sensor

Method Detail

addSensorListener

public void addSensorListener(SensorListener listener)

Register a sensor listener. The listener's beginContact() method is called when a solid fixture begins to overlap with the sensor, and its endContact() method is called when the fixture ceases to overlap.

Parameters:

listener - the listener to add

removeSensorListener

public void removeSensorListener(SensorListener listener)

Deregister a sensor listener.

Parameters:

listener - the listener to remove

removeAllSensorListeners

public void removeAllSensorListeners()

Deregister all sensor listeners. Does nothing if no listeners are registered.