SteeringProperties
Class PathFollowingProperties

Package class diagram package PathFollowingProperties
java.lang.Object
  extended by SteeringProperties.SteeringProperties
      extended by SteeringProperties.PathFollowingProperties
All Implemented Interfaces:
Serializable

public class PathFollowingProperties
extends SteeringProperties

The steering properties of the Path Following Steering.

Author:
Marki
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class SteeringProperties.SteeringProperties
SteeringProperties.BehaviorType
 
Field Summary
 
Fields inherited from class SteeringProperties.SteeringProperties
active, behaviorType, type, weight
 
Constructor Summary
PathFollowingProperties()
           
PathFollowingProperties(int repulsiveForce, int distanceFromThePath, cz.cuni.amis.pogamut.base.agent.navigation.IPathFuture<cz.cuni.amis.pogamut.base3d.worldview.object.ILocated> path, cz.cuni.amis.pogamut.base3d.worldview.object.Location targetLocation, double regulatingForce, int projection)
           
PathFollowingProperties(cz.cuni.amis.pogamut.base.agent.navigation.IPathFuture<? extends cz.cuni.amis.pogamut.base3d.worldview.object.ILocated> path)
           
PathFollowingProperties(SteeringProperties.BehaviorType behaviorType)
           
PathFollowingProperties(XMLPathFollowingProperties xml)
           
 
Method Summary
 int getDistanceFromThePath()
           
 cz.cuni.amis.pogamut.base.agent.navigation.IPathFuture<cz.cuni.amis.pogamut.base3d.worldview.object.ILocated> getPath()
           
 int getProjection()
           
 double getRegulatingForce()
           
 int getRepulsiveForce()
           
 String getSpecialText()
           
 cz.cuni.amis.pogamut.base3d.worldview.object.Location getTargetLocation()
           
 XMLPathFollowingProperties getXMLProperties()
           
 void setDistanceFromThePath(int distanceFromThePath)
           
protected  void setNewBehaviorType(SteeringProperties.BehaviorType behaviorType)
           
 void setPath(cz.cuni.amis.pogamut.base.agent.navigation.IPathFuture<cz.cuni.amis.pogamut.base3d.worldview.object.ILocated> path)
           
 void setProjection(int projection)
           
 void setProperties(SteeringProperties newProperties)
           
 void setRegulatingForce(double regulatingForce)
           
 void setRepulsiveForce(int orderOfTheForce)
           
 void setTargetLocation(cz.cuni.amis.pogamut.base3d.worldview.object.Location targetLocation)
           
 
Methods inherited from class SteeringProperties.SteeringProperties
getBehaviorType, getText, getType, getWeight, isActive, setActive, setBehaviorType, setType, setWeight
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PathFollowingProperties

public PathFollowingProperties()

PathFollowingProperties

public PathFollowingProperties(SteeringProperties.BehaviorType behaviorType)

PathFollowingProperties

public PathFollowingProperties(XMLPathFollowingProperties xml)

PathFollowingProperties

public PathFollowingProperties(cz.cuni.amis.pogamut.base.agent.navigation.IPathFuture<? extends cz.cuni.amis.pogamut.base3d.worldview.object.ILocated> path)

PathFollowingProperties

public PathFollowingProperties(int repulsiveForce,
                               int distanceFromThePath,
                               cz.cuni.amis.pogamut.base.agent.navigation.IPathFuture<cz.cuni.amis.pogamut.base3d.worldview.object.ILocated> path,
                               cz.cuni.amis.pogamut.base3d.worldview.object.Location targetLocation,
                               double regulatingForce,
                               int projection)
Parameters:
repulsiveForce - The magnitude of the repulsive force, to repulse agent from the side of the corridor. Reasonable values are 0 - 1000, the default value is 200.
distanceFromThePath - The maximal distance from the axe of the path. Reasonable values are 200 - 2000.
path - The list of ilocated elements - vertices of the path.
targetLocation - If we want to compute path later, we can store here the targetLocation of the path. This parameter isn't necessary.
regulatingForce - Helps the bot to keep the direction of the path. Recommended value is 50.
projection - The length of the projection - how much ahead we project our motion. Recommended values are 5-15.
Method Detail

setNewBehaviorType

protected void setNewBehaviorType(SteeringProperties.BehaviorType behaviorType)
Specified by:
setNewBehaviorType in class SteeringProperties

getRepulsiveForce

public int getRepulsiveForce()

setRepulsiveForce

public void setRepulsiveForce(int orderOfTheForce)

getDistanceFromThePath

public int getDistanceFromThePath()

setDistanceFromThePath

public void setDistanceFromThePath(int distanceFromThePath)

getPath

public cz.cuni.amis.pogamut.base.agent.navigation.IPathFuture<cz.cuni.amis.pogamut.base3d.worldview.object.ILocated> getPath()

setPath

public void setPath(cz.cuni.amis.pogamut.base.agent.navigation.IPathFuture<cz.cuni.amis.pogamut.base3d.worldview.object.ILocated> path)

getTargetLocation

public cz.cuni.amis.pogamut.base3d.worldview.object.Location getTargetLocation()

setTargetLocation

public void setTargetLocation(cz.cuni.amis.pogamut.base3d.worldview.object.Location targetLocation)

getRegulatingForce

public double getRegulatingForce()

setRegulatingForce

public void setRegulatingForce(double regulatingForce)

getProjection

public int getProjection()

setProjection

public void setProjection(int projection)

getSpecialText

public String getSpecialText()
Specified by:
getSpecialText in class SteeringProperties

setProperties

public void setProperties(SteeringProperties newProperties)
Specified by:
setProperties in class SteeringProperties

getXMLProperties

public XMLPathFollowingProperties getXMLProperties()


Copyright © 2013 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic. All Rights Reserved.