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

SVisibilityWidget

Widget responsible for managing the visibility for a single item

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

SImage

SVisibilityWidget

References

Module	SceneOutliner
Header	/Engine/Source/Editor/SceneOutliner/Public/SceneOutlinerGutter.h
Include	#include "SceneOutlinerGutter.h"

Syntax

class SVisibilityWidget :
public SImage,
public SImage

Remarks

Widget responsible for managing the visibility for a single item

Variables

	Name	Description
const FSlateBru...	NotVisibleHoveredBrush
const FSlateBru...	NotVisibleNotHoveredBrush
const STableRow...	Row	Weak pointer back to the row
TUniquePtr< FSc...	UndoTransaction	Scoped undo transaction
const FSlateBru...	VisibleHoveredBrush	Visibility brushes for the various states
const FSlateBru...	VisibleNotHoveredBrush
TWeakPtr< FScen...	WeakColumn	Weak pointer back to the column
TWeakPtr< IScen...	WeakOutliner	Reference back to the outliner so we can set visibility of a whole selection
TWeakPtr< IScen...	WeakTreeItem	The tree item we relate to

Functions

	Name	Description
void	Construct ( const FArguments& InArgs, TWeakPtr< FSceneOutlinerGutter > In..., TWeakPtr< ISceneOutliner > InWeakOu..., TWeakPtr< ISceneOutlinerTreeItem > ..., const STableRow< FSceneOutlinerTree... )	Construct this widget
void	Construct ( const FArguments& InArgs, TWeakPtr< FPoseWatchManagerColumnVi..., TWeakPtr< IPoseWatchManager > InWea..., TWeakPtr< IPoseWatchManagerTreeItem..., const STableRow< FPoseWatchManagerT... )
const FSlate...	GetBrush()	Get the brush for this widget
FReply	HandleClick()
bool	IsEnabled()	Returns whether the widget is enabled or not
bool	IsVisible()	Check if our wrapped tree item is visible
bool	IsVisible ( const FSceneOutlinerTreeItemPtr& I..., const TSharedPtr< FSceneOutlinerGut... )	Check if the specified item is visible
void	OnSetItemVisibility ( ISceneOutlinerTreeItem& Item, const bool bNewVisibility )	Called when visibility change happens on an Item.
void	SetIsVisible ( const bool bVisible )	Set the item this widget is responsible for to be hidden or shown
bool	ShouldPropagateVisibilityChangeOnChildren()	Whether visibility change should propagate down to children.

Overridden from SWidget

	Name	Description
FSlateColor	GetForegroundColor()
FReply	OnDragDetected ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Start a new drag/drop operation for this widget
void	OnDragEnter ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... )	If a visibility drag drop operation has entered this widget, set its item to the new visibility state
FReply	OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent )	Called when a mouse button is double clicked. Override this in derived classes.
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Called when the mouse button is pressed down on this widget
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Process a mouse up message
void	OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLo... )	Called when this widget had captured the mouse, but that capture has been revoked for some reason.

Classes

	Name	Description
	FArguments