Class DemoPick1

Namespace

Sample.Disp

Assembly

Hi.Sample.Wpf.dll

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.

public class DemoPick1 : Pickable, IGetPickable, IDisposable, IDisplayee, IExpandToBox3d

Inheritance

object

Pickable

DemoPick1

Implements

IGetPickable

IDisposable

IDisplayee

IExpandToBox3d

Inherited Members

Pickable.Pickables

Pickable.mark

Pickable.PickingID

Pickable.GetPickable()

Pickable.OnKeyDown(key_event_t, DispEngine)

Pickable.OnKeyUp(key_event_t, DispEngine)

Pickable.OnMouseDown(mouse_button_event_t, DispEngine)

Pickable.OnMouseUp(mouse_button_event_t, DispEngine)

Pickable.OnMouseMove(mouse_move_event_t, DispEngine)

Pickable.OnMouseWheel(mouse_wheel_event_t, DispEngine)

Pickable.Dispose(bool)

Pickable.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Source Code

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());
        }
    }
}

Methods

Display(Bind)

Display function called in DispEngine rendering loop.

public void Display(Bind bind)

Parameters

bind Bind

Bind with DispEngine. See Bind.

ExpandToBox3d(Box3d)

Expands the destination box. This function is usually used to compute the bounding box of elements.

public void ExpandToBox3d(Box3d dst)

Parameters

dst Box3d

Destination box

OnMouseEnter(ui_event_type, DispEngine)

Behavior on mouse enter

public override void OnMouseEnter(ui_event_type e, DispEngine dispEngine)

Parameters

e ui_event_type

event type

dispEngine DispEngine

display engine

OnMouseLeave(ui_event_type, DispEngine)

Behavior on mouse leave

public override void OnMouseLeave(ui_event_type e, DispEngine dispEngine)

Parameters

e ui_event_type

event type

dispEngine DispEngine

display engine