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 > Runtime > InteractiveToolsFramework > BaseTools > UMeshSurfacePointTool

Light Theme

Dark Theme

UMeshSurfacePointTool

[UMeshSurfacePointTool](API\Runtime\InteractiveToolsFramework\BaseTools\UMeshSurfacePointTool) is a base Tool implementation that can be used to implement various "point on surface" interactions.

Windows

MacOS

Linux

Inheritance Hierarchy

References

Module	InteractiveToolsFramework
Header	/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/BaseTools/MeshSurfacePointTool.h
Include	#include "BaseTools/MeshSurfacePointTool.h"

Syntax

class UMeshSurfacePointTool :
    public USingleSelectionTool,
    public IClickDragBehaviorTarget,
    public IHoverBehaviorTarget

Remarks

UMeshSurfacePointTool is a base Tool implementation that can be used to implement various "point on surface" interactions. The tool acts on an input IMeshDescriptionSource object, which the standard Builder can extract from the current selection (eg Editor selection).

Subclasses override the OnBeginDrag/OnUpdateDrag/OnEndDrag and OnUpdateHover functions to implement custom behavior.

Variables

	Name	Description
bool	bCtrlToggle	Current state of the ctrl modifier toggle
bool	bShiftToggle	Current state of the shift modifier toggle
FRay	LastWorldRay
IToolStylusStat...	StylusAPI

Functions

	Name	Description
bool	GetCtrlToggle()
float	GetCurrentDevicePressure()
bool	GetShiftToggle()
bool	HitTest ( const FRay& Ray, FHitResult& OutHit )
void	OnBeginDrag ( const FRay& Ray )	This function is called when the user begins a click-drag-release interaction
void	OnEndDrag ( const FRay& Ray )	This function is called when the user releases the button driving a click-drag-release interaction
void	OnUpdateDrag ( const FRay& Ray )	This function is called each frame that the user is in a click-drag-release interaction
void	SetCtrlToggle ( bool bCtrlDown )	Called by registered InputBehaviors to set the state of the "shift" button (or device equivalent)
void	SetShiftToggle ( bool bShiftDown )	Called by registered InputBehaviors to set the state of the "shift" button (or device equivalent)
void	SetStylusAPI ( IToolStylusStateProviderAPI* S... )	Set current stlyus API source

Overridden from UInteractiveTool

		Name	Description
	void	Setup()	Register InputBehaviors, etc

Overridden from IClickDragBehaviorTarget

	Name	Description
FInputRayHit	CanBeginClickDragSequence ( const FInputDeviceRay& PressPos )	IClickDragBehaviorTarget implementation.
void	OnClickDrag ( const FInputDeviceRay& DragPos )	Notify Target that input position has changed
void	OnClickPress ( const FInputDeviceRay& PressPos )	Notify Target that click press ocurred
void	OnClickRelease ( const FInputDeviceRay& ReleasePos )	Notify Target that click release occurred
void	OnTerminateDragSequence()	Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)

Overridden from IModifierToggleBehaviorTarget

		Name	Description
	void	OnUpdateModifierState ( int ModifierID, bool bIsOn )	Notify target of current modifier state

Overridden from IHoverBehaviorTarget

	Name	Description
FInputRayHit	BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos )	Do hover hit-test
void	OnBeginHover ( const FInputDeviceRay& DevicePos )	Initialize hover sequence at given position
void	OnEndHover()	Terminate active hover sequence
bool	OnUpdateHover ( const FInputDeviceRay& DevicePos )	Update active hover sequence with new input position

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

Take our survey

Dismiss