あなた自身でこのオブジェクトをインスタンス化しないでください。
hou.UIEvent.deviceを使用することで、hou.UIEventからUIEventDeviceオブジェクトを取得することができます。
詳細は、PythonステートUIイベントを参照してください。
メソッド ¶
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を返します。
isFunctionKey()
→ bool
ファンクションキーが押されていればTrueを返します。
isKeyPressed()
→ bool
何かのキーが押されていればTrueを返します。
isKeyDown()
→ bool
キーが押されたらTrueを返します。
このメソッドは、PythonステートのonKeyTransitEventメソッドを使ってキーが押されたことを検知するのに使用します。
isKeyUp()
→ bool
押したキーが離されるとTrueを返します。
このメソッドは、PythonステートのonKeyTransitEventメソッドをい使ってキーが離されたことを検知するのに使用します。
keyValue()
→ int
押されているキーのASCIIコードを返します。
shiftやctrlなどの修飾キーが押されていても、その修飾キーとの組み合わせで暗号化された値を返すhou.UIEvent.valueとは違って、このkeyValueは、そのキーのASCIIコードのみを返します。
keyString()
→ string
押されているキーの文字列表現を返します。
戻り値には、プラス文字と結合させた修飾キーの記号も含めることができます。
例:
押されているキー(s) |
戻り値 |
|---|---|
|
a |
|
Enter |
|
Tab |
|
Backspace |
|
Esc |
|
Ctrl+Space |
|
Shift+a |
|
Ctrl+Shift+a |
|
Alt+Ctrl+a |
modifierString()
→ string
押されている修飾キーの文字列表現を返します。
戻り値には、修飾キーの記号だけが含まれます。 押されたキーは、それ自体が修飾キーでない場合は無視されます。
例:
押されているキー(s) |
戻り値 |
|---|---|
|
shift |
|
Ctrl+Shift |
|
Alt+Shift |
マウス ¶
以下のメソッドは、マウスイベントが生成された時にそのマウスの状態を追跡します。
詳細は、onMouseEventメソッドを参照してください。
isLeftButton()
→ bool
左マウスボタンが押されていればTrueを返します。
isMiddleButton()
→ bool
中マウスボタンが押されていればTrueを返します。
isRightButton()
→ bool
右マウスボタンが押されていればTrueを返します。
isLeftButtonReleased()
→ bool
左マウスボタンが離されていればTrueを返します。
isMiddleButtonReleased()
→ bool
中マウスボタンが離されていればTrueを返します。
isRightButtonReleased()
→ bool
右マウスボタンが離されていればTrueを返します。
Note
このメソッドは、ボタンが離されていても、Pythonステートでカスタムメニューが定義されていればFalseを返します。
mouseX()
→ int
ビューの左端が0を示すスクリーン座標内の水平マウス位置を返します。
mouseY()
→ int
ビューの下端が0を示すスクリーン座標内の垂直マウス位置を返します。
マウスホイール ¶
マウスホイールメソッドは、マウスホイールイベントが生成された時に使用可能です。
詳細は、onMouseWheelEventメソッドを参照してください。
Note
現在のところ、このAPIは垂直軸以外のスクロール軸には対応していません。
mouseWheel()
→ int
マウルホイールを上にスクロールするとマイナスの値、下にスクロールするとプラスの値を返します。
マウスによっては出力が異なります:
-
“クリック型”のホイールが付いたマウスは、通常ではクリックの度に(少なく見積もっても)
-1または+1のイベントを出力します。 -
“自由に回転する”ホイールが付いたマウス、または、表面接触検知型のマウス(例えば、Apple Magic Mouse)は、もっと広い範囲の値を生成します。小さい/遅いスクロールでもマウスホイールイベントをトリガーすることができますが、このメソッドは
0を返します。反対に、大きい/速いスクロールはイベント毎に最大7程度までの大きな数値を生成することができます。ユーザがマウスホイールを速く回すと数値が大きくなり、遅く回すと小さくなります。
タブレット ¶
以下のメソッドは、タブレットイベントを追跡します。
Note
タブレットイベント固有のイベントハンドラーはなくて、代わりにonMouseEventが使用されます。
Warning
一部のタブレットハードウェアでは、以下のすべてのメソッドに対応していない場合があります。
isTablet()
→ bool
タブレットペンによってイベントが生成されていてもFalseを返します。 将来のバージョンでは、タブレットと非タブレットのイベントを区別することができる予定です。
tabletAngle()
→ double
タブレットペンの角度値を返します。
tabletPressure()
→ double
タブレットペンの圧力値を返します。
tabletRoll()
→ double
タブレットペンのロール値を返します。
tabletTilt()
→ double
タブレットペンの傾き値を返します。