SGroomEditorViewport

Material Editor Preview viewport widget

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

HairStrandsEditor

Header

/Engine/Plugins/Runtime/HairStrands/Source/HairStrandsEditor/Public/Widgets/SGroomEditorViewport.h

Include

#include "Widgets/SGroomEditorViewport.h"

Syntax

class SGroomEditorViewport :
    public SEditorViewport,
    public FGCObject,
    public ICommonEditorViewportToolbarInfoProvider

Remarks

Material Editor Preview viewport widget

Destructors

Name Description

Public function

~SGroomEditorViewport()

Functions

Name Description

Public function Const

bool

 

CanCardsGuides()

Public function Const

bool

 

CanViewMode

(
    bool bGuideMode
)

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Public function Const

int32

 

GetLODModelCount()

Public function Const

int32

 

GetLODSelection()

Public function Const

bool

 

IsLODModelSelected

(
    int32 InLODSelection
)

Public function Const

bool

 

IsTogglePreviewGridChecked()

Event handlers

Public function

void

 

OnCardsGuides()

Public function

void

 

OnSetLODModel

(
    int32 InLODSelection
)

Public function

void

 

OnViewMode

(
    EHairStrandsDebugMode Mode
)

Public function

void

 

SetGroomComponent

(
    UGroomComponent* GroomComponen...
)

Set the component to preview.

Public function

void

 

SetSkeletalMeshComponent

(
    USkeletalMeshComponent* Skelet...
)

Set the mesh on which we are grooming

Public function

void

 

SetStaticMeshComponent

(
    UStaticMeshComponent* StaticGr...
)

Set the mesh on which we are grooming

Public function

void

 

TogglePreviewGrid()

Event handlers

Overridden from SEditorViewport

Name Description

Protected function Virtual

void

 

BindCommands()

Protected function Virtual

TSharedRef< ...

 

MakeEditorViewportClient()

SEditorViewport interface

Protected function Virtual

TSharedPtr< ...

 

MakeViewportToolbar()

Implement this to add a viewport toolbar to the inside top of the viewport.

Protected function Virtual

void

 

OnFocusViewportToSelection()

Called when the user wants to focus the viewport to the current selection

Protected function Virtual Const

EVisibility

 

OnGetViewportContentVisibility()

This is not the visibility of the scene rendered in the viewport

Protected function Virtual

void

 

PopulateViewportOverlays

(
    TSharedRef< class SOverlay > Overla...
)

Implement this to add an arbitrary set of toolbars or other overlays to the inside of the viewport.

Overridden from SWidget

Name Description

Public function Virtual

void

 

Tick

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

Ticks this widget with Geometry.

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Pure virtual that must be overloaded by the inheriting class.

Public function Virtual Const

FString

 

GetReferencerName()

Use this method to report a name for your referencer.

Overridden from ICommonEditorViewportToolbarInfoProvider

Name Description

Public function Virtual Const

TSharedPtr< ...

 

GetExtenders()

FLevelEditorModule& LevelEditorModule = FModuleManager::GetModuleChecked); TSharedPtr LevelEditorExtenders = LevelEditorModule.GetMenuExtensibilityManager()->GetAllExtenders();

Public function Virtual

TSharedRef< ...

 

GetViewportWidget()

Get the viewport widget.

Public function Virtual

void

 

OnFloatingButtonClicked()

Called to inform the host that a button was clicked (typically used to focus on a particular viewport in a multi-viewport setup)