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

Public Member Functions

 MyDestinationRing (ref Vector3D worldCenter, float innerRadius, float outerRadius)
 
void Init (ref Vector3D worldCenter, float innerRadius, float outerRadius)
 
void Reinit (ref Vector3D worldCenter)
 
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 9 of file MyDestinationRing.cs.

Constructor & Destructor Documentation

Sandbox.Game.AI.Pathfinding.MyDestinationRing.MyDestinationRing ( ref Vector3D  worldCenter,
float  innerRadius,
float  outerRadius 
)
inline

Definition at line 16 of file MyDestinationRing.cs.

Member Function Documentation

void Sandbox.Game.AI.Pathfinding.MyDestinationRing.DebugDraw ( )
inline
Vector3D Sandbox.Game.AI.Pathfinding.MyDestinationRing.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 71 of file MyDestinationRing.cs.

Vector3D Sandbox.Game.AI.Pathfinding.MyDestinationRing.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 53 of file MyDestinationRing.cs.

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

Returns center of the shape for pathfinding heuristics

Implements Sandbox.Game.AI.Pathfinding.IMyDestinationShape.

Definition at line 77 of file MyDestinationRing.cs.

void Sandbox.Game.AI.Pathfinding.MyDestinationRing.Init ( ref Vector3D  worldCenter,
float  innerRadius,
float  outerRadius 
)
inline

Definition at line 21 of file MyDestinationRing.cs.

float Sandbox.Game.AI.Pathfinding.MyDestinationRing.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 43 of file MyDestinationRing.cs.

void Sandbox.Game.AI.Pathfinding.MyDestinationRing.Reinit ( ref Vector3D  worldCenter)
inline

Definition at line 28 of file MyDestinationRing.cs.

void Sandbox.Game.AI.Pathfinding.MyDestinationRing.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 33 of file MyDestinationRing.cs.

void Sandbox.Game.AI.Pathfinding.MyDestinationRing.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 38 of file MyDestinationRing.cs.


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