Duality-BackgroundScroller-Example/Plugins/Duality.Plugins.Pathfindax.core.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Duality.Plugins.Pathfindax.core</name>
    </assembly>
    <members>
        <member name="T:Duality.Plugins.Pathfindax.Components.AstarPathfinderComponent">
            <summary>
            Provides a way for other components to request a path from A to B. Uses the A* algorithm.
            </summary>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.AstarPathfinderComponent.SourceNodeNetwork">
            <inheritdoc />
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.AstarPathfinderComponent.BoundRadius">
            <summary>
            Not used
            </summary>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.AstarPathfinderComponent.ShowNodeGrid">
            <summary>
            If <c>True</c> the <see cref="T:Pathfindax.Grid.ISourceNodeGrid`1"/> will be drawn to the scene using a <see cref="T:Duality.Plugins.Pathfindax.Grid.NodeGridVisualizer"/>
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Components.AstarPathfinderComponent.OnInit(Duality.Component.InitContext)">
            <inheritdoc />
        </member>
        <member name="T:Duality.Plugins.Pathfindax.Components.IPathfinderComponent`1">
            <summary>
            Generic interface for duality pathfinders
            </summary>
            <typeparam name="TSourceNodeNetwork"></typeparam>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.IPathfinderComponent`1.SourceNodeNetwork">
            <summary>
            The <see cref="T:Pathfindax.Grid.INodeNetwork`1"/> that is used for pathfinding
            </summary>
        </member>
        <member name="T:Duality.Plugins.Pathfindax.Components.IPathfinderComponent">
            <summary>
            Interface for duality pathfinders
            </summary>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.IPathfinderComponent.PathfinderId">
            <summary>
            The id of the pathfinder. This is used by the <see cref="T:Duality.Plugins.Pathfindax.PathfindEngine.PathfinderProxy`1"/> to get the correct pathfinder if there are multiple pathfinders in the <see cref="T:Duality.Resources.Scene"/>
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Components.IPathfinderComponent.ProcessPaths">
            <summary>
            Calls the callbacks on the completed paths and removes them from the completed queue
            </summary>
        </member>
        <member name="T:Duality.Plugins.Pathfindax.Components.PathfinderComponentBase`1">
            <summary>
            Base class for duality pathfinders
            </summary>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.PathfinderComponentBase`1.MultithreadedPathfinder">
            <summary>
            The <see cref="T:Pathfindax.PathfindEngine.IMultithreadedPathfinder"/> that will be doing the pathfinding on separate threads
            </summary>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.PathfinderComponentBase`1.PathfinderId">
            <inheritdoc />
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.PathfinderComponentBase`1.SourceNodeNetwork">
            <inheritdoc />
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Components.PathfinderComponentBase`1.OnInit(Duality.Component.InitContext)">
            <summary>
            Called when initializing the pathfinder
            </summary>
            <param name="context"></param>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Components.PathfinderComponentBase`1.ProcessPaths">
            <inheritdoc />
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Components.PathfinderComponentBase`1.RequestPath(Pathfindax.PathfindEngine.PathRequest)">
            <summary>
            Requests a new path
            </summary>
            <param name="pathRequest"></param>
        </member>
        <member name="T:Duality.Plugins.Pathfindax.Components.AStarGridPathfinderComponent">
            <summary>
            Provides a way for other components to request a path from A to B. Uses the A* algorithm.
            </summary>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.AStarGridPathfinderComponent.SourceNodeNetwork">
            <inheritdoc />
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.AStarGridPathfinderComponent.BoundRadius">
            <summary>
            Not used
            </summary>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Components.AStarGridPathfinderComponent.ShowNodeGrid">
            <summary>
            If <c>True</c> the <see cref="T:Pathfindax.Grid.ISourceNodeGrid`1"/> will be drawn to the scene using a <see cref="P:Duality.Plugins.Pathfindax.Components.AStarGridPathfinderComponent.NodeGridVisualizer"/>
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Components.AStarGridPathfinderComponent.OnInit(Duality.Component.InitContext)">
            <inheritdoc />
        </member>
        <member name="T:Duality.Plugins.Pathfindax.Extensions.PositionFExtensions">
            <summary>
            Extensions for <see cref="T:Pathfindax.Primitives.PositionF"/>
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Extensions.PositionFExtensions.ToVector2(Pathfindax.Primitives.PositionF)">
            <summary>
            Converts the <see cref="T:Pathfindax.Primitives.PositionF"/> to a <see cref="T:Duality.Vector2"/>
            </summary>
            <param name="position"></param>
            <returns></returns>
        </member>
        <member name="T:Duality.Plugins.Pathfindax.Grid.NodeGridRayCaster">
            <summary>
            Not used
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Grid.NodeGridRayCaster.GetConnectionCollisionCategory(Pathfindax.Nodes.INode,Pathfindax.Nodes.INode)">
            <summary>
            Not used
            </summary>
            <param name="from"></param>
            <param name="to"></param>
            <returns></returns>
        </member>
        <member name="T:Duality.Plugins.Pathfindax.Grid.NodeGridVisualizer">
            <summary>
            Class for visualizing a <see cref="T:Pathfindax.Grid.ISourceNodeGrid`1"/>
            </summary>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Grid.NodeGridVisualizer.CollisionCategory">
            <summary>
            The collision category that will be used to draw the nodes that are blocked.
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Grid.NodeGridVisualizer.#ctor(Pathfindax.Grid.ISourceNodeGrid{Pathfindax.Nodes.ISourceGridNode})">
            <summary>
            Creates a new <see cref="T:Duality.Plugins.Pathfindax.Grid.NodeGridVisualizer"/> instance
            </summary>
            <param name="sourceNodeNetwork"></param>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Grid.NodeGridVisualizer.Draw(Duality.Drawing.IDrawDevice)">
            <summary>
            This will draw the <see cref="T:Pathfindax.Nodes.ISourceGridNode"/> and their connections to other <see cref="T:Pathfindax.Nodes.ISourceGridNode"/> in the <see cref="T:Pathfindax.Grid.ISourceNodeGrid`1"/>
            </summary>
        </member>
        <member name="T:Duality.Plugins.Pathfindax.Grid.NodeNetworkVisualizer">
            <summary>
            Class for visualizing a <see cref="T:Pathfindax.Grid.INodeNetwork`1"/>
            </summary>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.Grid.NodeNetworkVisualizer.CollisionCategory">
            <summary>
            The collision category that will be used to draw the nodes that are blocked.
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Grid.NodeNetworkVisualizer.#ctor(Pathfindax.Grid.INodeNetwork{Pathfindax.Nodes.SourceNode},System.Single)">
            <summary>
            Creates a new instance of the <see cref="T:Duality.Plugins.Pathfindax.Grid.NodeNetworkVisualizer"/>
            </summary>
            <param name="nodeNetwork"></param>
            <param name="nodeSize"></param>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.Grid.NodeNetworkVisualizer.Draw(Duality.Drawing.IDrawDevice)">
            <summary>
            This will draw the <see cref="T:Pathfindax.Nodes.INode"/> and their connections to other <see cref="T:Pathfindax.Nodes.INode"/> in the <see cref="T:Pathfindax.Grid.INodeNetwork`1"/>
            </summary>
        </member>
        <member name="T:Duality.Plugins.Pathfindax.PathfindaxDualityCorePlugin">
            <summary>
            Defines a Duality core plugin.
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.PathfindaxDualityCorePlugin.#ctor">
            <summary>
            Creates a new <see cref="T:Duality.Plugins.Pathfindax.PathfindaxDualityCorePlugin"/> and does some initialization work
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.PathfindaxDualityCorePlugin.GetPathfinder``1(System.String)">
            <summary>
            Gets the <see cref="T:Duality.Plugins.Pathfindax.Components.IPathfinderComponent"/> with the same id and type. If the <paramref name="id"/> parameter is null then the first pathfinder will be returned.
            If there are multiple pathfinders of the same type and no id was supplied this will throw a exception.
            </summary>
            <param name="id"></param>
            <returns></returns>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.PathfindaxDualityCorePlugin.OnBeforeUpdate">
            <inheritdoc />
        </member>
        <member name="M:Duality.Plugins.Pathfindax.PathfindaxDualityCorePlugin.OnDisposePlugin">
            <inheritdoc />
        </member>
        <member name="T:Duality.Plugins.Pathfindax.PathfindEngine.PathfinderProxy`1">
             <summary>
             Provides access to the pathfinder.
             </summary>
             <example>
             <code>			
             public class PathfinderProxyExample : Component, ICmpInitializable
            	{
            		private PathfinderProxy&lt;ISourceNodeGrid&lt;ISourceGridNode&gt;&gt; _pathfinderProxy;
            
            		public void OnInit(InitContext context)
            		{
            		    if (context == InitContext.Activate &amp;&amp; DualityApp.ExecContext == DualityApp.ExecutionContext.Game)
            		    {
            		        _pathfinderProxy = new PathfinderProxy&lt;ISourceNodeGrid&lt;ISourceGridNode&gt;&gt;();
            		    	//Now you can use _pathfinderProxy.RequestPath(PathRequest) to request a path from the pathfinder
            		    }
            		}
            		
            		public void OnShutdown(ShutdownContext context) { }
             }  
             </code>
             </example>
             <example>
             <img src="../media/PathfindProxyDiagram.png" />
             </example>
             <typeparam name="TSourceNodeNetwork">The type of source network the pathfinder uses</typeparam>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.PathfindEngine.PathfinderProxy`1.PathfinderId">
            <summary>
            The id of the pathfinder. You can keep this empty if you only have 1 pathfinder in a <see cref="T:Duality.Resources.Scene"/>
            </summary>
        </member>
        <member name="P:Duality.Plugins.Pathfindax.PathfindEngine.PathfinderProxy`1.PathfinderComponent">
            <summary>
            The actual pathfinder
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.PathfindEngine.PathfinderProxy`1.#ctor">
            <summary>
            Creates a new <see cref="T:Duality.Plugins.Pathfindax.PathfindEngine.PathfinderProxy`1"/> with no id. This will only work if there is only 1 <see cref="T:Duality.Plugins.Pathfindax.Components.IPathfinderComponent"/> in the scene.
            </summary>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.PathfindEngine.PathfinderProxy`1.#ctor(System.String)">
            <summary>
            Creates a new <see cref="T:Duality.Plugins.Pathfindax.PathfindEngine.PathfinderProxy`1"/>
            </summary>
            <param name="pathfinderId">The id that will be used to find the <see cref="T:Duality.Plugins.Pathfindax.Components.IPathfinderComponent"/></param>
        </member>
        <member name="M:Duality.Plugins.Pathfindax.PathfindEngine.PathfinderProxy`1.RequestPath(Pathfindax.PathfindEngine.PathRequest)">
            <summary>
            Requests the <see cref="T:Duality.Plugins.Pathfindax.Components.IPathfinderComponent"/> for a new path
            </summary>
            <param name="pathRequest"></param>
        </member>
    </members>
</doc>