423 lines
15 KiB
HTML
423 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class DemoPick1 | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class DemoPick1 | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Demonstrates basic object picking with mouse interaction in the HiAPI system. Shows how to create a pickable 3D object that responds to mouse events by changing its appearance. Implements the Pickable base class to enable mouse event handling.">
|
|
<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="Sample.Disp.DemoPick1">
|
|
|
|
|
|
|
|
<h1 id="Sample_Disp_DemoPick1" data-uid="Sample.Disp.DemoPick1" class="text-break">
|
|
Class DemoPick1
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Sample.html">Sample</a>.<a class="xref" href="Sample.Disp.html">Disp</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>Hi.Sample.Wpf.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>Demonstrates basic object picking with mouse interaction in the HiAPI system.
|
|
Shows how to create a pickable 3D object that responds to mouse events by changing its appearance.
|
|
Implements the Pickable base class to enable mouse event handling.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class DemoPick1 : Pickable, IGetPickable, IDisposable, IDisplayee, IExpandToBox3d</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="../api/Hi.Disp.Pickable.html">Pickable</a></div>
|
|
<div><span class="xref">DemoPick1</span></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl class="typelist implements">
|
|
<dt>Implements</dt>
|
|
<dd>
|
|
<div><a class="xref" href="../api/Hi.Disp.IGetPickable.html">IGetPickable</a></div>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
|
|
<div><a class="xref" href="../api/Hi.Disp.IDisplayee.html">IDisplayee</a></div>
|
|
<div><a class="xref" href="../api/Hi.Geom.IExpandToBox3d.html">IExpandToBox3d</a></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<dl class="typelist inheritedMembers">
|
|
<dt>Inherited Members</dt>
|
|
<dd>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_Pickables">Pickable.Pickables</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_mark">Pickable.mark</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_PickingID">Pickable.PickingID</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_GetPickable">Pickable.GetPickable()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_OnKeyDown_Hi_Native_key_event_t_Hi_Disp_DispEngine_">Pickable.OnKeyDown(key_event_t, DispEngine)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_OnKeyUp_Hi_Native_key_event_t_Hi_Disp_DispEngine_">Pickable.OnKeyUp(key_event_t, DispEngine)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_OnMouseDown_Hi_Native_mouse_button_event_t_Hi_Disp_DispEngine_">Pickable.OnMouseDown(mouse_button_event_t, DispEngine)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_OnMouseUp_Hi_Native_mouse_button_event_t_Hi_Disp_DispEngine_">Pickable.OnMouseUp(mouse_button_event_t, DispEngine)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_OnMouseMove_Hi_Native_mouse_move_event_t_Hi_Disp_DispEngine_">Pickable.OnMouseMove(mouse_move_event_t, DispEngine)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_OnMouseWheel_Hi_Native_mouse_wheel_event_t_Hi_Disp_DispEngine_">Pickable.OnMouseWheel(mouse_wheel_event_t, DispEngine)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_Dispose_System_Boolean_">Pickable.Dispose(bool)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="../api/Hi.Disp.Pickable.html#Hi_Disp_Pickable_Dispose">Pickable.Dispose()</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.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="Sample_Disp_DemoPick1_remarks">Remarks</h2>
|
|
<div class="markdown level0 remarks"><h3 id="source-code">Source Code</h3>
|
|
<pre><code class="lang-csharp" name="SampleCode">using Hi.Geom;
|
|
using Hi.Disp;
|
|
using Hi.Native;
|
|
|
|
namespace Sample.Disp
|
|
{
|
|
/// <summary>
|
|
/// Demonstrates basic object picking with mouse interaction in the HiAPI system.
|
|
/// Shows how to create a pickable 3D object that responds to mouse events by changing its appearance.
|
|
/// Implements the Pickable base class to enable mouse event handling.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// ### Source Code
|
|
/// [!code-csharp[SampleCode](~/../Hi.Sample.Wpf/Disp/DemoPick1.cs)]
|
|
/// </remarks>
|
|
public class DemoPick1 : Pickable, IDisplayee
|
|
{
|
|
bool isMouseOver = false;
|
|
/// <inheritdoc/>
|
|
public void Display(Bind bind)
|
|
{
|
|
bind.PickID = PickingID;
|
|
bind.Rgb = new Vec3d(isMouseOver ? 0 : 1, 1, 1);
|
|
new Box3d(0, 0, 0, 1, 1, 1).DisplayFace(bind);
|
|
bind.PickID = 0;
|
|
}
|
|
/// <inheritdoc/>
|
|
public void ExpandToBox3d(Box3d dst)
|
|
{
|
|
dst.Expand(new Vec3d(0, 0, 0));
|
|
dst.Expand(new Vec3d(1, 1, 1));
|
|
}
|
|
/// <inheritdoc/>
|
|
public override void OnMouseEnter(ui_event_type e, DispEngine dispEngine)
|
|
{
|
|
isMouseOver = true;
|
|
}
|
|
/// <inheritdoc/>
|
|
public override void OnMouseLeave(ui_event_type e, DispEngine dispEngine)
|
|
{
|
|
isMouseOver = false;
|
|
}
|
|
/// <summary>
|
|
/// Entry point for the DemoPick1 example.
|
|
/// Creates and displays a simple pickable object that changes color on mouse hover.
|
|
/// </summary>
|
|
static void Main()
|
|
{
|
|
DemoUtil.RunApplication("DemoPick1", new DemoPick1());
|
|
}
|
|
}
|
|
}
|
|
</code></pre></div>
|
|
|
|
|
|
<h2 class="section" id="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Sample_Disp_DemoPick1_Display_" data-uid="Sample.Disp.DemoPick1.Display*"></a>
|
|
|
|
<h3 id="Sample_Disp_DemoPick1_Display_Hi_Disp_Bind_" data-uid="Sample.Disp.DemoPick1.Display(Hi.Disp.Bind)">
|
|
Display(Bind)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Display function called in <a class="xref" href="../api/Hi.Disp.DispEngine.html">DispEngine</a> rendering loop.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Display(Bind bind)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>bind</code> <a class="xref" href="../api/Hi.Disp.Bind.html">Bind</a></dt>
|
|
<dd><p>Bind with <a class="xref" href="../api/Hi.Disp.DispEngine.html">DispEngine</a>. See <a class="xref" href="../api/Hi.Disp.Bind.html">Bind</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Sample_Disp_DemoPick1_ExpandToBox3d_" data-uid="Sample.Disp.DemoPick1.ExpandToBox3d*"></a>
|
|
|
|
<h3 id="Sample_Disp_DemoPick1_ExpandToBox3d_Hi_Geom_Box3d_" data-uid="Sample.Disp.DemoPick1.ExpandToBox3d(Hi.Geom.Box3d)">
|
|
ExpandToBox3d(Box3d)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Expands the destination box.
|
|
This function is usually used to compute the bounding box of elements.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ExpandToBox3d(Box3d dst)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>dst</code> <a class="xref" href="../api/Hi.Geom.Box3d.html">Box3d</a></dt>
|
|
<dd><p>Destination box</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Sample_Disp_DemoPick1_OnMouseEnter_" data-uid="Sample.Disp.DemoPick1.OnMouseEnter*"></a>
|
|
|
|
<h3 id="Sample_Disp_DemoPick1_OnMouseEnter_Hi_Native_ui_event_type_Hi_Disp_DispEngine_" data-uid="Sample.Disp.DemoPick1.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 override 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="../api/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="../api/Hi.Disp.DispEngine.html">DispEngine</a></dt>
|
|
<dd><p>display engine</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Sample_Disp_DemoPick1_OnMouseLeave_" data-uid="Sample.Disp.DemoPick1.OnMouseLeave*"></a>
|
|
|
|
<h3 id="Sample_Disp_DemoPick1_OnMouseLeave_Hi_Native_ui_event_type_Hi_Disp_DispEngine_" data-uid="Sample.Disp.DemoPick1.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 override 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="../api/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="../api/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>
|