Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

SGroomEditorViewport

Material Editor Preview viewport widget

Windows

MacOS

Linux

Inheritance Hierarchy

SEditorViewport

FGCObject

ICommonEditorViewportToolbarInfoProvider

SGroomEditorViewport

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
	~SGroomEditorViewport()

Functions

	Name	Description
bool	CanCardsGuides()
bool	CanViewMode()
void	Construct ( const FArguments& InArgs )
int32	GetLODModelCount()
int32	GetLODSelection()
bool	IsLODModelSelected ( int32 InLODSelection )
bool	IsTogglePreviewGridChecked()	Event handlers
void	OnCardsGuides()
void	OnSetLODModel ( int32 InLODSelection )
void	OnViewMode ( EHairStrandsDebugMode Mode )
void	SetGroomComponent ( UGroomComponent* GroomComponen... )	Set the component to preview.
void	SetSkeletalMeshComponent ( USkeletalMeshComponent* Skelet... )	Set the mesh on which we are grooming
void	SetStaticMeshComponent ( UStaticMeshComponent* StaticGr... )	Set the mesh on which we are grooming
void	TogglePreviewGrid()	Event handlers

Overridden from SEditorViewport

	Name	Description
void	BindCommands()
TSharedRef< ...	MakeEditorViewportClient()	SEditorViewport interface
TSharedPtr< ...	MakeViewportToolbar()	Implement this to add a viewport toolbar to the inside top of the viewport.
void	OnFocusViewportToSelection()	Called when the user wants to focus the viewport to the current selection
EVisibility	OnGetViewportContentVisibility()	This is not the visibility of the scene rendered in the viewport
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
	void	Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )	Ticks this widget with Geometry.

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Pure virtual that must be overloaded by the inheriting class.

Overridden from ICommonEditorViewportToolbarInfoProvider

	Name	Description
TSharedPtr< ...	GetExtenders()	FLevelEditorModule& LevelEditorModule = FModuleManager::GetModuleChecked); TSharedPtr LevelEditorExtenders = LevelEditorModule.GetMenuExtensibilityManager()->GetAllExtenders();
TSharedRef< ...	GetViewportWidget()	Get the viewport widget.
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)

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

Take our survey

Dismiss