1. Epic GamesDeveloper
  3. FEditorViewportSelectability

FEditorViewportSelectability

Manages level actor viewport selectability and hovered visual states.

API > API/Editor > API/Editor/UnrealEd

References

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

Syntax

class FEditorViewportSelectability

Remarks

Manages level actor viewport selectability and hovered visual states. Contains static methods to enable outside modules to implement their own management.

Variables

  Type Name Description
Protected variable bool bSelectionLimited  
Protected variable TMap< TWeakObjectPtr< UPrimitiveComponent >, TOptional< FColor > > HoveredPrimitiveComponents Hovered primitives and their last overlay color before we apply the hover overlay
Protected variable TOptional< EMouseCursor::Type > MouseCursor Mouse cursor to display for the viewport when selection is limited.
Protected variable FOnGetWorld OnGetWorld  
Protected variable FOnIsObjectSelectableInViewport OnIsObjectSelectableInViewportDelegate Delegate used to check if an object is selectable in the viewport

Constructors

  Type Name Description
Public function    
Public function  

FEditorViewportSelectability ( const FOnGetWorld& InOnGetWorld,
const FOnIsObjectSelectableInViewport& InOnIsObjectSelectableInViewport
)

  

Functions

  Type Name Description
Public function bool

BoxSelectWorldActors ( FBox& InBox,
FEditorViewportClient*const InEditorViewportClient,
const bool bInSelect
)

 Selects or deselects all actors in a level world that are inside a defined box.
Public function void  
Protected function Static bool

DoesActorIntersectBox ( const AActor& InActor,
const FBox& InBox,
FEditorViewportClient*const InEditorViewportClient,
const bool bInUseStrictSelection
)

  
Protected function Static bool

DoesActorIntersectFrustum ( const AActor& InActor,
const FConvexVolume& InFrustum,
FEditorViewportClient*const InEditorViewportClient,
const bool bInUseStrictSelection
)

  
Public function Static void

DrawEnabledTextNotice ( FCanvas*const InCanvas,
const FText& InText
)

  
Public function void

EnableLimitedSelection ( const bool bInEnabled
)

 Enables or disables the selectability tool
Public function bool

FrustumSelectWorldActors ( const FConvexVolume& InFrustum,
FEditorViewportClient*const InEditorViewportClient,
const bool bInSelect
)

 Selects or deselects all actors in a level world that are inside a defined convex volume.
Public function Const bool  
Public function Static FText

GetLimitedSelectionText ( const TSharedPtr< FUICommandInfo >& InToggleAction,
const FText& InDefaultText
)

  
Public function bool

HandleClick ( FEditorViewportClient*const InViewportClient,
HHitProxy*const InHitProxy,
const FViewportClick& InClick
)

  
Protected function Static bool

IsActorInLevelHiddenLayer ( const AActor& InActor,
FLevelEditorViewportClient*const InLevelEditorViewportClient
)

  
Protected function Static bool

IsActorSelectableClass ( const AActor& InActor
)

  
Public function Const bool  
Public function Const bool  
Protected function Static bool

SelectActorsByPredicate ( UWorld*const InWorld,
const bool bInSelect,
const bool bInClearSelection,
const TFunctionRef< bool(AActor*)> InPredicate,
const TArray< AActor* >& InActors
)

 Selects or deselects actors in a world.
Protected function void

UpdateHoveredActorPrimitives ( AActor*const InActor
)

 Updates an actors hovered state and visuals.
Public function Static bool

UpdateHoveredActorPrimitives ( const bool bInSelectedLimited,
AActor*const InActor,
TMap< TWeakObjectPtr< UPrimitiveComponent >, TOptional< FColor > >& InOutHoveredPrimitiveComponents,
const TFunctionRef< bool(UObject*)>& InSelectablePredicate
)

 Updates an actors hovered state and visuals.
Public function Static bool

UpdateHoveredPrimitive ( const bool bInSelectedLimited,
UPrimitiveComponent*const InPrimitiveComponent,
TMap< TWeakObjectPtr< UPrimitiveComponent >, TOptional< FColor > >& InOutHoveredPrimitiveComponents,
const TFunctionRef< bool(UObject*)>& InSelectablePredicate
)

 Updates a list of hovered primitive component's hovered state and visuals
Public function void

UpdateHoverFromHitProxy ( HHitProxy*const InHitProxy
)

  
Public function Static void

UpdatePrimitiveVisuals ( const bool bInSelectedLimited,
UPrimitiveComponent*const InPrimitive,
const TOptional< FColor >& InColor
)

 Updates a single primitive component's hovered state and visuals.
Public function void

UpdateSelectionLimitedVisuals ( const bool bInClearHovered
)

 Updates hover visual states based on current selection limiting settings

Constants

Name Description
DefaultLimitedSelectionText Default text to display in the viewport when selection is limited as a helpful reminder to the user.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page