ホーム › UI.Controls › EvaluateProximityToRect

EvaluateProximityToRect

関数

矩形に対するタッチ入力の近接度を評価する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

// USER32.dll
#include <windows.h>

BOOL EvaluateProximityToRect(
    const RECT* controlBoundingBox,
    const TOUCH_HIT_TESTING_INPUT* pHitTestingInput,
    TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* pProximityEval
);

パラメーター

名前	型	方向	説明
controlBoundingBox	RECT*	in	UI 要素の境界ボックスを定義する RECT 構造体です。
pHitTestingInput	TOUCH_HIT_TESTING_INPUT*	in	タッチ接触領域のデータを保持する TOUCH_HIT_TESTING_INPUT 構造体です。
pProximityEval	TOUCH_HIT_TESTING_PROXIMITY_EVALUATION*	out	スコアと調整後のタッチポイントのデータを保持する TOUCH_HIT_TESTING_PROXIMITY_EVALUATION 構造体です。

戻り値の型: BOOL

公式ドキュメント

タッチ接触領域と交差する他のすべての四角形と比較したうえで、ある四角形がタッチターゲットである確率のスコアと、その四角形内の調整後のタッチポイントを返します。

戻り値

この関数が成功した場合は TRUE を返します。

それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、GetLastError 関数を呼び出します。

解説(Remarks)

Windows との一貫性を保つため、WM_TOUCHHITTESTING を処理するフレームワークは、ターゲット判定に次の原則を使用する必要があります。

包含: タッチポイントがコントロールの境界内にある場合、そのタッチポイントは変更されません。
交差: 接触ジオメトリと交差するコントロールのみを対象に含めます。
Z オーダー: 複数のコントロールが接触ジオメトリと交差し、それらが重なり合っている場合は、Z オーダーが最も高いコントロールが優先されます。
あいまいさ: 複数のコントロールが接触ジオメトリと交差し、それらが重なり合っていない場合は、元のタッチポイントに最も近いコントロールが優先されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

BOOL EvaluateProximityToRect(
    const RECT* controlBoundingBox,
    const TOUCH_HIT_TESTING_INPUT* pHitTestingInput,
    TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* pProximityEval
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvaluateProximityToRect(
    IntPtr controlBoundingBox,   // RECT*
    IntPtr pHitTestingInput,   // TOUCH_HIT_TESTING_INPUT*
    IntPtr pProximityEval   // TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvaluateProximityToRect(
    controlBoundingBox As IntPtr,   ' RECT*
    pHitTestingInput As IntPtr,   ' TOUCH_HIT_TESTING_INPUT*
    pProximityEval As IntPtr   ' TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' controlBoundingBox : RECT*
' pHitTestingInput : TOUCH_HIT_TESTING_INPUT*
' pProximityEval : TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* out
Declare PtrSafe Function EvaluateProximityToRect Lib "user32" ( _
    ByVal controlBoundingBox As LongPtr, _
    ByVal pHitTestingInput As LongPtr, _
    ByVal pProximityEval As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvaluateProximityToRect = ctypes.windll.user32.EvaluateProximityToRect
EvaluateProximityToRect.restype = wintypes.BOOL
EvaluateProximityToRect.argtypes = [
    ctypes.c_void_p,  # controlBoundingBox : RECT*
    ctypes.c_void_p,  # pHitTestingInput : TOUCH_HIT_TESTING_INPUT*
    ctypes.c_void_p,  # pProximityEval : TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
EvaluateProximityToRect = Fiddle::Function.new(
  lib['EvaluateProximityToRect'],
  [
    Fiddle::TYPE_VOIDP,  # controlBoundingBox : RECT*
    Fiddle::TYPE_VOIDP,  # pHitTestingInput : TOUCH_HIT_TESTING_INPUT*
    Fiddle::TYPE_VOIDP,  # pProximityEval : TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn EvaluateProximityToRect(
        controlBoundingBox: *const RECT,  // RECT*
        pHitTestingInput: *const TOUCH_HIT_TESTING_INPUT,  // TOUCH_HIT_TESTING_INPUT*
        pProximityEval: *mut TOUCH_HIT_TESTING_PROXIMITY_EVALUATION  // TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool EvaluateProximityToRect(IntPtr controlBoundingBox, IntPtr pHitTestingInput, IntPtr pProximityEval);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EvaluateProximityToRect' -Namespace Win32 -PassThru
# $api::EvaluateProximityToRect(controlBoundingBox, pHitTestingInput, pProximityEval)

#uselib "USER32.dll"
#func global EvaluateProximityToRect "EvaluateProximityToRect" sptr, sptr, sptr
; EvaluateProximityToRect varptr(controlBoundingBox), varptr(pHitTestingInput), varptr(pProximityEval)   ; 戻り値は stat
; controlBoundingBox : RECT* -> "sptr"
; pHitTestingInput : TOUCH_HIT_TESTING_INPUT* -> "sptr"
; pProximityEval : TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global EvaluateProximityToRect "EvaluateProximityToRect" var, var, var
; res = EvaluateProximityToRect(controlBoundingBox, pHitTestingInput, pProximityEval)
; controlBoundingBox : RECT* -> "var"
; pHitTestingInput : TOUCH_HIT_TESTING_INPUT* -> "var"
; pProximityEval : TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global EvaluateProximityToRect "EvaluateProximityToRect" sptr, sptr, sptr
; res = EvaluateProximityToRect(varptr(controlBoundingBox), varptr(pHitTestingInput), varptr(pProximityEval))
; controlBoundingBox : RECT* -> "sptr"
; pHitTestingInput : TOUCH_HIT_TESTING_INPUT* -> "sptr"
; pProximityEval : TOUCH_HIT_TESTING_PROXIMITY_EVALUATION* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。