Steerings
Class StickToPathSteer

java.lang.Object
  Steerings.StickToPathSteer

All Implemented Interfaces:

ISteering

public class StickToPathSteer
extends Object
implements ISteering

Steering that makes sure the bot won't get out of the "naviagation edge corridor".

Author:

Jimmy

Constructor Summary

StickToPathSteer(UT2004Bot bot)

Method Summary

NavPoint	getNearestNavPoint(cz.cuni.amis.pogamut.base3d.worldview.object.ILocated target, double maxDistance) Returns nearest NavPoint to some 'target' no further than 'maxDistance' from the bot.
StickToPathProperties	getProperties()
javax.vecmath.Vector3d	run(javax.vecmath.Vector3d scaledActualVelocity, RefBoolean wantsToGoFaster, RefBoolean wantsToStop, RefLocation focus) Moves the bot around the given pathFuture.
void	setProperties(SteeringProperties newProperties) The steering manager will set to the steering his steering properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

StickToPathSteer

public StickToPathSteer(UT2004Bot bot)

Method Detail

run

public javax.vecmath.Vector3d run(javax.vecmath.Vector3d scaledActualVelocity,
                                  RefBoolean wantsToGoFaster,
                                  RefBoolean wantsToStop,
                                  RefLocation focus)

Moves the bot around the given pathFuture.

Specified by:

run in interface ISteering

Parameters:

scaledActualVelocity - This is the force of the last velocity, scaled by its weight. The steering can use this vector to create the decelerating force.

wantsToGoFaster - The steering should set this ref parameter, whether is possible to enlarge the velocity (wantsToGoFaster=true), or not.

wantsToStop - If steering want's to stop the agent, he can set this ref parameter to true.

focus - If the wantsToStop is true, steering can set the focus Location, which means the orientation of the stopped agent. (Agent will rotate to this location.)

Returns:

The computed steering force.

getNearestNavPoint

public NavPoint getNearestNavPoint(cz.cuni.amis.pogamut.base3d.worldview.object.ILocated target,
                                   double maxDistance)

Returns nearest NavPoint to some 'target' no further than 'maxDistance' from the bot.

Parameters:

target -

maxDistance -

Returns:

setProperties

public void setProperties(SteeringProperties newProperties)

Description copied from interface: ISteering

The steering manager will set to the steering his steering properties. That could be set also many times.

Specified by:

setProperties in interface ISteering

Parameters:

newProperties - the new steering properties

getProperties

public StickToPathProperties getProperties()