IClickSequenceBehaviorTarget

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

Windows
MacOS
Linux

Inheritance Hierarchy

IModifierToggleBehaviorTarget

IClickSequenceBehaviorTarget

UDrawPolygonTool

References

Module

InteractiveToolsFramework

Header

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

Include

#include "BaseBehaviors/BehaviorTargetInterfaces.h"

Syntax

class IClickSequenceBehaviorTarget : public IModifierToggleBehaviorTarget

Remarks

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

Destructors

Functions

Name Description

Public function

bool

 

CanBeginClickSequence

(
    const FInputDeviceRay& ClickPos
)

Test if target would like to begin sequence based on this click.

Public function

void

 

OnBeginClickSequence

(
    const FInputDeviceRay& ClickPos
)

Notify Target about the first click in the sequence.

Public function Virtual

void

 

OnBeginSequencePreview

(
    const FInputDeviceRay& ClickPos
)

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

Public function

bool

 

OnNextSequenceClick

(
    const FInputDeviceRay& ClickPos
)

Notify Target about next click in sqeuence

Public function Virtual

void

 

OnNextSequencePreview

(
    const FInputDeviceRay& ClickPos
)

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

Public function

void

 

OnTerminateClickSequence()

Notify Target that click sequence has been explicitly terminated (eg by escape key, cancel tool, etc).

Public function Virtual

bool

 

RequestAbortClickSequence()

Target overrides this and returns true if it wants to abort click sequence.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss