HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Collision.AnchoredCollidablePair.html
iambossTC b5cad3c171 tune
2025-07-25 16:27:29 +08:00

678 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class AnchoredCollidablePair | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class AnchoredCollidablePair | HiAPI-C# 2025 ">
<meta name="description" content="Represents a pair of anchored collidable objects for collision detection.">
<link rel="icon" href="../img/HiAPI.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="../img/HiAPI.logo.png" 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" 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="Hi.Collision.AnchoredCollidablePair">
<h1 id="Hi_Collision_AnchoredCollidablePair" data-uid="Hi.Collision.AnchoredCollidablePair" class="text-break">
Class AnchoredCollidablePair
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Collision.html">Collision</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents a pair of anchored collidable objects for collision detection.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class AnchoredCollidablePair : IMakeXmlSource</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">AnchoredCollidablePair</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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.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>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_Collision_AnchoredCollidablePair__ctor_" data-uid="Hi.Collision.AnchoredCollidablePair.#ctor*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair__ctor_Hi_Collision_IAnchoredCollidableBased_Hi_Collision_IAnchoredCollidableBased_" data-uid="Hi.Collision.AnchoredCollidablePair.#ctor(Hi.Collision.IAnchoredCollidableBased,Hi.Collision.IAnchoredCollidableBased)">
AnchoredCollidablePair(IAnchoredCollidableBased, IAnchoredCollidableBased)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Collision.AnchoredCollidablePair.html">AnchoredCollidablePair</a> class with two collidable objects.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AnchoredCollidablePair(IAnchoredCollidableBased indexA, IAnchoredCollidableBased indexB)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>indexA</code> <a class="xref" href="Hi.Collision.IAnchoredCollidableBased.html">IAnchoredCollidableBased</a></dt>
<dd><p>The first collidable object.</p>
</dd>
<dt><code>indexB</code> <a class="xref" href="Hi.Collision.IAnchoredCollidableBased.html">IAnchoredCollidableBased</a></dt>
<dd><p>The second collidable object.</p>
</dd>
</dl>
<a id="Hi_Collision_AnchoredCollidablePair__ctor_" data-uid="Hi.Collision.AnchoredCollidablePair.#ctor*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair__ctor_System_String_Hi_Collision_IAnchoredCollidableBased_Hi_Collision_IAnchoredCollidableBased_" data-uid="Hi.Collision.AnchoredCollidablePair.#ctor(System.String,Hi.Collision.IAnchoredCollidableBased,Hi.Collision.IAnchoredCollidableBased)">
AnchoredCollidablePair(string, IAnchoredCollidableBased, IAnchoredCollidableBased)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Collision.AnchoredCollidablePair.html">AnchoredCollidablePair</a> class with a name and two collidable objects.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AnchoredCollidablePair(string name, IAnchoredCollidableBased indexA, IAnchoredCollidableBased indexB)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the pair.</p>
</dd>
<dt><code>indexA</code> <a class="xref" href="Hi.Collision.IAnchoredCollidableBased.html">IAnchoredCollidableBased</a></dt>
<dd><p>The first collidable object.</p>
</dd>
<dt><code>indexB</code> <a class="xref" href="Hi.Collision.IAnchoredCollidableBased.html">IAnchoredCollidableBased</a></dt>
<dd><p>The second collidable object.</p>
</dd>
</dl>
<a id="Hi_Collision_AnchoredCollidablePair__ctor_" data-uid="Hi.Collision.AnchoredCollidablePair.#ctor*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair__ctor_System_Xml_Linq_XElement_System_String_System_Object___" data-uid="Hi.Collision.AnchoredCollidablePair.#ctor(System.Xml.Linq.XElement,System.String,System.Object[])">
AnchoredCollidablePair(XElement, string, params object[])
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Collision.AnchoredCollidablePair.html">AnchoredCollidablePair</a> class from XML.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AnchoredCollidablePair(XElement src, string baseDirectory, params object[] res)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>The XML element containing the pair data.</p>
</dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for resolving relative paths.</p>
</dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd><p>Additional resources for initialization.</p>
</dd>
</dl>
<h2 class="section" id="fields">Fields
</h2>
<h3 id="Hi_Collision_AnchoredCollidablePair_XName" data-uid="Hi.Collision.AnchoredCollidablePair.XName">
XName
</h3>
<div class="markdown level1 summary"><p>The XML element name for serialization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string XName</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Collision_AnchoredCollidablePair_CollisionFlag_" data-uid="Hi.Collision.AnchoredCollidablePair.CollisionFlag*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair_CollisionFlag" data-uid="Hi.Collision.AnchoredCollidablePair.CollisionFlag">
CollisionFlag
</h3>
<div class="markdown level1 summary"><p>Gets or sets the collision flag indicating the collision status between the two objects.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CollisionFlag CollisionFlag { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Collision.CollisionFlag.html">CollisionFlag</a></dt>
<dd></dd>
</dl>
<a id="Hi_Collision_AnchoredCollidablePair_IndexA_" data-uid="Hi.Collision.AnchoredCollidablePair.IndexA*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair_IndexA" data-uid="Hi.Collision.AnchoredCollidablePair.IndexA">
IndexA
</h3>
<div class="markdown level1 summary"><p>Gets the first collidable object in the pair.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IAnchoredCollidableBased IndexA { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Collision.IAnchoredCollidableBased.html">IAnchoredCollidableBased</a></dt>
<dd></dd>
</dl>
<a id="Hi_Collision_AnchoredCollidablePair_IndexB_" data-uid="Hi.Collision.AnchoredCollidablePair.IndexB*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair_IndexB" data-uid="Hi.Collision.AnchoredCollidablePair.IndexB">
IndexB
</h3>
<div class="markdown level1 summary"><p>Gets the second collidable object in the pair.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IAnchoredCollidableBased IndexB { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Collision.IAnchoredCollidableBased.html">IAnchoredCollidableBased</a></dt>
<dd></dd>
</dl>
<a id="Hi_Collision_AnchoredCollidablePair_MatAB_" data-uid="Hi.Collision.AnchoredCollidablePair.MatAB*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair_MatAB" data-uid="Hi.Collision.AnchoredCollidablePair.MatAB">
MatAB
</h3>
<div class="markdown level1 summary"><p>Gets or sets the transformation matrix from object A to object B.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Mat4d MatAB { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Mat4d.html">Mat4d</a></dt>
<dd></dd>
</dl>
<a id="Hi_Collision_AnchoredCollidablePair_Name_" data-uid="Hi.Collision.AnchoredCollidablePair.Name*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair_Name" data-uid="Hi.Collision.AnchoredCollidablePair.Name">
Name
</h3>
<div class="markdown level1 summary"><p>Gets or sets the pair name for UI manipulation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Name { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="Hi_Collision_AnchoredCollidablePair_SafeDistance_" data-uid="Hi.Collision.AnchoredCollidablePair.SafeDistance*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair_SafeDistance" data-uid="Hi.Collision.AnchoredCollidablePair.SafeDistance">
SafeDistance
</h3>
<div class="markdown level1 summary"><p>Gets or sets the safe distance between the two collidable objects.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double SafeDistance { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Collision_AnchoredCollidablePair_Equals_" data-uid="Hi.Collision.AnchoredCollidablePair.Equals*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair_Equals_System_Object_" data-uid="Hi.Collision.AnchoredCollidablePair.Equals(System.Object)">
Equals(object)
</h3>
<div class="markdown level1 summary"><p>Determines whether the specified object is equal to the current object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>The object to compare with the current object.</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><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified object is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
<a id="Hi_Collision_AnchoredCollidablePair_GetHashCode_" data-uid="Hi.Collision.AnchoredCollidablePair.GetHashCode*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair_GetHashCode" data-uid="Hi.Collision.AnchoredCollidablePair.GetHashCode">
GetHashCode()
</h3>
<div class="markdown level1 summary"><p>Serves as the default hash function.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>A hash code for the current object.</p>
</dd>
</dl>
<a id="Hi_Collision_AnchoredCollidablePair_MakeXmlSource_" data-uid="Hi.Collision.AnchoredCollidablePair.MakeXmlSource*"></a>
<h3 id="Hi_Collision_AnchoredCollidablePair_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Collision.AnchoredCollidablePair.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
This method may also generate additional resources such as related files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for resolving relative paths</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path for the XML source</p>
</dd>
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>if true, the extended file creation is suppressed.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>An XML element representing the object's state</p>
</dd>
</dl>
<h4 class="section" id="Hi_Collision_AnchoredCollidablePair_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.</p>
</div>
</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> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
</div>
</div>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink