Untold Engine  Beta v0.0.16
docs
U4DEngine::U4DCohesion Class Reference

The U4DCohesion class implements AI steering separation behavior. More...

Inherits U4DEngine::U4DArrive.

Public Member Functions

 U4DCohesion ()
 class construtor
 
 ~U4DCohesion ()
 class destructor
 
U4DVector3n getSteering (U4DDynamicAction *uPursuer, std::vector< U4DDynamicAction * > uNeighborsContainer)
 Computes the velocity for steering. More...
 
void setNeighborDistance (float uNeighborDistance)
 Sets the desired neighbor distance which will be influenced by the behavior. More...
 
- Public Member Functions inherited from U4DEngine::U4DArrive
 U4DArrive ()
 class constructor
 
 ~U4DArrive ()
 class destructor
 
U4DVector3n getSteering (U4DDynamicAction *uAction, U4DVector3n &uTargetPosition)
 Computes the velocity for steering. More...
 
void setTargetRadius (float uTargetRadius)
 sets the radius distance to the target where the velocity of the pursuer should come to a stop More...
 
void setSlowRadius (float uSlowRadius)
 sets the radius distance to the target where the pursuer should slow down More...
 
- Public Member Functions inherited from U4DEngine::U4DSteering
 U4DSteering ()
 class constructor for steering behavior
 
 ~U4DSteering ()
 class destructor for steering behavior
 
virtual U4DVector3n getSteering (U4DDynamicAction *uPursuer, U4DDynamicAction *uEvader)
 Computes the velocity for steering. More...
 
virtual U4DVector3n getSteering (U4DDynamicAction *uAction, std::vector< U4DSegment > &uPathContainer)
 Computes the velociry for steering along the provided path. More...
 
virtual U4DVector3n getSteering (U4DDynamicAction *uAction)
 Computes the velocity for steering. More...
 
void setMaxSpeed (float uMaxSpeed)
 sets the maximum speed for steering More...
 
virtual void setWanderOffset (float uWanderOffset)
 sets the wander offset used for the Wander steering behavior. This represents the distance offset between the pursuer and the wander target More...
 
virtual void setWanderRadius (float uWanderRadius)
 sets the wander circle radius for the Wander steering behavior More...
 
virtual void setWanderRate (float uWanderRate)
 sets the rate for the random number for wander target position More...
 
virtual void setPredictTime (float uPredictTime)
 sets the time in the future to predict the position More...
 
virtual void setPathOffset (float uPathOffset)
 set the distance along the path to generate the target position More...
 
virtual void setPathRadius (float uPathRadius)
 set the path radius More...
 
virtual int getCurrentPathIndex ()
 gets the current path the pursuer is following More...
 

Additional Inherited Members

- Protected Attributes inherited from U4DEngine::U4DSteering
float maxSpeed
 maximum speed for steering
 

Detailed Description

The U4DCohesion class implements AI steering separation behavior.

Member Function Documentation

◆ getSteering()

U4DVector3n U4DEngine::U4DCohesion::getSteering ( U4DDynamicAction uPursuer,
std::vector< U4DDynamicAction * >  uNeighborsContainer 
)

Computes the velocity for steering.

Parameters
uPursuerDynamic action represented as the pursuer
uNeighborsContainerneighbors container
Returns
velocity vector to apply to 3D model

◆ setNeighborDistance()

void U4DEngine::U4DCohesion::setNeighborDistance ( float  uNeighborDistance)

Sets the desired neighbor distance which will be influenced by the behavior.

Parameters
uNeighborDistanceNeighbor distance