Space Engineers
Public Member Functions | List of all members
Sandbox.Game.AI.Pathfinding.MyDestinationSphere Class Reference
Inheritance diagram for Sandbox.Game.AI.Pathfinding.MyDestinationSphere:
Sandbox.Game.AI.Pathfinding.IMyDestinationShape

Public Member Functions

 MyDestinationSphere (ref Vector3D worldCenter, float radius)
 
void Init (ref Vector3D worldCenter, float radius)
 
void SetRelativeTransform (MatrixD invWorldTransform)
 Should set the relative transform (matrix, relative vector or whatever is needed) from the world position. This will then allow the shape to be updated using UpdateWorldTransform. More...
 
void UpdateWorldTransform (MatrixD worldTransform)
 Should update world transform of this shape from the transform previously saved by SetRelativeTransform More...
 
float PointAdmissibility (Vector3D position, float tolerance)
 Should return the distance of the given point from the ideal position in the destination shape. If the point is outside of the destination shape, PositiveInfinity should be returned. Tolerance can be provided to allow points that lie further from the shape. More...
 
Vector3D GetClosestPoint (Vector3D queryPoint)
 Returns the point from the shape that is closest to the query point More...
 
Vector3D GetBestPoint (Vector3D queryPoint)
 Returns the ideal point towards the pathfinding should steer when starting from the query point. The difference between GetClosestPoint and this method can be shown on an example of a sphere shape: For outside points, GetClosestPoint will return points on the sphere's surface, whereas this method will always return the center of the sphere. More...
 
Vector3D GetDestination ()
 Returns center of the shape for pathfinding heuristics More...
 
void DebugDraw ()
 

Detailed Description

Definition at line 10 of file MyDestinationSphere.cs.

Constructor & Destructor Documentation

Sandbox.Game.AI.Pathfinding.MyDestinationSphere.MyDestinationSphere ( ref Vector3D  worldCenter,
float  radius 
)
inline

Definition at line 16 of file MyDestinationSphere.cs.

Member Function Documentation

void Sandbox.Game.AI.Pathfinding.MyDestinationSphere.DebugDraw ( )
inline
Vector3D Sandbox.Game.AI.Pathfinding.MyDestinationSphere.GetBestPoint ( Vector3D  queryPoint)
inline

Returns the ideal point towards the pathfinding should steer when starting from the query point. The difference between GetClosestPoint and this method can be shown on an example of a sphere shape: For outside points, GetClosestPoint will return points on the sphere's surface, whereas this method will always return the center of the sphere.

Note that for more complicated shapes (e.g. donut), this method returns different point that GetCenter.

Implements Sandbox.Game.AI.Pathfinding.IMyDestinationShape.

Definition at line 61 of file MyDestinationSphere.cs.

Vector3D Sandbox.Game.AI.Pathfinding.MyDestinationSphere.GetClosestPoint ( Vector3D  queryPoint)
inline

Returns the point from the shape that is closest to the query point

Implements Sandbox.Game.AI.Pathfinding.IMyDestinationShape.

Definition at line 47 of file MyDestinationSphere.cs.

Vector3D Sandbox.Game.AI.Pathfinding.MyDestinationSphere.GetDestination ( )
inline

Returns center of the shape for pathfinding heuristics

Implements Sandbox.Game.AI.Pathfinding.IMyDestinationShape.

Definition at line 66 of file MyDestinationSphere.cs.

void Sandbox.Game.AI.Pathfinding.MyDestinationSphere.Init ( ref Vector3D  worldCenter,
float  radius 
)
inline

Definition at line 21 of file MyDestinationSphere.cs.

float Sandbox.Game.AI.Pathfinding.MyDestinationSphere.PointAdmissibility ( Vector3D  position,
float  tolerance 
)
inline

Should return the distance of the given point from the ideal position in the destination shape. If the point is outside of the destination shape, PositiveInfinity should be returned. Tolerance can be provided to allow points that lie further from the shape.

Implements Sandbox.Game.AI.Pathfinding.IMyDestinationShape.

Definition at line 37 of file MyDestinationSphere.cs.

void Sandbox.Game.AI.Pathfinding.MyDestinationSphere.SetRelativeTransform ( MatrixD  invWorldTransform)
inline

Should set the relative transform (matrix, relative vector or whatever is needed) from the world position. This will then allow the shape to be updated using UpdateWorldTransform.

Implements Sandbox.Game.AI.Pathfinding.IMyDestinationShape.

Definition at line 27 of file MyDestinationSphere.cs.

void Sandbox.Game.AI.Pathfinding.MyDestinationSphere.UpdateWorldTransform ( MatrixD  worldTransform)
inline

Should update world transform of this shape from the transform previously saved by SetRelativeTransform

Implements Sandbox.Game.AI.Pathfinding.IMyDestinationShape.

Definition at line 32 of file MyDestinationSphere.cs.


The documentation for this class was generated from the following file: