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

> Unreal Engine API Reference > Editor > LandscapeEditor > FLandscapeTool

Light Theme

Dark Theme

FLandscapeTool

[FLandscapeTool](API\Editor\LandscapeEditor\FLandscapeTool)

Windows

MacOS

Linux

Inheritance Hierarchy

FGCObject

FLandscapeTool

References

Module	LandscapeEditor
Header	/Engine/Source/Editor/LandscapeEditor/Public/LandscapeToolInterface.h
Include	#include "LandscapeToolInterface.h"

Syntax

class FLandscapeTool : public FGCObject

Remarks

FLandscapeTool

Variables

		Name	Description
	int32	PreviousBrushIndex
	TArray< FName >	ValidBrushes

Constructors

	Name	Description
	FLandscapeTool()

Destructors

	Name	Description
	~FLandscapeTool()

Functions

	Name	Description
bool	BeginTool ( FEditorViewportClient* Viewpor..., const FLandscapeToolTarget& Target, const FVector& InHitLocation )
bool	CanToolBeActivated()
bool	DisallowMouseDeltaTracking()
void	EndTool ( FEditorViewportClient* Viewpor... )
void	EnterTool()
void	ExitTool()
EEditAction:...	GetActionEditCopy()
EEditAction:...	GetActionEditCut()
EEditAction:...	GetActionEditDelete()
EEditAction:...	GetActionEditDuplicate()
EEditAction:...	GetActionEditPaste()
bool	GetCursor ( EMouseCursor::Type& OutCursor )
FText	GetDisplayMessage()
FText	GetDisplayName()
bool	GetOverrideCursorVisibility ( bool& bWantsOverride, bool& bHardwareCursorVisible, bool bSoftwareCursorVisible )	Get override cursor visibility settings
ELandscapeTo...	GetSupportedTargetTypes()
const TCHAR ...	GetToolName()
ELandscapeTo...	GetToolType()
EAxisList::T...	GetWidgetAxisToDraw ( FWidget::EWidgetMode InWidgetMode )
FVector	GetWidgetLocation()
FMatrix	GetWidgetRotation()
bool	HandleClick ( HHitProxy* HitProxy, const FViewportClick& Click )
bool	InputDelta ( FEditorViewportClient* InViewp..., FViewport* InViewport, FVector& InDrag, FRotator& InRot, FVector& InScale )
bool	InputKey ( FEditorViewportClient* InViewp..., FViewport* InViewport, FKey InKey, EInputEvent InEvent )
bool	IsSelectionAllowed ( AActor* InActor, bool bInSelection )
bool	IsToolActive()
bool	MouseMove ( FEditorViewportClient* Viewpor..., FViewport* Viewport, int32 x, int32 y )
bool	OverrideSelection()
bool	OverrideWidgetLocation()
bool	OverrideWidgetRotation()
bool	PostConvertMouseMovement ( FEditorViewportClient* InViewp... )	Called after mouse movement is converted to drag/rot
bool	PreConvertMouseMovement ( FEditorViewportClient* InViewp... )	Called before mouse movement is converted to drag/rot
void	Process ( int32 Index, int32 Arg )	Functions which doesn't need Viewport data...
bool	ProcessEditCopy()
bool	ProcessEditCut()
bool	ProcessEditDelete()
bool	ProcessEditDuplicate()
bool	ProcessEditPaste()
void	Render ( const FSceneView* View, FViewport* Viewport, FPrimitiveDrawInterface* PDI )
void	SetCanToolBeActivated ( bool Value )
void	SetEditRenderType()
void	SetExternalModifierPressed ( const bool bPressed )
bool	SupportsComponentSelection()
bool	SupportsMask()
void	Tick ( FEditorViewportClient* Viewpor..., float DeltaTime )
bool	UsesTransformWidget()

Overridden from FGCObject

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

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

Take our survey

Dismiss