Onejsky4U/Plugins/Runtime/HoudiniEngine/Source/HoudiniEngineRuntime/Private/HoudiniHandleComponent.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:
*      Side Effects Software Inc
*      123 Front Street West, Suite 1401
*      Toronto, Ontario
*      Canada   M5J 2M2
*      416-504-9876
*
*/

#pragma once

#include "HoudiniGeoPartObject.h"
#include "HoudiniAssetParameterChoice.h"
#include "HoudiniAssetParameterFloat.h"

#include "Components/SceneComponent.h"

#include "HoudiniHandleComponent.generated.h"


UENUM()
enum class EHoudiniHandleType : uint8
{
    Xform,
    Bounder,
    Unsupported
};

UCLASS( config = Engine )
class HOUDINIENGINERUNTIME_API UHoudiniHandleComponent : public USceneComponent
{
    public:

        friend class UHoudiniAssetComponent;

#if WITH_EDITOR

        friend class FHoudiniHandleComponentVisualizer;

#endif // WITH_EDITOR

        GENERATED_UCLASS_BODY()

        virtual ~UHoudiniHandleComponent();

    /** UObject methods. **/
    public:

        virtual void Serialize( FArchive & Ar ) override;

#if WITH_EDITOR

        virtual void PostEditUndo() override;

#endif // WITH_EDITOR

    public:
        bool Construct(
            HAPI_NodeId AssetId, int32 HandleIdx, const FString & HandleName,
            const HAPI_HandleInfo &, const TMap< HAPI_ParmId, UHoudiniAssetParameter * > &, EHoudiniHandleType InHandleType);

        void ResolveDuplicatedParameters( const TMap< HAPI_ParmId, UHoudiniAssetParameter * > & );

        // Update HAPI transform handle parameters from the current ComponentToWorld Unreal transform
        void UpdateTransformParameters();

        static void AddReferencedObjects( UObject * InThis, FReferenceCollector & Collector );

    private:
        static HAPI_RSTOrder GetHapiRSTOrder( const TSharedPtr< FString > & );
        static HAPI_XYZOrder GetHapiXYZOrder( const TSharedPtr< FString > & );

        template < class ASSET_PARM >
        class THandleParameter
        {
            public:
                THandleParameter()
                    : AssetParameter( nullptr )
                    , TupleIdx( 0 )
                {}

                void AddReferencedObject( FReferenceCollector & Collector, const UObject * ReferencingObject )
                {
                    if ( AssetParameter )
                        Collector.AddReferencedObject( AssetParameter, ReferencingObject );
                }

                friend FArchive & operator<<( FArchive & Ar, THandleParameter & InThis )
                {
                    Ar << InThis.AssetParameter;
                    Ar << InThis.TupleIdx;

                    return Ar;
                }

                template < typename VALUE >
                bool Bind(
                    VALUE & OutValue,
                    const char * CmpName,
                    int32 InTupleIdx,
                    const FString & HandleParmName,
                    HAPI_ParmId AssetParamId,
                    const TMap< HAPI_ParmId, UHoudiniAssetParameter * > & Parameters )
                {
                    if (HandleParmName != CmpName)
                    {
                        return false;
                    }

                    UHoudiniAssetParameter * const * FoundAbstractParm = Parameters.Find(AssetParamId);
                    if (!FoundAbstractParm)
                    {
                        return false;
                    }

                    AssetParameter = Cast< ASSET_PARM >( *FoundAbstractParm );
                    if ( AssetParameter )
                    {
                        // It is possible that the handle param is bound to a single tuple param.
                        // Ignore the preset tuple index if that's the case or we'll crash.
                        if ((*FoundAbstractParm)->GetTupleSize() <= InTupleIdx)
                            InTupleIdx = 0;

                        auto Optional = AssetParameter->GetValue( InTupleIdx );
                        if ( Optional.IsSet() )
                        {
                            TupleIdx = InTupleIdx;
                            OutValue = static_cast< VALUE >( Optional.GetValue() );
                            return true;
                        }
                    }

                    return false;
                }

                void ResolveDuplicated( const TMap< HAPI_ParmId, UHoudiniAssetParameter * > & NewParameters )
                {
                    if ( AssetParameter )
                    {
                        if ( UHoudiniAssetParameter * const * FoundNewParameter = NewParameters.Find( AssetParameter->GetParmId() ) )
                            AssetParameter = Cast< ASSET_PARM >( *FoundNewParameter );
                        else
                            AssetParameter = nullptr;
                    }
                }

                template < typename VALUE >
                VALUE Get( VALUE DefaulValue ) const
                {
                    if ( AssetParameter )
                    {
                        auto Optional = AssetParameter->GetValue( TupleIdx );
                        if ( Optional.IsSet() )
                            return static_cast< VALUE >( Optional.GetValue() );
                    }

                    return DefaulValue;
                }

                template < typename VALUE >
                THandleParameter & operator=( VALUE Value )
                {
                    if ( AssetParameter )
                        AssetParameter->SetValue( Value, TupleIdx );

                    return *this;
                }

                ASSET_PARM * AssetParameter;
                int32 TupleIdx;
        };

        struct EXformParameter
        {
            enum Type
            {
                TX, TY, TZ,
                RX, RY, RZ,
                SX, SY, SZ,
                COUNT
            };
        };

        typedef THandleParameter< UHoudiniAssetParameterFloat > FXformParameter;
        FXformParameter XformParms[ EXformParameter::COUNT ];

        THandleParameter< UHoudiniAssetParameterChoice > RSTParm;
        THandleParameter< UHoudiniAssetParameterChoice > RotOrderParm;
        UPROPERTY()
        EHoudiniHandleType HandleType;
};