IClickDragBehaviorTarget Class Reference

#include <BehaviorTargetInterfaces.h>

Inheritance diagram for IClickDragBehaviorTarget:

Public Member Functions
virtual	~IClickDragBehaviorTarget ()
virtual FInputRayHit	CanBeginClickDragSequence (const FInputDeviceRay &PressPos)=0
virtual void	OnClickPress (const FInputDeviceRay &PressPos)=0
virtual void	OnClickDrag (const FInputDeviceRay &DragPos)=0
virtual void	OnClickRelease (const FInputDeviceRay &ReleasePos)=0
virtual void	OnTerminateDragSequence ()=0
Public Member Functions inherited from IModifierToggleBehaviorTarget
virtual	~IModifierToggleBehaviorTarget ()
virtual void	OnUpdateModifierState (int ModifierID, bool bIsOn)
virtual void	OnForceEndCapture ()

Detailed Description

Functions required to apply standard "Click-Drag" state machines to a target object. See UClickDragBehavior for an example of this kind of state machine.

Constructor & Destructor Documentation

~IClickDragBehaviorTarget()

virtual IClickDragBehaviorTarget::~IClickDragBehaviorTarget ( )

inlinevirtual

Member Function Documentation

CanBeginClickDragSequence()

virtual FInputRayHit IClickDragBehaviorTarget::CanBeginClickDragSequence ( const FInputDeviceRay &  PressPos )

pure virtual

Test if target can begin click-drag interaction at this point

Parameters

PressPos

device position/ray at click point

Returns

hit information at this point

Implemented in UFreeRotationSubGizmo, ULocalClickDragInputBehavior, UAxisAngleGizmo, UAxisPositionGizmo, UPlanePositionGizmo, UBaseBrushTool, UClickDragTool, and UMeshSurfacePointTool.

OnClickDrag()

virtual void IClickDragBehaviorTarget::OnClickDrag ( const FInputDeviceRay &  DragPos )

pure virtual

Notify Target that input position has changed

Parameters

DragPos

device position/ray at click point

Implemented in UFreePositionSubGizmo, UFreeRotationSubGizmo, ULocalClickDragInputBehavior, UAxisAngleGizmo, UAxisPositionGizmo, UPlanePositionGizmo, UClickDragTool, and UMeshSurfacePointTool.

OnClickPress()

virtual void IClickDragBehaviorTarget::OnClickPress ( const FInputDeviceRay &  PressPos )

pure virtual

Notify Target that click press ocurred

Parameters

PressPos

device position/ray at click point

Implemented in UFreeRotationSubGizmo, ULocalClickDragInputBehavior, UAxisAngleGizmo, UAxisPositionGizmo, UPlanePositionGizmo, UClickDragTool, and UMeshSurfacePointTool.

OnClickRelease()

virtual void IClickDragBehaviorTarget::OnClickRelease ( const FInputDeviceRay &  ReleasePos )

pure virtual

Notify Target that click release occurred

Parameters

ReleasePos

device position/ray at click point

Implemented in UFreeRotationSubGizmo, ULocalClickDragInputBehavior, UAxisAngleGizmo, UAxisPositionGizmo, UPlanePositionGizmo, UClickDragTool, and UMeshSurfacePointTool.

OnTerminateDragSequence()

virtual void IClickDragBehaviorTarget::OnTerminateDragSequence ( )

pure virtual

Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)

Implemented in UFreeRotationSubGizmo, ULocalClickDragInputBehavior, UAxisAngleGizmo, UAxisPositionGizmo, UPlanePositionGizmo, UClickDragTool, and UMeshSurfacePointTool.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseBehaviors/BehaviorTargetInterfaces.h