FGroomEditorMode

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

HairStrandsEditor

Header

/Engine/Plugins/Runtime/HairStrands/Source/HairStrandsEditor/Public/GroomEditorMode.h

Include

#include "GroomEditorMode.h"

Syntax

class FGroomEditorMode : public FEdMode

Variables

Name Description

Public variable

FOnModelingMode...

 

OnToolNotificationMessage

Public variable

FOnModelingMode...

 

OnToolWarningMessage

Protected variable

UEdModeInteract...

 

ToolsContext

Protected variable

TSharedPtr< FUI...

 

UICommandList

Command list lives here so that the key bindings on the commands can be processed in the viewport.

Public variable

UViewportWorldI...

 

ViewportWorldInteraction

Cached pointer to the viewport world interaction object we're using to interact with mesh elements

Constructors

Name Description

Public function

FGroomEditorMode()

Destructors

Name Description

Public function Virtual

~FGroomEditorMode()

Functions

Overridden from FEdMode

Name Description

Public function Virtual

void

 

ActorSelectionChangeNotify()

Public function Virtual

bool

 

AllowWidgetMove()

These disable the standard gizmo, which is probably want we want in these tools as we can't hit-test the standard gizmo...

Public function Virtual

bool

 

CapturedMouseMove

(
    FEditorViewportClient* InViewp...,
    FViewport* InViewport,
    int32 InMouseX,
    int32 InMouseY
)

Called during mouse-down mouse-move.

Public function Virtual

bool

 

EndTracking

(
    FEditorViewportClient* InViewp...,
    FViewport* InViewport
)

Always called on mouse-up

Public function Virtual

void

 

Enter()

Called when we "start" this editor mode (ie switch to this tab)

Public function Virtual

void

 

Exit()

Called when we "end" this editor mode (ie switch to another tab)

Public function Virtual

bool

 

InputAxis

(
    FEditorViewportClient* InViewp...,
    FViewport* Viewport,
    int32 ControllerId,
    FKey Key,
    float Delta,
    float DeltaTime
)

Called for 1D Axis movements - EKeys::MouseX, EKeys::MouseY, and EKeys::MouseWheelAxis Called even if we return true from InputKey which otherwise blocks tracking.

Public function Virtual

bool

 

InputKey

(
    FEditorViewportClient* Viewpor...,
    FViewport* Viewport,
    FKey Key,
    EInputEvent Event
)

Input Button/Axis Events & Mouse Capture

Public function Virtual

bool

 

LostFocus

(
    FEditorViewportClient* Viewpor...,
    FViewport* Viewport
)

Called when viewport window loses focus (ie when some other window is focused) not called when editor is backgrounded, but is called when editor is minimized

Public function Virtual

bool

 

MouseEnter

(
    FEditorViewportClient* Viewpor...,
    FViewport* Viewport,
    int32 x,
    int32 y
)

Called when mouse moves over viewport window

Public function Virtual

bool

 

MouseLeave

(
    FEditorViewportClient* Viewpor...,
    FViewport* Viewport
)

Called when mouse leaves viewport window

Public function Virtual

bool

 

MouseMove

(
    FEditorViewportClient* Viewpor...,
    FViewport* Viewport,
    int32 x,
    int32 y
)

Called on any mouse-move event. not called during tracking/capturing, eg if any button is down

Public function Virtual

bool

 

ProcessEditDelete()

Public function Virtual

bool

 

ReceivedFocus

(
    FEditorViewportClient* Viewpor...,
    FViewport* Viewport
)

Called when viewport window is focused

Public function Virtual

void

 

Render

(
    const FSceneView* View,
    FViewport* Viewport,
    FPrimitiveDrawInterface* PDI
)

Draws translucent polygons on brushes and volumes.

Public function Virtual Const

bool

 

ShouldDrawWidget()

Lets the mode determine if it wants to draw the widget or not.

Public function Virtual

bool

 

StartTracking

(
    FEditorViewportClient* InViewp...,
    FViewport* InViewport
)

Called on mouse-down.

Public function Virtual

void

 

Tick

(
    FEditorViewportClient* Viewpor...,
    float DeltaTime
)

Public function Virtual Const

bool

 

UsesToolkits()

True if this mode uses a toolkit mode (eventually they all should)

Public function Virtual Const

bool

 

UsesTransformWidget()

Lets each tool determine if it wants to use the editor widget or not.

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Pure virtual that must be overloaded by the inheriting class.

Typedefs

Constants

Name

Description

EM_GroomEditorModeId

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