Skip to content

Commit

Permalink
Added Documentation and started working on the Website
Browse files Browse the repository at this point in the history
  • Loading branch information
@Kraaven
Kraaven committed Jun 3, 2024
1 parent 8694410 commit 1f37a50
Show file tree
Hide file tree
Showing 271 changed files with 20,409 additions and 33 deletions.
229 changes: 229 additions & 0 deletions Docs/_site/api/RayGame.CollisionDetection.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class CollisionDetection
</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class CollisionDetection
">


<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">

<meta name="docfx:rel" content="../">


<meta name="docfx:docurl" content="https://github.com/Kraaven/RayEngine/new/main/apiSpec/new?filename=RayGame_CollisionDetection.md&amp;value=---%0Auid%3A%20RayGame.CollisionDetection%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
</head>

<script type="module" src="./../public/docfx.min.js"></script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>


<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">

</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>

<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>

<nav id="breadcrumb"></nav>
</div>

<article data-uid="RayGame.CollisionDetection">



<h1 id="RayGame_CollisionDetection" data-uid="RayGame.CollisionDetection" class="text-break">
Class CollisionDetection
<a class="header-action link-secondary" title="View source" href="https://github.com/Kraaven/RayEngine/blob/main/RayGame/CollisionDetection.cs/#L15"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="RayGame.html">RayGame</a></dd></dl>
<dl><dt>Assembly</dt><dd>RayGame.dll</dd></dl>
</div>

<div class="markdown summary"><p>Provides a method for collision detection between shapes.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class CollisionDetection</code></pre>
</div>




<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">CollisionDetection</span></div>
</dd>
</dl>



<dl class="typelist derived">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>




<h2 id="RayGame_CollisionDetection_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>This is a Static class used internally to check the collision between Colliders in <a class="xref" href="RayGame.GameObject.html">GameObject</a>s.<strong>Primarily for internal use</strong></p>
</div>


<h2 class="section" id="methods">Methods
</h2>


<a id="RayGame_CollisionDetection_CheckCollision_" data-uid="RayGame.CollisionDetection.CheckCollision*"></a>

<h3 id="RayGame_CollisionDetection_CheckCollision_System_Numerics_Vector2___System_Numerics_Vector2___" data-uid="RayGame.CollisionDetection.CheckCollision(System.Numerics.Vector2[],System.Numerics.Vector2[])">
CheckCollision(Vector2[], Vector2[])
<a class="header-action link-secondary" title="View source" href="https://github.com/Kraaven/RayEngine/blob/main/RayGame/CollisionDetection.cs/#L23"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Checks if two shapes are colliding.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool CheckCollision(Vector2[] shape1, Vector2[] shape2)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>shape1</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.vector2">Vector2</a>[]</dt>
<dd><p>The first shape.</p>
</dd>
<dt><code>shape2</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.vector2">Vector2</a>[]</dt>
<dd><p>The second shape.</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>True if the shapes are colliding, otherwise false.</p>
</dd>
</dl>












</article>

<div class="contribution d-print-none">
<a href="https://github.com/Kraaven/RayEngine/blob/main/RayGame/CollisionDetection.cs/#L15" class="edit-link">Edit this page</a>
</div>


</div>

<div class="affix">
<nav id="affix"></nav>
</div>
</main>

<div class="container-xxl search-results" id="search-results"></div>

<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
Loading

0 comments on commit 1f37a50

Please sign in to comment.