SteeringStuff
Interface ISteering

All Known Subinterfaces:

ISocialSteering

All Known Implementing Classes:

LeaderFollowingSteer, ObstacleAvoidanceSteer, PathFollowingSteer, PeopleAvoidanceSteer, StickToPathSteer, TargetApproachingSteer, TriangleSteer, WalkAlongSteer, WallFollowingSteer

public interface ISteering

An interface for all steerings.

Author:

Marki

Method Summary

javax.vecmath.Vector3d	run(javax.vecmath.Vector3d scaledActualVelocity, RefBoolean wantsToGoFaster, RefBoolean wantsToStop, RefLocation focus) The steering manager calls steering to compute the force of the steering in that tick (logic).
void	setProperties(SteeringProperties newProperties) The steering manager will set to the steering his steering properties.

Method Detail

run

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

The steering manager calls steering to compute the force of the steering in that tick (logic).

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.

setProperties

void setProperties(SteeringProperties newProperties)

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

Parameters:

newProperties - the new steering properties