ScreenSnapperクラス
内部クラスはAR.ObjectTrackable、AR.InstantTrackable、AR.ImageTrackableおよびAR.Positionableによって使用されます。このクラスを直接インスタンス化しないでください。
項目索引
プロパティ
プロパティ
snapToScreen.enabled
Boolean
trueに設定した場合、すべての拡張オブジェクトが、snapToScreen.snapContainer要素によって指定されたdivにレンダリングされます。このとき、Trackable2DObjectはonEnterFieldOfVision状態にある必要があります。そうでない場合、enabledをtrueに設定しても効果はありません。その代わりに、onEnterFieldOfVision状態にないときにenabledをfalseに設定することは有効です。したがって、Trackable2DObjectをカメラビューに固定表示できるのはターゲットが認識されているときだけですが、固定表示されているTrackable2DObjectはいつでも通常に戻すことができます。
デフォルト値: false
snapToScreen.enableDelayed
Number
onEnterFieldOfVisionトリガーが実行されてからアタッチされたDrawableがカメラビューに固定表示されるまでの遅延時間。負の値を設定すると固定表示が無効になります。遅延中にターゲットが失われると、onDelayedSnapInterruptionトリガーが実行されます。
デフォルト値: -1
snapToScreen.enableOnExitFieldOfVision
Boolean
trueに設定した場合、onExitFieldOfVisionトリガーが発生したときに、関連付けられた拡張オブジェクトがカメラビューに固定表示されます。このプロパティを使用すると、ターゲットがカメラビューから外れた場合にも拡張オブジェクトをカメラビューに固定表示できます。このような動作はenabledプロパティでは実現できません。固定表示を無効にするには、たとえば、onEnterFieldOfVisionトリガーなどの任意の時点でenabledプロパティをfalseに設定します。
デフォルト値: false
snapToScreen.snapContainer
DOM Element
固定表示が有効な場合にこのTrackable2DObjectに関連付けられたすべての拡張オブジェクトを収容するDOM要素。すべての拡張オブジェクトがこの要素に収まるように、拡張オブジェクトにスケーリングを適用しなければならない場合があります。また、DOM要素のアスペクト比も確認する必要があります。
デフォルト値: null
イベント
snapToScreen.onDelayedSnapInterruption
Function
onExitFieldOfVisionイベントによって画面の固定表示が遅延した場合に呼び出されるトリガー。
イベントペイロード:
-
interruptionTimestamp
NumberenabledDelayedプロパティによってアクティブ化されてからonExitFieldOfVisionイベントによって中断されるまでの経過時間(ミリ秒単位)。
snapToScreen.onSnappedToScreen
Function
拡張オブジェクトの固定表示時に呼び出されるトリガー。
イベントペイロード:
-
element
DOM Element拡張オブジェクトを固定表示する対象のDOM要素。