org.simbrain.world.odorworld.effectors

Class Turning

java.lang.Object

org.simbrain.world.odorworld.effectors.Effector

org.simbrain.world.odorworld.effectors.Turning

public class Turning
extends Effector

Effector for turning.

Author:

Jeff Yoshimi

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_AMOUNT Default amount.
static double	DEFAULT_DIRECTION Default direction.
static java.lang.String	DEFAULT_LABEL Default label.
static double	LEFT Direction value to turn left.
static double	RIGHT Direction value to turn right.

Fields inherited from class org.simbrain.world.odorworld.effectors.Effector

parent

Constructor Summary

Constructors

Constructor and Description
Turning(RotatingEntity parent, java.lang.String label, double direction) Construct a turning effector.

Method Summary

Modifier and Type	Method and Description
double	getAmount()
double	getDirection()
java.lang.String	getTypeDescription() Short description of the effector type.
void	setAmount(double amount)
void	setDirection(double direction)
void	update() Move the agent in a manner appropriate to the effector type.

Methods inherited from class org.simbrain.world.odorworld.effectors.Effector

getApplicableTypes, getId, getLabel, getParent, setId, setLabel

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DIRECTION

public static final double DEFAULT_DIRECTION

Default direction.

See Also:

Constant Field Values

LEFT

public static final double LEFT

Direction value to turn left.

See Also:

Constant Field Values

RIGHT

public static final double RIGHT

Direction value to turn right.

See Also:

Constant Field Values

DEFAULT_AMOUNT

public static final double DEFAULT_AMOUNT

Default amount.

See Also:

Constant Field Values

DEFAULT_LABEL

public static final java.lang.String DEFAULT_LABEL

Default label.

See Also:

Constant Field Values

Constructor Detail

Turning

public Turning(RotatingEntity parent,
               java.lang.String label,
               double direction)

Construct a turning effector.

Parameters:

parent - parent entity.

label - descriptive label

direction - amount turn in radians.

Method Detail

update

public void update()

Description copied from class: Effector

Move the agent in a manner appropriate to the effector type.

Specified by:

update in class Effector

getAmount

public double getAmount()

Returns:

the amount

setAmount

public void setAmount(double amount)

Parameters:

amount - the amount to set

getDirection

public double getDirection()

Returns:

the direction

setDirection

public void setDirection(double direction)

Parameters:

direction - the direction to set

getTypeDescription

public java.lang.String getTypeDescription()

Description copied from class: Effector

Short description of the effector type.

Specified by:

getTypeDescription in class Effector

Returns:

the short description of the type