あなた自身でこのオブジェクトをインスタンス化しないでください。
hou.UIEvent.device()を使用することで、hou.UIEventからUIEventDevice
オブジェクトを取得することができます。
詳細は、Pythonステートを参照してください。
メソッド
time()
: → double
イベントに関連した秒数を返します。
キーボード
isAltKey()
→ bool
Alt/Optionキーが押されていればTrueを返します。
isAutoRepeat()
→ bool
オートリピート(キー長押しによる連続入力)が有効であればTrueを返します。
isCapsLock()
→ bool
Caps Lockキーが押されていればTrueを返します。
isCtrlKey()
→ bool
Controlキーが押されていればTrueを返します。
isKeyPad()
→ bool
数値パッド上のキーが押されていればTrueを返します。
isShiftKey()
→ bool
Shiftキーが押されていればTrueを返します。
isArrowDown()
→ bool
下矢印キーが押されていればTrueを返します。
isArrowLeft()
→ bool
左矢印キーが押されていればTrueを返します。
isArrowRight()
→ bool
右矢印キーが押されていればTrueを返します。
isArrowUp()
→ bool
上矢印キーが押されていればTrueを返します。
isKeyPressed()
→ bool
何かのキーが押されていればTrueを返します。
keyValue()
→ int
押されているキーのASCIIコードを返します。
shift
やctrl
などの修飾キーが押されていても、その修飾キーとの組み合わせで暗号化された値を返すhou.UIEvent.value()とは違って、このkeyValue
は、そのキーのASCIIコードのみを返します。
keyString()
→ string
押されているキーの文字列
表現を返します。
戻り値には、スペース区切りで修飾キーの記号も含めることができます。
例:
押されているキー(s) |
戻り値 |
---|---|
|
a |
|
CR |
|
TAB |
|
BS |
|
ESC |
|
ctrl SP |
|
shift a |
|
ctrl shift a |
|
alt ctrl a |
modifierString()
→ string
押されている修飾キーの文字列
表現を返します。
戻り値には、修飾キーの記号だけが含まれ、押されているキーは無視されます。
例:
押されているキー(s) |
戻り値 |
---|---|
|
shift |
|
ctrl shift |
|
alt shift |
マウス
isLeftButton()
→ bool
左マウスボタンが押されていればTrueを返します。
isMiddleButton()
→ bool
中マウスボタンが押されていればTrueを返します。
isRightButton()
→ bool
右マウスボタンが押されていればTrueを返します。
mouseX()
→ int
ビューの左端が0を示すスクリーン座標内の水平マウス位置を返します。
mouseY()
→ int
ビューの下端が0を示すスクリーン座標内の垂直マウス位置を返します。
マウスホイール
Note
現在のところ、このAPIは垂直軸以外のスクロール軸には対応していません。
mouseWheel()
→ int
マウルホイールを上にスクロールするとマイナスの値、下にスクロールするとプラスの値を返します。
マウスによっては出力が異なります:
-
"クリック型"のホイールが付いたマウスは、通常ではクリックの度に(少なく見積もっても)
-1
または+1
のイベントを出力します。 -
"自由に回転する"ホイールが付いたマウス、または、表面接触検知型のマウス(例えば、Apple Magic Mouse)は、もっと広い範囲の値を生成します。小さい/遅いスクロールでもマウスホイールイベントをトリガーすることができますが、このメソッドは
0
を返します。反対に、大きい/速いスクロールはイベント毎に最大7
程度までの大きな数値を生成することができます。ユーザーがマウスホイールを速く回すと数値が大きくなり、遅く回すと小さくなります。
タブレット
一部のタブレットハードウェアでは、以下のデータすべてに対応していないことがあります。
isTablet()
→ bool
タブレットペンによってイベントが生成されたらTrueを返します。
tabletAngle()
→ double
タブレットペンの角度値を返します。
tabletPressure()
→ double
タブレットペンの圧力値を返します。
tabletRoll()
→ double
タブレットペンのロール値を返します。
tabletTilt()
→ double
タブレットペンの傾き値を返します。