MeshSurfacePointTool.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "SingleSelectionTool.h"
#include "InteractiveToolBuilder.h"
#include "InputBehaviorSet.h"
#include "BaseBehaviors/BehaviorTargetInterfaces.h"
#include "BaseBehaviors/AnyButtonInputBehavior.h"
#include "MeshSurfacePointTool.generated.h"
 
 
 
class UMeshSurfacePointTool;
 
// This is a temporary interface to provide stylus pressure, currently necessary due to limitations
// in the stylus plugin architecture. Should be removed once InputState/InputBehavior can support stylus events
class IToolStylusStateProviderAPI
{
public:
    virtual float GetCurrentPressure() const = 0;
};
 
UCLASS(MinimalAPI)
class UMeshSurfacePointToolBuilder : public UInteractiveToolWithToolTargetsBuilder
{
    GENERATED_BODY()
 
public:
    IToolStylusStateProviderAPI* StylusAPI = nullptr;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual bool CanBuildTool(const FToolBuilderState& SceneState) const override;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual UInteractiveTool* BuildTool(const FToolBuilderState& SceneState) const override;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual UMeshSurfacePointTool* CreateNewTool(const FToolBuilderState& SceneState) const;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void InitializeNewTool(UMeshSurfacePointTool* Tool, const FToolBuilderState& SceneState) const;
 
protected:
    INTERACTIVETOOLSFRAMEWORK_API virtual const FToolTargetTypeRequirements& GetTargetRequirements() const override;
};
 
 
 
UCLASS(MinimalAPI)
class UMeshSurfacePointTool : public USingleSelectionTool, public IClickDragBehaviorTarget, public IHoverBehaviorTarget
{
    GENERATED_BODY()
 
public:
    // UInteractiveTool API Implementation
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Setup() override;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void SetStylusAPI(IToolStylusStateProviderAPI* StylusAPI);
 
    // UMeshSurfacePointTool API
 
    INTERACTIVETOOLSFRAMEWORK_API virtual bool HitTest(const FRay& Ray, FHitResult& OutHit);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnBeginDrag(const FRay& Ray);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnUpdateDrag(const FRay& Ray);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnEndDrag(const FRay& Ray);
 
    virtual void OnCancelDrag() {}
    
 
    // IClickDragBehaviorTarget implementation
    INTERACTIVETOOLSFRAMEWORK_API virtual FInputRayHit CanBeginClickDragSequence(const FInputDeviceRay& PressPos) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnClickPress(const FInputDeviceRay& PressPos) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnClickDrag(const FInputDeviceRay& DragPos) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnClickRelease(const FInputDeviceRay& ReleasePos) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnTerminateDragSequence() override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void OnUpdateModifierState(int ModifierID, bool bIsOn) override;
 
 
    // IHoverBehaviorTarget implementation
    
    INTERACTIVETOOLSFRAMEWORK_API virtual FInputRayHit BeginHoverSequenceHitTest(const FInputDeviceRay& PressPos) override;
    virtual void OnBeginHover(const FInputDeviceRay& DevicePos) override {}
    virtual bool OnUpdateHover(const FInputDeviceRay& DevicePos) override { return true; }
    virtual void OnEndHover() override {}
 
 
    // IInteractiveToolCameraFocusAPI implementation
    INTERACTIVETOOLSFRAMEWORK_API virtual bool GetWorldSpaceFocusPoint(const FRay& WorldRay, FVector& PointOut) override;
 
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void SetShiftToggle(bool bShiftDown);
 
    virtual bool GetShiftToggle() const { return bShiftToggle; }
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void SetCtrlToggle(bool bCtrlDown);
 
    virtual bool GetCtrlToggle() const { return bCtrlToggle; }
 
    INTERACTIVETOOLSFRAMEWORK_API virtual float GetCurrentDevicePressure() const;
 
    INTERACTIVETOOLSFRAMEWORK_API void SetWorld(UWorld* World);
    INTERACTIVETOOLSFRAMEWORK_API UWorld* GetTargetWorld();
 
protected:
    bool bShiftToggle = false;
 
    bool bCtrlToggle = false;
 
    FRay LastWorldRay;
 
    IToolStylusStateProviderAPI* StylusAPI = nullptr;
 
    UPROPERTY()
    TWeakObjectPtr<UWorld> TargetWorld = nullptr;
 
    static constexpr int ShiftModifier = 1;
    static constexpr int CtrlModifier = 2;
};