IClickSequenceBehaviorTarget Class Reference

#include <BehaviorTargetInterfaces.h>

Inheritance diagram for IClickSequenceBehaviorTarget:

Public Member Functions
virtual	~IClickSequenceBehaviorTarget ()
virtual void	OnBeginSequencePreview (const FInputDeviceRay &ClickPos)
virtual bool	CanBeginClickSequence (const FInputDeviceRay &ClickPos)=0
virtual void	OnBeginClickSequence (const FInputDeviceRay &ClickPos)=0
virtual void	OnNextSequencePreview (const FInputDeviceRay &ClickPos)
virtual bool	OnNextSequenceClick (const FInputDeviceRay &ClickPos)=0
virtual void	OnTerminateClickSequence ()=0
virtual bool	RequestAbortClickSequence ()
Public Member Functions inherited from IModifierToggleBehaviorTarget
virtual	~IModifierToggleBehaviorTarget ()
virtual void	OnUpdateModifierState (int ModifierID, bool bIsOn)
virtual void	OnForceEndCapture ()

Detailed Description

Target interface used by InputBehaviors that want to implement a multi-click sequence (eg such as drawing a polygon with multiple clicks)

Constructor & Destructor Documentation

~IClickSequenceBehaviorTarget()

virtual IClickSequenceBehaviorTarget::~IClickSequenceBehaviorTarget ( )

inlinevirtual

Member Function Documentation

CanBeginClickSequence()

virtual bool IClickSequenceBehaviorTarget::CanBeginClickSequence ( const FInputDeviceRay &  ClickPos )

pure virtual

Test if target would like to begin sequence based on this click. Gets checked both on mouse down and mouse up.

Parameters

ClickPos

device position/ray at click point

Returns

true if target wants to begin sequence

OnBeginClickSequence()

virtual void IClickSequenceBehaviorTarget::OnBeginClickSequence ( const FInputDeviceRay &  ClickPos )

pure virtual

Notify Target about the first click in the sequence.

Parameters

ClickPos

device position/ray at click point

OnBeginSequencePreview()

virtual void IClickSequenceBehaviorTarget::OnBeginSequencePreview ( const FInputDeviceRay &  ClickPos )

inlinevirtual

Notify Target device position has changed but a click sequence hasn't begun yet (eg for interactive previews)

Parameters

ClickPos

device position/ray at click point

OnNextSequenceClick()

virtual bool IClickSequenceBehaviorTarget::OnNextSequenceClick ( const FInputDeviceRay &  ClickPos )

pure virtual

Notify Target about next click in sqeuence

Parameters

ClickPos

device position/ray at click point

Returns

false if Target wants to terminate sequence

OnNextSequencePreview()

virtual void IClickSequenceBehaviorTarget::OnNextSequencePreview ( const FInputDeviceRay &  ClickPos )

inlinevirtual

Notify Target device position has changed but a click hasn't ocurred yet (eg for interactive previews)

Parameters

ClickPos

device position/ray at click point

OnTerminateClickSequence()

virtual void IClickSequenceBehaviorTarget::OnTerminateClickSequence ( )

pure virtual

Notify Target that click sequence has been explicitly terminated (eg by escape key, cancel tool, etc). Also called if sequence is terminated from querying target with RequestAbortClickSequence().

RequestAbortClickSequence()

virtual bool IClickSequenceBehaviorTarget::RequestAbortClickSequence ( )

inlinevirtual

Target overrides this and returns true if it wants to abort click sequence. Behavior checks every update and if this ever returns true, terminates sequence

---

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

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