Brush.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "GameFramework/Actor.h"
#include "Brush.generated.h"
 
class UBrushBuilder;
class ULevel;
 
//-----------------------------------------------------------------------------
// Variables.
UENUM()
enum ECsgOper : int
{
    CSG_Active,
    CSG_Add,
    CSG_Subtract,
    CSG_Intersect,
    CSG_Deintersect,
    CSG_None,
    CSG_MAX,
};
 
 
UENUM()
enum EBrushType : int
{
    Brush_Default UMETA(Hidden),
    Brush_Add UMETA(DisplayName=Additive),
    Brush_Subtract UMETA(DisplayName=Subtractive),
    Brush_MAX,
};
 
 
// Selection information for geometry mode
USTRUCT()
struct FGeomSelection
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY()
    int32 Type;    // EGeometrySelectionType_
 
    UPROPERTY()
    int32 Index;    // Index into the geometry data structures
 
    UPROPERTY()
    int32 SelectionIndex;    // The selection index of this item
 
 
    FGeomSelection()
        : Type(0)
        , Index(0)
        , SelectionIndex(0)
    { }
 
    friend FArchive& operator<<(FArchive& Ar,FGeomSelection& MyGeomSelection)
    {
        return Ar << MyGeomSelection.Type << MyGeomSelection.Index << MyGeomSelection.SelectionIndex;
    }
};
 
 
UCLASS(hidecategories=(Object, Collision, Display, Rendering, Physics, Input, Blueprint), showcategories=("Input|MouseInput", "Input|TouchInput"), NotBlueprintable, ConversionRoot, MinimalAPI)
class ABrush
    : public AActor
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=Brush, meta = (NoResetToDefault))
    TEnumAsByte<enum EBrushType> BrushType;
 
    // Information.
    UPROPERTY()
    FColor BrushColor;
 
    UPROPERTY()
    int32 PolyFlags;
 
    UPROPERTY()
    uint32 bColored:1;
 
    UPROPERTY()
    uint32 bSolidWhenSelected:1;
 
    UPROPERTY()
    uint32 bPlaceableFromClassBrowser:1;
 
    UPROPERTY()
    uint32 bNotForClientOrServer:1;
 
    UPROPERTY(Instanced)
    TObjectPtr<class UModel> Brush;
 
private:
    UPROPERTY(Category = Collision, VisibleAnywhere, BlueprintReadOnly, meta = (AllowPrivateAccess = "true"))
    TObjectPtr<class UBrushComponent> BrushComponent;
public:
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(VisibleAnywhere, Instanced, Category=BrushBuilder)
    TObjectPtr<class UBrushBuilder> BrushBuilder;
    
    UPROPERTY(Transient, EditAnywhere, Category=BrushSettings)
    uint32 bDisplayShadedVolume:1;
 
    UPROPERTY(Transient, EditAnywhere, Category=BrushSettings, meta=(ClampMin=0.0, ClampMax=1.0))
    float ShadedVolumeOpacityValue = 0.25f;
#endif
 
    UPROPERTY()
    uint32 bInManipulation:1;
 
    UPROPERTY()
    TArray<struct FGeomSelection> SavedSelections;
    
#if WITH_EDITOR
    DECLARE_MULTICAST_DELEGATE_OneParam(FOnBrushRegistered, ABrush*);
    static FOnBrushRegistered& GetOnBrushRegisteredDelegate()
    {
        return OnBrushRegistered;
    }
#endif
 
public:
    
    // UObject interface.
#if WITH_EDITOR
    ENGINE_API virtual void PostLoad() override;
    ENGINE_API virtual void PostEditMove(bool bFinished) override;
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    ENGINE_API virtual void PostEditChangeChainProperty(FPropertyChangedChainEvent& PropertyChangedEvent) override;
    ENGINE_API virtual FName GetCustomIconName() const override;
    ENGINE_API virtual bool Modify(bool bAlwaysMarkDirty = true) override;
#endif // WITH_EDITOR
 
    virtual bool NeedsLoadForClient() const override
    { 
        return !IsNotForClientOrServer() && Super::NeedsLoadForClient(); 
    }
 
    virtual bool NeedsLoadForServer() const override
    { 
        return !IsNotForClientOrServer() && Super::NeedsLoadForServer(); 
    }
 
public:
    
    // AActor interface
    ENGINE_API virtual bool IsLevelBoundsRelevant() const override;
    ENGINE_API virtual bool IsComponentRelevantForNavigation(UActorComponent* Component) const override;
    ENGINE_API virtual void RebuildNavigationData();
 
#if WITH_EDITOR
    ENGINE_API virtual void Destroyed() override;
    ENGINE_API virtual void PostRegisterAllComponents() override;
    ENGINE_API virtual void CheckForErrors() override;
    ENGINE_API virtual void SetIsTemporarilyHiddenInEditor( bool bIsHidden ) override;
    ENGINE_API virtual bool SetIsHiddenEdLayer(bool bIsHiddenEdLayer) override;
    ENGINE_API virtual bool SupportsLayers() const override;
    ENGINE_API virtual bool SupportsExternalPackaging() const override;
    ENGINE_API virtual bool CanDeleteSelectedActor(FText& OutReason) const override;
    ENGINE_API virtual bool CanReplaceSelectedActor(FText& OutReason) const override;
    ENGINE_API virtual bool IsActorLabelEditable() const override;
public:
 
    ENGINE_API virtual void InitPosRotScale();
    ENGINE_API virtual void CopyPosRotScaleFrom( ABrush* Other );
 
    bool ENGINE_API CanEverAffectBSP() const;
 
    bool ENGINE_API ShouldExportStaticNavigableGeometry() const;
    
    static void SetSuppressBSPRegeneration(bool bSuppress) { bSuppressBSPRegeneration = bSuppress; }
    static bool GetSuppressBSPRegeneration() { return bSuppressBSPRegeneration; }
private:
 
    static ENGINE_API TArray< TWeakObjectPtr< ULevel > > LevelsToRebuild;
 
    static ENGINE_API FOnBrushRegistered OnBrushRegistered;
 
    static ENGINE_API bool bSuppressBSPRegeneration;
 
public:
 
    static ENGINE_API bool NeedsRebuild(TArray< TWeakObjectPtr< ULevel > >* OutLevels = nullptr);
 
    static void OnRebuildDone()
    {
        LevelsToRebuild.Empty();
    }
 
    static ENGINE_API void SetNeedRebuild(ULevel* InLevel);
#endif//WITH_EDITOR
 
    ENGINE_API virtual bool IsStaticBrush() const;
 
    virtual bool IsVolumeBrush() const { return false; }
    
    virtual bool IsBrushShape() const { return false; }
 
    // ABrush interface.
 
    ENGINE_API virtual FColor GetWireColor() const;
 
    inline bool IsNotForClientOrServer() const
    {
        return bNotForClientOrServer;
    }
 
    inline void SetNotForClientOrServer()
    {
        bNotForClientOrServer = true;
    }
 
    inline void ClearNotForClientOrServer()
    {
        bNotForClientOrServer = false;
    }
 
#if WITH_EDITORONLY_DATA
    const UBrushBuilder* GetBrushBuilder() const { return BrushBuilder; }
#endif
 
public:
    class UBrushComponent* GetBrushComponent() const { return BrushComponent; }
 
#if WITH_EDITOR
    static ENGINE_API const TCHAR* GGeometryRebuildCause;
#endif
};