Files
Awperative/docs/api/Awperative.Scene.html
2026-02-11 21:04:23 -05:00

585 lines
15 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Scene | Awperative </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class Scene | Awperative ">
<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="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">
<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>
</head>
<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="Awperative">
Awperative
</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" 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="Awperative.Scene">
<h1 id="Awperative_Scene" data-uid="Awperative.Scene" class="text-break">
Class Scene
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Awperative.html">Awperative</a></dd></dl>
<dl><dt>Assembly</dt><dd>Awperative.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class Scene : DockerEntity</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><a class="xref" href="Awperative.DockerEntity.html">DockerEntity</a></div>
<div><span class="xref">Scene</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="Awperative.DockerEntity.html#Awperative_DockerEntity_AddComponent__1">DockerEntity.AddComponent&lt;Generic&gt;()</a>
</div>
<div>
<a class="xref" href="Awperative.DockerEntity.html#Awperative_DockerEntity_AddComponent__1_System_Object___">DockerEntity.AddComponent&lt;Generic&gt;(object[])</a>
</div>
<div>
<a class="xref" href="Awperative.DockerEntity.html#Awperative_DockerEntity_Scene">DockerEntity.Scene</a>
</div>
<div>
<a class="xref" href="Awperative.DockerEntity.html#Awperative_DockerEntity_GetComponent__1">DockerEntity.GetComponent&lt;Generic&gt;()</a>
</div>
<div>
<a class="xref" href="Awperative.DockerEntity.html#Awperative_DockerEntity_GetComponents__1">DockerEntity.GetComponents&lt;Generic&gt;()</a>
</div>
<div>
<a class="xref" href="Awperative.DockerEntity.html#Awperative_DockerEntity_RemoveComponent_Awperative_Component_">DockerEntity.RemoveComponent(Component)</a>
</div>
<div>
<a class="xref" href="Awperative.DockerEntity.html#Awperative_DockerEntity_RemoveComponent__1">DockerEntity.RemoveComponent&lt;Generic&gt;()</a>
</div>
<div>
<a class="xref" href="Awperative.DockerEntity.html#Awperative_DockerEntity_RemoveComponents__1">DockerEntity.RemoveComponents&lt;Generic&gt;()</a>
</div>
<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.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 class="section" id="properties">Properties
</h2>
<a id="Awperative_Scene_bodies_" data-uid="Awperative.Scene.bodies*"></a>
<h3 id="Awperative_Scene_bodies" data-uid="Awperative.Scene.bodies">
bodies
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;Body&gt; bodies { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Awperative.Body.html">Body</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Awperative_Scene_AddBody_" data-uid="Awperative.Scene.AddBody*"></a>
<h3 id="Awperative_Scene_AddBody" data-uid="Awperative.Scene.AddBody">
AddBody()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Body AddBody()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Awperative.Body.html">Body</a></dt>
<dd></dd>
</dl>
<a id="Awperative_Scene_AddBody_" data-uid="Awperative.Scene.AddBody*"></a>
<h3 id="Awperative_Scene_AddBody_Awperative_Transform_" data-uid="Awperative.Scene.AddBody(Awperative.Transform)">
AddBody(Transform)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Body AddBody(Transform __transform)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>__transform</code> <a class="xref" href="Awperative.Transform.html">Transform</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Awperative.Body.html">Body</a></dt>
<dd></dd>
</dl>
<a id="Awperative_Scene_DestroyBody_" data-uid="Awperative.Scene.DestroyBody*"></a>
<h3 id="Awperative_Scene_DestroyBody_Awperative_Body_" data-uid="Awperative.Scene.DestroyBody(Awperative.Body)">
DestroyBody(Body)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void DestroyBody(Body __body)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>__body</code> <a class="xref" href="Awperative.Body.html">Body</a></dt>
<dd></dd>
</dl>
<a id="Awperative_Scene_Draw_" data-uid="Awperative.Scene.Draw*"></a>
<h3 id="Awperative_Scene_Draw_Microsoft_Xna_Framework_GameTime_" data-uid="Awperative.Scene.Draw(Microsoft.Xna.Framework.GameTime)">
Draw(GameTime)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Draw(GameTime __gameTime)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>__gameTime</code> <span class="xref">GameTime</span></dt>
<dd></dd>
</dl>
<a id="Awperative_Scene_GetBodies_" data-uid="Awperative.Scene.GetBodies*"></a>
<h3 id="Awperative_Scene_GetBodies_System_String_" data-uid="Awperative.Scene.GetBodies(System.String)">
GetBodies(string)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Body[] GetBodies(string tag)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>tag</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Awperative.Body.html">Body</a>[]</dt>
<dd></dd>
</dl>
<a id="Awperative_Scene_GetBody_" data-uid="Awperative.Scene.GetBody*"></a>
<h3 id="Awperative_Scene_GetBody_System_String_" data-uid="Awperative.Scene.GetBody(System.String)">
GetBody(string)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Body GetBody(string tag)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>tag</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Awperative.Body.html">Body</a></dt>
<dd></dd>
</dl>
<a id="Awperative_Scene_Load_" data-uid="Awperative.Scene.Load*"></a>
<h3 id="Awperative_Scene_Load" data-uid="Awperative.Scene.Load">
Load()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Load()</code></pre>
</div>
<a id="Awperative_Scene_Unload_" data-uid="Awperative.Scene.Unload*"></a>
<h3 id="Awperative_Scene_Unload" data-uid="Awperative.Scene.Unload">
Unload()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Unload()</code></pre>
</div>
<a id="Awperative_Scene_Update_" data-uid="Awperative.Scene.Update*"></a>
<h3 id="Awperative_Scene_Update_Microsoft_Xna_Framework_GameTime_" data-uid="Awperative.Scene.Update(Microsoft.Xna.Framework.GameTime)">
Update(GameTime)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Update(GameTime __gameTime)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>__gameTime</code> <span class="xref">GameTime</span></dt>
<dd></dd>
</dl>
<h2 class="section" id="events">Events
</h2>
<h3 id="Awperative_Scene_BodyCreatedEvent" data-uid="Awperative.Scene.BodyCreatedEvent">
BodyCreatedEvent
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;BodyCreateEvent&gt; BodyCreatedEvent</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="Awperative.BodyCreateEvent.html">BodyCreateEvent</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Awperative_Scene_BodyDestroyedEvent" data-uid="Awperative.Scene.BodyDestroyedEvent">
BodyDestroyedEvent
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;BodyDestroyEvent&gt; BodyDestroyedEvent</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="Awperative.BodyDestroyEvent.html">BodyDestroyEvent</a>&gt;</dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
</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>