mirror of
https://github.com/AlexMacocian/MonoGame.Extended.git
synced 2026-07-24 03:56:31 +00:00
Add comments for space algo interface.
This commit is contained in:
@@ -2,18 +2,39 @@ using System.Collections.Generic;
|
||||
|
||||
namespace MonoGame.Extended.Collisions;
|
||||
|
||||
/// <summary>
|
||||
/// Interface, which split space for optimization of collisions.
|
||||
/// </summary>
|
||||
public interface ISpaceAlgorithm
|
||||
{
|
||||
/// <summary>
|
||||
/// Inserts the actor into the space.
|
||||
/// The actor will have its OnCollision called when collisions occur.
|
||||
/// </summary>
|
||||
/// <param name="actor">Actor to insert.</param>
|
||||
void Insert(ICollisionActor actor);
|
||||
|
||||
/// <summary>
|
||||
/// Removes the actor into the space.
|
||||
/// </summary>
|
||||
/// <param name="actor">Actor to remove.</param>
|
||||
bool Remove(ICollisionActor actor);
|
||||
|
||||
/// <summary>
|
||||
/// Removes the actor into the space.
|
||||
/// The actor will have its OnCollision called when collisions occur.
|
||||
/// </summary>
|
||||
/// <param name="actor">Actor to remove.</param>
|
||||
IEnumerable<ICollisionActor> Query(RectangleF boundsBoundingRectangle);
|
||||
|
||||
/// <summary>
|
||||
/// for foreach
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
List<ICollisionActor>.Enumerator GetEnumerator();
|
||||
|
||||
/// <summary>
|
||||
/// Restructure a space with new positions
|
||||
/// Restructure the space with new positions.
|
||||
/// </summary>
|
||||
void Reset();
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user