ViewAdjustedStaticMeshGizmoComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Components/StaticMeshComponent.h"
#include "BaseGizmos/GizmoBaseComponent.h"
 
#include "ViewAdjustedStaticMeshGizmoComponent.generated.h"
 
#define UE_API INTERACTIVETOOLSFRAMEWORK_API
 
class UGizmoViewContext;
namespace UE::GizmoRenderingUtil
{
    class IViewBasedTransformAdjuster;
    class ISceneViewInterface;
}
 
UCLASS(MinimalAPI, Blueprintable, BlueprintType, ClassGroup = Gizmos, meta = (BlueprintSpawnableComponent))
class UViewAdjustedStaticMeshGizmoComponent : public UStaticMeshComponent
    , public IGizmoBaseComponentInterface
{
    GENERATED_BODY()
public:
    void SetGizmoViewContext(UGizmoViewContext* GizmoViewContextIn) { GizmoViewContext = GizmoViewContextIn; }
    
    UE_API void SetTransformAdjuster(TSharedPtr<UE::GizmoRenderingUtil::IViewBasedTransformAdjuster> Adjuster);
    TSharedPtr<UE::GizmoRenderingUtil::IViewBasedTransformAdjuster> GetTransformAdjuster() const { return TransformAdjuster; }
 
    UE_API void SetRenderVisibilityFunction(TFunction<bool(const UE::GizmoRenderingUtil::ISceneViewInterface& View, 
        const FTransform& ComponentToWorld)> RenderVisibilityFunc);
    TFunction<bool(const UE::GizmoRenderingUtil::ISceneViewInterface& View, 
        const FTransform& ComponentToWorld)> GetRenderVisibilityFunction() const { return RenderVisibilityFunc; }
    
    UE_API void SetAllMaterials(UMaterialInterface* Material);
 
    UE_API void SetHoverOverrideMaterial(UMaterialInterface* Material);
 
    UMaterialInterface* GetHoverOverrideMaterial() { return HoverOverrideMaterial; }
    bool IsBeingHovered() { return bHovered; }
 
    UE_API void SetSubstituteInteractionComponent(UPrimitiveComponent* Component, const FTransform& RelativeTransform = FTransform::Identity);
    
    bool IsHiddenByInteraction() { return bInteracted && SubstituteInteractionComponent; }
 
    // IGizmoBaseComponentInterface
    UE_API virtual void UpdateHoverState(bool bHoveringIn) override;
    UE_API virtual void UpdateWorldLocalState(bool bWorldIn) override;
    UE_API virtual void UpdateInteractingState(bool bInteracting) override;
 
    // UMeshComponent
    UE_DEPRECATED(5.7, "Please use GetMaterialRelevance with EShaderPlatform argument and not ERHIFeatureLevel::Type")
    UE_API virtual FMaterialRelevance GetMaterialRelevance(ERHIFeatureLevel::Type InFeatureLevel) const override;
    UE_API virtual FMaterialRelevance GetMaterialRelevance(EShaderPlatform InShaderPlatform) const override;
 
    // UPrimitiveComponent
    UE_API virtual bool LineTraceComponent(FHitResult& OutHit, const FVector Start, const FVector End, const FCollisionQueryParams& Params) override;
 
    // USceneComponent
    UE_API virtual FBoxSphereBounds CalcBounds(const FTransform& LocalToWorld) const override;
 
    // UActorComponent
    virtual bool IsHLODRelevant() const override { return false; }
 
    // UObject
    virtual bool NeedsLoadForServer() const override { return false; }
 
protected:
    // UStaticMeshComponent
    UE_API virtual FPrimitiveSceneProxy* CreateStaticMeshSceneProxy(Nanite::FMaterialAudit& NaniteMaterials, bool bCreateNanite) override;
 
private:
        
    // Needed for proper line traces
    UPROPERTY()
    TObjectPtr<UGizmoViewContext> GizmoViewContext = nullptr;
 
    UPROPERTY()
    TObjectPtr<UPrimitiveComponent> SubstituteInteractionComponent = nullptr;
 
    UPROPERTY()
    TObjectPtr<UMaterialInterface> HoverOverrideMaterial = nullptr;
 
    TSharedPtr<UE::GizmoRenderingUtil::IViewBasedTransformAdjuster> TransformAdjuster;
 
    bool bHovered = false;
    bool bInteracted = false;
 
    TFunction<bool(const UE::GizmoRenderingUtil::ISceneViewInterface& View, 
        const FTransform& ComponentToWorld)> RenderVisibilityFunc = nullptr;
};
 
#undef UE_API