ICurveEditorToolExtension

You can extend the Curve Editor toolset by implementing this interface.

Choose your operating system:

Windows

macOS

Linux

References

Module

CurveEditor

Header

/Engine/Source/Editor/CurveEditor/Public/ICurveEditorToolExtension.h

Include

#include "ICurveEditorToolExtension.h"

Syntax

class ICurveEditorToolExtension

Remarks

You can extend the Curve Editor toolset by implementing this interface. The Curve Editor guarantees that only one tool will be active at any given time. A tool needs to specify if they handled certain mouse events so that these events can be bubbled to the rest of the Curve Editor to allow common functionality of selecting/deselecting keys, panning, etc.

Variables

Constructors

Name Description

Public function

ICurveEditorToolExtension()

Destructors

Name Description

Public function Virtual

~ICurveEditorToolExtension()

Functions

Name Description

Public function Virtual

void

 

BindCommands

(
    TSharedRef< FUICommandList > Comman...
)

Allows the tool to bind commands.

Public function Virtual Const

TSharedPtr< ...

 

GetToolOptions()

Public function Virtual

void

 

OnFocusLost

(
    const FFocusEvent& InFocusEvent
)

Public function Virtual

FReply

 

OnMouseButtonDoubleClick

(
    TSharedRef< SWidget > OwningWidget,
    const FGeometry& InMyGeometry,
    const FPointerEvent& InMouseEvent
)

Public function Virtual

FReply

 

OnMouseButtonDown

(
    TSharedRef< SWidget > OwningWidget,
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

Public function Virtual

FReply

 

OnMouseButtonUp

(
    TSharedRef< SWidget > OwningWidget,
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

Public function Virtual

FReply

 

OnMouseMove

(
    TSharedRef< SWidget > OwningWidget,
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

Public function Const

void

 

OnPaint

(
    const FPaintArgs& Args,
    const FGeometry& AllottedGeometry,
    const FSlateRect& MyCullingRect,
    FSlateWindowElementList& OutDrawEl...,
    int32 PaintOnLayerId,
    const FWidgetStyle& InWidgetStyle,
    bool bParentEnabled
)

Public function

void

 

OnToolActivated()

This is called when the tool is activated by switching from another tool.

Public function

void

 

OnToolDeactivated()

This is called when the tool is deactivated by switching to another tool.

Public function Virtual

void

 

OnToolOptionsUpdated

(
    const FPropertyChangedEvent& Prope...
)

Public function Virtual

void

 

SetToolID

(
    const FCurveEditorToolID InToolID
)

Allows the tool to add menu items to the toolbar in the Curve Editor.

Public function Virtual

void

 

Tick

(
    const FGeometry& AllottedGeometry,
    const double InCurrentTime,
    const float InDeltaTime
)