1. Epic GamesDeveloper
  3. TToolCompatibleMixin

TToolCompatibleMixin

Mixin that handles complexity of tool support for you.

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/Tools

Inheritance Hierarchy

  • ToolCompatibleWidget
  • TToolCompatibleMixin

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Public/Tools/ToolCompatible.h
Include #include "Tools/ToolCompatible.h"

Syntax

template<typename ToolCompatibleWidget>  
class TToolCompatibleMixin : public ToolCompatibleWidget

Remarks

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).

Variables

  Type Name Description
Protected variable TWeakPtr< IToolkit > ParentToolkit Toolkit containing this tool compatible widget.

Constructors

  Type Name Description
Public function  

TToolCompatibleMixin ( Args&&... args
)

 Forwarding constructor to ensure mixin members always initialized (Currently none)

Functions

  Type Name Description
Public function Virtual Const TOptional< EMouseCursor::Type >  
Public function TSharedPtr< IToolkit > Use this if your widget is created after your editor's mode manager
Public function Const FWidgetModeManager * Helper method for accessing our toolkit's widget mode tool manager
Public function Virtual FReply

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

  
Public function Virtual void

OnFocusLost ( const FFocusEvent& InFocusEvent
)

  
Public function Virtual FReply

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

  
Public function Virtual FReply

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

  
Public function Virtual FReply

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

  
Public function Virtual FReply

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

  
Public function Virtual FReply

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

  
Public function Virtual FReply

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

  
Public function Virtual FReply

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

  
Public function Virtual void

OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLostEvent
)

  
Public function Virtual void

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

  
Public function Virtual void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

  
Public function Virtual FReply

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

  
Public function Virtual FReply

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

  
Public function Virtual Const int32

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

  
Public function void

SetParentToolkit ( TSharedPtr< IToolkit > InParentToolkit
)

 Use this if your widget is created after your editor's mode manager
Public function Virtual void

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

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page