Onejsky4U/Plugins/Runtime/HoudiniEngine/Source/HoudiniEngineEditor/Private/HoudiniSplineComponentVisualizer.h

/*
* Copyright (c) <2017> Side Effects Software Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Produced by:
*      Mykola Konyk
*      Side Effects Software Inc
*      123 Front Street West, Suite 1401
*      Toronto, Ontario
*      Canada   M5J 2M2
*      416-504-9876
*
*/

#pragma once

#include "HoudiniSplineComponent.h"
#include "Framework/Commands/Commands.h"
#include "ComponentVisualizer.h"
#include "Framework/Commands/UICommandList.h"

/** Base class for clickable spline editing proxies. **/
struct HHoudiniSplineVisProxy : public HComponentVisProxy
{
    DECLARE_HIT_PROXY();
    HHoudiniSplineVisProxy( const UActorComponent * InComponent );
};

/** Proxy for a spline control point. **/
struct HHoudiniSplineControlPointVisProxy : public HHoudiniSplineVisProxy
{
    DECLARE_HIT_PROXY();
    HHoudiniSplineControlPointVisProxy( const UActorComponent * InComponent, int32 InControlPointIndex );

    int32 ControlPointIndex;
};

/** Define commands for our component visualizer */
class FHoudiniSplineComponentVisualizerCommands : public TCommands< FHoudiniSplineComponentVisualizerCommands >
{
    public:

        /** Constructor. **/
        FHoudiniSplineComponentVisualizerCommands();

        /** Register commands. **/
        virtual void RegisterCommands() override;

    public:

        /** Command for adding a control point. **/
        TSharedPtr< FUICommandInfo > CommandAddControlPoint;

        /** Command for duplicating a control point. **/
        TSharedPtr< FUICommandInfo > CommandDuplicateControlPoint;

        /** Command for deleting a control point. **/
        TSharedPtr< FUICommandInfo > CommandDeleteControlPoint;
};

/** Our spline visualizer. **/
class FHoudiniSplineComponentVisualizer : public FComponentVisualizer
{
    public:

        FHoudiniSplineComponentVisualizer();
        virtual ~FHoudiniSplineComponentVisualizer();

    /** FComponentVisualizer methods. **/
    public:

        /** Registration of this component visualizer. **/
        virtual void OnRegister() override;

        /** Draw visualization for the given component. **/
        virtual void DrawVisualization(
            const UActorComponent * Component, const FSceneView * View,
            FPrimitiveDrawInterface * PDI ) override;

        /** Handle a click on a registered hit box. **/
        virtual bool VisProxyHandleClick(
            FEditorViewportClient* InViewportClient, HComponentVisProxy* VisProxy, const FViewportClick& Click ) override;

        /** Handle modifier key presses and depresses such as Alt for key duplication. **/
        virtual bool HandleInputKey(
            FEditorViewportClient * ViewportClient, FViewport * Viewport, FKey Key, EInputEvent Event ) override;

        /** Called when editing is no longer being performed. **/
        virtual void EndEditing() override;

        /** Returns location of a gizmo widget. **/
        virtual bool GetWidgetLocation(
            const FEditorViewportClient * ViewportClient, FVector & OutLocation ) const override;

        /** Returns Coordinate System of a gizmo widget. **/
        virtual bool GetCustomInputCoordinateSystem(
            const FEditorViewportClient* ViewportClient, FMatrix& OutMatrix) const override;

        /** Handle input change. **/
        virtual bool HandleInputDelta(
            FEditorViewportClient * ViewportClient, FViewport * Viewport, FVector & DeltaTranslate,
            FRotator & DeltaRotate, FVector & DeltaScale ) override;

        /** Create context menu for this visualizer. **/
        virtual TSharedPtr< SWidget > GenerateContextMenu() const override;

    protected:

        /** Update owner spline component and Houdini component it is attached to. **/
        void UpdateHoudiniComponents();

        /** Perform internal component update. **/
        void NotifyComponentModified( int32 PointIndex, const FTransform & Point );

        /** Callbacks for Add control point action. **/
        void OnAddControlPoint();
        bool IsAddControlPointValid() const;

        /** Callbacks for Delete control point action. **/
        void OnDeleteControlPoint();
        bool IsDeleteControlPointValid() const;

        /** Callbacks for Duplicate control point action. **/
        void OnDuplicateControlPoint();
        bool IsDuplicateControlPointValid() const;

        void DuplicateControlPoint();
        int32 AddControlPointAfter( const FTransform & NewPoint, const int32& nIndex );

        /** Store the current rotation to orient the rotation gizmo properly **/
        void CacheRotation();

    protected:

        /** Visualizer actions. **/
        TSharedPtr< FUICommandList > VisualizerActions;

        /** Houdini component which is being edited. **/
        UHoudiniSplineComponent * EditedHoudiniSplineComponent;

        /** Is set to true if we are editing corresponding curve. **/
        bool bCurveEditing;

        /** Whether we currently allow duplication when dragging. */
        bool bAllowDuplication;

        /** Keeps index of currently selected control points, if editing is being performed. **/
        TArray<int32> EditedControlPointsIndexes;

        /** Rotation used for the gizmo widgets **/
        FQuat CachedRotation;

        /** Indicates the current selection has been modified and the parent component must be updated **/
        bool bComponentNeedUpdate;

        /** Indicates if the curves should only cook on mouse release **/
        bool bCookOnlyOnMouseRelease;

        /** Indicates wether or not a transaction should be recorded when moving a point **/
        bool bRecordTransactionOnMove;
};