Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseTools
Inheritance Hierarchy
- UObject
- IInputBehaviorSource
- UInteractiveTool
- USingleSelectionTool
- UMeshSurfacePointTool
- UBaseBrushTool
- UDynamicMeshBrushTool
- UMeshAttributePaintTool
- UMeshSelectionTool
- UEditMeshMaterialsTool
- USeamSculptTool
- UShapeSprayTool
- USkinWeightsPaintTool
- UMeshTexturePaintingTool
- UMeshTextureAssetPaintingTool
- UMeshTextureColorPaintingTool
- UMeshVertexPaintingTool
- UMeshVertexColorPaintingTool
- UMeshVertexWeightPaintingTool
- UDeformMeshPolygonsTool
- UDynamicMeshSculptTool
- UEditUVIslandsTool
- UGroomCardsEditorTool
- UMeshSculptToolBase
- UDataflowEditorWeightMapPaintTool
- UMeshGroupPaintTool
- UMeshVertexPaintTool
- UMeshVertexSculptTool
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseTools/MeshSurfacePointTool.h |
| Include | #include "BaseTools/MeshSurfacePointTool.h" |
Syntax
UCLASS (MinimalAPI)
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
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bCtrlToggle | Current state of the ctrl modifier toggle |
 |
bool | bShiftToggle | Current state of the shift modifier toggle |
 |
FRay | LastWorldRay | |
 |
IToolStylusStateProviderAPI * | StylusAPI | |
  |
TWeakObjectPtr< UWorld > | TargetWorld |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
bool | ||
   |
float | ||
   |
bool | ||
 |
UWorld * | ||
  |
bool | HitTest
(
const FRay& Ray, |
|
  |
void | OnBeginDrag
(
const FRay& Ray |
This function is called when the user begins a click-drag-release interaction |
  |
void | OnCancelDrag () |
This function is called when the user's drag is cancelled, for example due to the whole tool being shut down. |
  |
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 "ctrl" 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* StylusAPI |
Set current stlyus API source |
 |
void | SetWorld
(
UWorld* World |
Overridden from UInteractiveTool
| Type | Name | Description | |
|---|---|---|---|
  |
void | Setup () |
Register InputBehaviors, etc |
Overridden from IInteractiveToolCameraFocusAPI
| Type | Name | Description | |
|---|---|---|---|
  |
bool | GetWorldSpaceFocusPoint
(
const FRay& WorldRay, |
IInteractiveToolCameraFocusAPI implementation. |
Overridden from IClickDragBehaviorTarget
| Type | 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 | Notify Target that click-drag sequence has been explicitly terminated (eg by escape key) |
Overridden from IModifierToggleBehaviorTarget
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnUpdateModifierState
(
int ModifierID, |
Notify target of current modifier state |
Overridden from IHoverBehaviorTarget
| Type | 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 |
Constants
| Name | Description |
|---|---|
| CtrlModifier | |
| ShiftModifier |