1. Epic GamesDeveloper
  3. TToolCompatibleMixin

TToolCompatibleMixin

Mixin that handles complexity of tool support for you.

API > API/Editor > API/Editor/UnrealEd

Mixin that handles complexity of tool support for you. Calling base widget methods only when a tool does not handle them if appropriate.

Note: Widget must have overriden SWidget::OnPaint to be protected at a minimum to use. Also currently does not support touch or gamepad navigation.

@TODO: Does not currently allow for ArrangeChildren support this might be useful for rendering widgets on top of the tool supporting widget? A general overlay that accepts addtional widgets to render on top of the tool supporting widget might be interesting. For instance, an editable preview graph / editor of the selected widget might work this way (Such as for graph nodes).

   
Name TToolCompatibleMixin
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/Tools/ToolCompatible.h
Include Path #include "Tools/ToolCompatible.h"

Syntax

template<typename ToolCompatibleWidget>  
class TToolCompatibleMixin : public ToolCompatibleWidget

Inheritance Hierarchy

  • ToolCompatibleWidget → TToolCompatibleMixin

Constructors

Name Remarks Include Path Unreal Specifiers

TToolCompatibleMixin ( Args&&... args
)

 Forwarding constructor to ensure mixin members always initialized (Currently none) Tools/ToolCompatible.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual TOptional< EMouseCursor::Type > GetCursor()

   Tools/ToolCompatible.h  

TSharedPtr< IToolkit > GetParentToolkit()

 Use this if your widget is created after your editor's mode manager Tools/ToolCompatible.h  

FWidgetModeManager * GetWidgetModeManger()

 Helper method for accessing our toolkit's widget mode tool manager Tools/ToolCompatible.h  

virtual FReply OnDragDetected ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Tools/ToolCompatible.h  

virtual void OnFocusLost ( const FFocusEvent& InFocusEvent
)

   Tools/ToolCompatible.h  

virtual FReply OnFocusReceived ( const FGeometry& MyGeometry,
const FFocusEvent& InFocusEvent
)

   Tools/ToolCompatible.h  

virtual FReply OnKeyChar ( const FGeometry& MyGeometry,
const FCharacterEvent& InCharacterEvent
)

   Tools/ToolCompatible.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Tools/ToolCompatible.h  

virtual FReply OnKeyUp ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Tools/ToolCompatible.h  

virtual FReply OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

   Tools/ToolCompatible.h  

virtual FReply OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Tools/ToolCompatible.h  

virtual FReply OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Tools/ToolCompatible.h  

virtual void OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLostEvent
)

   Tools/ToolCompatible.h  

virtual void OnMouseEnter ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Tools/ToolCompatible.h  

virtual void OnMouseLeave ( const FPointerEvent& MouseEvent
)

   Tools/ToolCompatible.h  

virtual FReply OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Tools/ToolCompatible.h  

virtual FReply OnMouseWheel ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Tools/ToolCompatible.h  

virtual int32 OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
) const

   Tools/ToolCompatible.h  

void SetParentToolkit ( TSharedPtr< IToolkit > InParentToolkit
)

 Use this if your widget is created after your editor's mode manager Tools/ToolCompatible.h  

virtual void Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

   Tools/ToolCompatible.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page