2026-02-11 04:11:05 +08:00

762 lines
21 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Pickable | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class Pickable | HiAPI-C# 2025 ">
<meta name="description" content="Picking event handler for rendering. Note that it has to be disposed manually or the object occurs memory leak.">
<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.Disp.Pickable">
<h1 id="Hi_Disp_Pickable" data-uid="Hi.Disp.Pickable" class="text-break">
Class Pickable
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Disp.html">Disp</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiDisp.dll</dd></dl>
</div>
<div class="markdown summary"><p>Picking event handler for rendering.
Note that it has to be disposed manually or the object occurs memory leak.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class Pickable : IGetPickable, IDisposable</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">Pickable</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Disp.IGetPickable.html">IGetPickable</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
</dd>
</dl>
<dl class="typelist derived">
<dt>Derived</dt>
<dd>
<div><a class="xref" href="Hi.Cbtr.CbtrPickable.html">CbtrPickable</a></div>
<div><a class="xref" href="Hi.Disp.ShowEventPickable.html">ShowEventPickable</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)">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>
<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_Disp_Pickable__ctor_" data-uid="Hi.Disp.Pickable.#ctor*"></a>
<h3 id="Hi_Disp_Pickable__ctor" data-uid="Hi.Disp.Pickable.#ctor">
Pickable()
</h3>
<div class="markdown level1 summary"><p>Ctor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Pickable()</code></pre>
</div>
<h2 class="section" id="fields">Fields
</h2>
<h3 id="Hi_Disp_Pickable_mark" data-uid="Hi.Disp.Pickable.mark">
mark
</h3>
<div class="markdown level1 summary"><p>Internal only.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected picking_mark_t* mark</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Native.picking_mark_t.html">picking_mark_t</a>*</dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Disp_Pickable_Pickables_" data-uid="Hi.Disp.Pickable.Pickables*"></a>
<h3 id="Hi_Disp_Pickable_Pickables" data-uid="Hi.Disp.Pickable.Pickables">
Pickables
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static ConcurrentDictionary&lt;Pickable, Pickable&gt; Pickables { 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.concurrent.concurrentdictionary-2">ConcurrentDictionary</a>&lt;<a class="xref" href="Hi.Disp.Pickable.html">Pickable</a>, <a class="xref" href="Hi.Disp.Pickable.html">Pickable</a>&gt;</dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Disp_Pickable_Pickables_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Design Concern: Substitude of ConcurrentSet.</p>
</div>
<a id="Hi_Disp_Pickable_PickingID_" data-uid="Hi.Disp.Pickable.PickingID*"></a>
<h3 id="Hi_Disp_Pickable_PickingID" data-uid="Hi.Disp.Pickable.PickingID">
PickingID
</h3>
<div class="markdown level1 summary"><p>ID of picking event.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int PickingID { 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.int32">int</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Disp_Pickable_Dispose_" data-uid="Hi.Disp.Pickable.Dispose*"></a>
<h3 id="Hi_Disp_Pickable_Dispose" data-uid="Hi.Disp.Pickable.Dispose">
Dispose()
</h3>
<div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
</div>
<a id="Hi_Disp_Pickable_Dispose_" data-uid="Hi.Disp.Pickable.Dispose*"></a>
<h3 id="Hi_Disp_Pickable_Dispose_System_Boolean_" data-uid="Hi.Disp.Pickable.Dispose(System.Boolean)">
Dispose(bool)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>disposing</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_Disp_Pickable_Finalize_" data-uid="Hi.Disp.Pickable.Finalize*"></a>
<h3 id="Hi_Disp_Pickable_Finalize" data-uid="Hi.Disp.Pickable.Finalize">
~Pickable()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected ~Pickable()</code></pre>
</div>
<a id="Hi_Disp_Pickable_GetPickable_" data-uid="Hi.Disp.Pickable.GetPickable*"></a>
<h3 id="Hi_Disp_Pickable_GetPickable" data-uid="Hi.Disp.Pickable.GetPickable">
GetPickable()
</h3>
<div class="markdown level1 summary"><p>Get <a class="xref" href="Hi.Disp.Pickable.html">Pickable</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Pickable GetPickable()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Disp.Pickable.html">Pickable</a></dt>
<dd><p>pickable</p>
</dd>
</dl>
<a id="Hi_Disp_Pickable_OnKeyDown_" data-uid="Hi.Disp.Pickable.OnKeyDown*"></a>
<h3 id="Hi_Disp_Pickable_OnKeyDown_Hi_Native_key_event_t_Hi_Disp_DispEngine_" data-uid="Hi.Disp.Pickable.OnKeyDown(Hi.Native.key_event_t,Hi.Disp.DispEngine)">
OnKeyDown(key_event_t, DispEngine)
</h3>
<div class="markdown level1 summary"><p>Behavior on key down.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnKeyDown(key_event_t e, DispEngine dispEngine)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>e</code> <a class="xref" href="Hi.Native.key_event_t.html">key_event_t</a></dt>
<dd><p>event</p>
</dd>
<dt><code>dispEngine</code> <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a></dt>
<dd><p>display engine</p>
</dd>
</dl>
<a id="Hi_Disp_Pickable_OnKeyUp_" data-uid="Hi.Disp.Pickable.OnKeyUp*"></a>
<h3 id="Hi_Disp_Pickable_OnKeyUp_Hi_Native_key_event_t_Hi_Disp_DispEngine_" data-uid="Hi.Disp.Pickable.OnKeyUp(Hi.Native.key_event_t,Hi.Disp.DispEngine)">
OnKeyUp(key_event_t, DispEngine)
</h3>
<div class="markdown level1 summary"><p>Behavior on key up</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnKeyUp(key_event_t e, DispEngine dispEngine)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>e</code> <a class="xref" href="Hi.Native.key_event_t.html">key_event_t</a></dt>
<dd><p>event</p>
</dd>
<dt><code>dispEngine</code> <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a></dt>
<dd><p>display engine</p>
</dd>
</dl>
<a id="Hi_Disp_Pickable_OnMouseDown_" data-uid="Hi.Disp.Pickable.OnMouseDown*"></a>
<h3 id="Hi_Disp_Pickable_OnMouseDown_Hi_Native_mouse_button_event_t_Hi_Disp_DispEngine_" data-uid="Hi.Disp.Pickable.OnMouseDown(Hi.Native.mouse_button_event_t,Hi.Disp.DispEngine)">
OnMouseDown(mouse_button_event_t, DispEngine)
</h3>
<div class="markdown level1 summary"><p>Behavior on mouse down</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnMouseDown(mouse_button_event_t e, DispEngine dispEngine)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>e</code> <a class="xref" href="Hi.Native.mouse_button_event_t.html">mouse_button_event_t</a></dt>
<dd><p>event</p>
</dd>
<dt><code>dispEngine</code> <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a></dt>
<dd><p>display engine</p>
</dd>
</dl>
<a id="Hi_Disp_Pickable_OnMouseEnter_" data-uid="Hi.Disp.Pickable.OnMouseEnter*"></a>
<h3 id="Hi_Disp_Pickable_OnMouseEnter_Hi_Native_ui_event_type_Hi_Disp_DispEngine_" data-uid="Hi.Disp.Pickable.OnMouseEnter(Hi.Native.ui_event_type,Hi.Disp.DispEngine)">
OnMouseEnter(ui_event_type, DispEngine)
</h3>
<div class="markdown level1 summary"><p>Behavior on mouse enter</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnMouseEnter(ui_event_type e, DispEngine dispEngine)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>e</code> <a class="xref" href="Hi.Native.ui_event_type.html">ui_event_type</a></dt>
<dd><p>event type</p>
</dd>
<dt><code>dispEngine</code> <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a></dt>
<dd><p>display engine</p>
</dd>
</dl>
<a id="Hi_Disp_Pickable_OnMouseLeave_" data-uid="Hi.Disp.Pickable.OnMouseLeave*"></a>
<h3 id="Hi_Disp_Pickable_OnMouseLeave_Hi_Native_ui_event_type_Hi_Disp_DispEngine_" data-uid="Hi.Disp.Pickable.OnMouseLeave(Hi.Native.ui_event_type,Hi.Disp.DispEngine)">
OnMouseLeave(ui_event_type, DispEngine)
</h3>
<div class="markdown level1 summary"><p>Behavior on mouse leave</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnMouseLeave(ui_event_type e, DispEngine dispEngine)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>e</code> <a class="xref" href="Hi.Native.ui_event_type.html">ui_event_type</a></dt>
<dd><p>event type</p>
</dd>
<dt><code>dispEngine</code> <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a></dt>
<dd><p>display engine</p>
</dd>
</dl>
<a id="Hi_Disp_Pickable_OnMouseMove_" data-uid="Hi.Disp.Pickable.OnMouseMove*"></a>
<h3 id="Hi_Disp_Pickable_OnMouseMove_Hi_Native_mouse_move_event_t_Hi_Disp_DispEngine_" data-uid="Hi.Disp.Pickable.OnMouseMove(Hi.Native.mouse_move_event_t,Hi.Disp.DispEngine)">
OnMouseMove(mouse_move_event_t, DispEngine)
</h3>
<div class="markdown level1 summary"><p>Behavior on mouse move</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnMouseMove(mouse_move_event_t e, DispEngine dispEngine)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>e</code> <a class="xref" href="Hi.Native.mouse_move_event_t.html">mouse_move_event_t</a></dt>
<dd><p>event</p>
</dd>
<dt><code>dispEngine</code> <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a></dt>
<dd><p>display engine</p>
</dd>
</dl>
<a id="Hi_Disp_Pickable_OnMouseUp_" data-uid="Hi.Disp.Pickable.OnMouseUp*"></a>
<h3 id="Hi_Disp_Pickable_OnMouseUp_Hi_Native_mouse_button_event_t_Hi_Disp_DispEngine_" data-uid="Hi.Disp.Pickable.OnMouseUp(Hi.Native.mouse_button_event_t,Hi.Disp.DispEngine)">
OnMouseUp(mouse_button_event_t, DispEngine)
</h3>
<div class="markdown level1 summary"><p>Behavior on mouse up</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnMouseUp(mouse_button_event_t e, DispEngine dispEngine)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>e</code> <a class="xref" href="Hi.Native.mouse_button_event_t.html">mouse_button_event_t</a></dt>
<dd><p>event</p>
</dd>
<dt><code>dispEngine</code> <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a></dt>
<dd><p>display engine</p>
</dd>
</dl>
<a id="Hi_Disp_Pickable_OnMouseWheel_" data-uid="Hi.Disp.Pickable.OnMouseWheel*"></a>
<h3 id="Hi_Disp_Pickable_OnMouseWheel_Hi_Native_mouse_wheel_event_t_Hi_Disp_DispEngine_" data-uid="Hi.Disp.Pickable.OnMouseWheel(Hi.Native.mouse_wheel_event_t,Hi.Disp.DispEngine)">
OnMouseWheel(mouse_wheel_event_t, DispEngine)
</h3>
<div class="markdown level1 summary"><p>Behavior on mouse wheel</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnMouseWheel(mouse_wheel_event_t e, DispEngine dispEngine)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>e</code> <a class="xref" href="Hi.Native.mouse_wheel_event_t.html">mouse_wheel_event_t</a></dt>
<dd><p>event</p>
</dd>
<dt><code>dispEngine</code> <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a></dt>
<dd><p>display engine</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>