org.simbrain.world.odorworld.effectors

Class StraightMovement

java.lang.Object

org.simbrain.world.odorworld.effectors.Effector

org.simbrain.world.odorworld.effectors.StraightMovement

public class StraightMovement
extends Effector

Effector for straight ahead movement.

Author:

Jeff Yoshimi

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LABEL Default label.
static double	DEFAULT_SCALING_FACTOR Default scaling factor.

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

parent

Constructor Summary

Constructors

Constructor and Description
StraightMovement(RotatingEntity parent, java.lang.String label) Construct the straight movement effector.

Method Summary

Modifier and Type	Method and Description
double	getAmount()
double	getScalingFactor()
java.lang.String	getTypeDescription() Short description of the effector type.
void	setAmount(double amount)
void	setScalingFactor(double scalingFactor)
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_SCALING_FACTOR

public static final double DEFAULT_SCALING_FACTOR

Default scaling factor.

See Also:

Constant Field Values

DEFAULT_LABEL

public static final java.lang.String DEFAULT_LABEL

Default label.

See Also:

Constant Field Values

Constructor Detail

StraightMovement

public StraightMovement(RotatingEntity parent,
                        java.lang.String label)

Construct the straight movement effector.

Parameters:

parent - parent entity.

label - descriptive label

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

getScalingFactor

public double getScalingFactor()

Returns:

the scalingFactor

setScalingFactor

public void setScalingFactor(double scalingFactor)

Parameters:

scalingFactor - the scalingFactor 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