869 lines
26 KiB
HTML
869 lines
26 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class Branch | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class Branch | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="The linkage between two objects.">
|
|
<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 "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<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.Mech.Topo.Branch">
|
|
|
|
|
|
|
|
<h1 id="Hi_Mech_Topo_Branch" data-uid="Hi.Mech.Topo.Branch" class="text-break">
|
|
Class Branch
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Mech.html">Mech</a>.<a class="xref" href="Hi.Mech.Topo.html">Topo</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>The linkage between two <a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a> objects.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class Branch</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">Branch</span></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)">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>
|
|
</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<TSelf>(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<TSrc>(TSrc, Action<TSrc>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</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="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_Arrow_" data-uid="Hi.Mech.Topo.Branch.Arrow*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Arrow" data-uid="Hi.Mech.Topo.Branch.Arrow">
|
|
Arrow
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Anchor from arrow side.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Anchor Arrow { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_Fletch_" data-uid="Hi.Mech.Topo.Branch.Fletch*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Fletch" data-uid="Hi.Mech.Topo.Branch.Fletch">
|
|
Fletch
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Anchor from fletch side.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Anchor Fletch { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_Guid_" data-uid="Hi.Mech.Topo.Branch.Guid*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Guid" data-uid="Hi.Mech.Topo.Branch.Guid">
|
|
Guid
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>GUID.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Guid Guid { 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.guid">Guid</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_IsBreak_" data-uid="Hi.Mech.Topo.Branch.IsBreak*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_IsBreak" data-uid="Hi.Mech.Topo.Branch.IsBreak">
|
|
IsBreak
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Is break.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsBreak { 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.boolean">bool</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_Name_" data-uid="Hi.Mech.Topo.Branch.Name*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Name" data-uid="Hi.Mech.Topo.Branch.Name">
|
|
Name
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the name of the branch.</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_Mech_Topo_Branch_Step_" data-uid="Hi.Mech.Topo.Branch.Step*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Step" data-uid="Hi.Mech.Topo.Branch.Step">
|
|
Step
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>If the <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Transformer">Transformer</a> is <a class="xref" href="Hi.Mech.Topo.IDynamicRegular.html">IDynamicRegular</a>,
|
|
the property is delegated from <a class="xref" href="Hi.Mech.Topo.IDynamicRegular.html">IDynamicRegular</a>.<a class="xref" href="Hi.Mech.Topo.IDynamicRegular.html#Hi_Mech_Topo_IDynamicRegular_Step">Step</a>;
|
|
otherwise, the getter returns NAN and setter does nothing.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public double Step { 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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_Transformer_" data-uid="Hi.Mech.Topo.Branch.Transformer*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Transformer" data-uid="Hi.Mech.Topo.Branch.Transformer">
|
|
Transformer
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Transformer.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ITransformer Transformer { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_Attach_" data-uid="Hi.Mech.Topo.Branch.Attach*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Attach_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_" data-uid="Hi.Mech.Topo.Branch.Attach(Hi.Mech.Topo.IGetAnchor,Hi.Mech.Topo.IGetAnchor)">
|
|
Attach(IGetAnchor, IGetAnchor)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Attempts to attach two anchors.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Branch Attach(IGetAnchor fletch, IGetAnchor arrow)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>fletch</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>See <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Fletch">Fletch</a></p>
|
|
</dd>
|
|
<dt><code>arrow</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>See <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Arrow">Arrow</a></p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.Branch.html">Branch</a></dt>
|
|
<dd><p>branch</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_Attach_" data-uid="Hi.Mech.Topo.Branch.Attach*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Attach_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_ITransformer_" data-uid="Hi.Mech.Topo.Branch.Attach(Hi.Mech.Topo.IGetAnchor,Hi.Mech.Topo.IGetAnchor,Hi.Mech.Topo.ITransformer)">
|
|
Attach(IGetAnchor, IGetAnchor, ITransformer)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Attempts to attach two anchors with a specified transformer.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Branch Attach(IGetAnchor fletch, IGetAnchor arrow, ITransformer transformer)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>fletch</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>See <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Fletch">Fletch</a></p>
|
|
</dd>
|
|
<dt><code>arrow</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>See <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Arrow">Arrow</a></p>
|
|
</dd>
|
|
<dt><code>transformer</code> <a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></dt>
|
|
<dd><p>See <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Transformer">Transformer</a></p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.Branch.html">Branch</a></dt>
|
|
<dd><p>branch</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_AttachIfAbsence_" data-uid="Hi.Mech.Topo.Branch.AttachIfAbsence*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_AttachIfAbsence_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_" data-uid="Hi.Mech.Topo.Branch.AttachIfAbsence(Hi.Mech.Topo.IGetAnchor,Hi.Mech.Topo.IGetAnchor)">
|
|
AttachIfAbsence(IGetAnchor, IGetAnchor)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Attempts to attach two anchors if they are not already connected.
|
|
If the anchors are already connected, returns null instead of throwing an exception.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Branch AttachIfAbsence(IGetAnchor fletch, IGetAnchor arrow)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>fletch</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>The fletch-side anchor to attach</p>
|
|
</dd>
|
|
<dt><code>arrow</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>The arrow-side anchor to attach</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.Branch.html">Branch</a></dt>
|
|
<dd><p>The newly created branch if successful, null if the anchors are already connected</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_Detach_" data-uid="Hi.Mech.Topo.Branch.Detach*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Detach" data-uid="Hi.Mech.Topo.Branch.Detach">
|
|
Detach()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Break the branch.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Detach()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_Detach_" data-uid="Hi.Mech.Topo.Branch.Detach*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Detach_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_" data-uid="Hi.Mech.Topo.Branch.Detach(Hi.Mech.Topo.IGetAnchor,Hi.Mech.Topo.IGetAnchor)">
|
|
Detach(IGetAnchor, IGetAnchor)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Break the branch from <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Get_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_">Get(IGetAnchor, IGetAnchor)</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void Detach(IGetAnchor fletch, IGetAnchor arrow)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>fletch</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>See <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Fletch">Fletch</a></p>
|
|
</dd>
|
|
<dt><code>arrow</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>See <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Arrow">Arrow</a></p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Exceptions</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></dt>
|
|
<dd><p>The exception is throwed if the <a class="xref" href="Hi.Mech.Topo.Branch.html">Branch</a> is not existed.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_DetachIfExisted_" data-uid="Hi.Mech.Topo.Branch.DetachIfExisted*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_DetachIfExisted_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_" data-uid="Hi.Mech.Topo.Branch.DetachIfExisted(Hi.Mech.Topo.IGetAnchor,Hi.Mech.Topo.IGetAnchor)">
|
|
DetachIfExisted(IGetAnchor, IGetAnchor)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Break the branch from <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Get_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_">Get(IGetAnchor, IGetAnchor)</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool DetachIfExisted(IGetAnchor fletch, IGetAnchor arrow)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>fletch</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>See <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Fletch">Fletch</a></p>
|
|
</dd>
|
|
<dt><code>arrow</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>See <a class="xref" href="Hi.Mech.Topo.Branch.html#Hi_Mech_Topo_Branch_Arrow">Arrow</a></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 <a class="xref" href="Hi.Mech.Topo.Branch.html">Branch</a> existed and then been deteched.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_Get_" data-uid="Hi.Mech.Topo.Branch.Get*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_Get_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_" data-uid="Hi.Mech.Topo.Branch.Get(Hi.Mech.Topo.IGetAnchor,Hi.Mech.Topo.IGetAnchor)">
|
|
Get(IGetAnchor, IGetAnchor)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Get existed Branch by <code class="paramref">fletchSource</code> and <code class="paramref">arrowSource</code>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Branch Get(IGetAnchor fletchSource, IGetAnchor arrowSource)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>fletchSource</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>fletch</p>
|
|
</dd>
|
|
<dt><code>arrowSource</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>arrow</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.Branch.html">Branch</a></dt>
|
|
<dd><p>The branch. If branch not exist, return null.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_IsExisted_" data-uid="Hi.Mech.Topo.Branch.IsExisted*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_IsExisted_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_" data-uid="Hi.Mech.Topo.Branch.IsExisted(Hi.Mech.Topo.IGetAnchor,Hi.Mech.Topo.IGetAnchor)">
|
|
IsExisted(IGetAnchor, IGetAnchor)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Checks if a branch exists between two anchors.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsExisted(IGetAnchor fletch, IGetAnchor arrow)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>fletch</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>The fletch-side anchor.</p>
|
|
</dd>
|
|
<dt><code>arrow</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>The arrow-side anchor.</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 a branch exists between the anchors, false otherwise.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_ToLinkString_" data-uid="Hi.Mech.Topo.Branch.ToLinkString*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_ToLinkString" data-uid="Hi.Mech.Topo.Branch.ToLinkString">
|
|
ToLinkString()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Get brief link description.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string ToLinkString()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</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_Mech_Topo_Branch_ToString_" data-uid="Hi.Mech.Topo.Branch.ToString*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_ToString" data-uid="Hi.Mech.Topo.Branch.ToString">
|
|
ToString()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>A string that represents the current object.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Mech_Topo_Branch_TryAttach_" data-uid="Hi.Mech.Topo.Branch.TryAttach*"></a>
|
|
|
|
<h3 id="Hi_Mech_Topo_Branch_TryAttach_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_ITransformer_" data-uid="Hi.Mech.Topo.Branch.TryAttach(Hi.Mech.Topo.IGetAnchor,Hi.Mech.Topo.IGetAnchor,Hi.Mech.Topo.ITransformer)">
|
|
TryAttach(IGetAnchor, IGetAnchor, ITransformer)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Attempts to attach two anchors with a specified transformer.
|
|
If the attachment fails, returns null instead of throwing an exception.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Branch TryAttach(IGetAnchor fletch, IGetAnchor arrow, ITransformer transformer)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>fletch</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>The fletch-side anchor to attach</p>
|
|
</dd>
|
|
<dt><code>arrow</code> <a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></dt>
|
|
<dd><p>The arrow-side anchor to attach</p>
|
|
</dd>
|
|
<dt><code>transformer</code> <a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></dt>
|
|
<dd><p>The transformer to use for the branch</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Mech.Topo.Branch.html">Branch</a></dt>
|
|
<dd><p>The newly created branch if successful, null if the attachment fails</p>
|
|
</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> 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>
|