ToolTarget.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/ContainerAllocationPolicies.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "HAL/PlatformCrt.h"
#include "Misc/AssertionMacros.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
 
#include "ToolTarget.generated.h"
 
class FToolTargetTypeRequirements;
class UClass;
 
UCLASS(Transient, Abstract, MinimalAPI)
class UToolTarget : public UObject
{
    GENERATED_BODY()
public:
 
    virtual bool IsValid() const PURE_VIRTUAL(UToolTarget::IsValid, return false;);
};
 
 
class FToolTargetTypeRequirements
{
public:
 
    TArray<const UClass*, TInlineAllocator<5>> Interfaces;
 
    FToolTargetTypeRequirements()
    {
    }
 
    explicit FToolTargetTypeRequirements(const UClass* Interface0)
    {
        Interfaces.Add(Interface0);
    }
 
    explicit FToolTargetTypeRequirements(const TArray<const UClass*>& InterfacesIn)
    {
        Interfaces = InterfacesIn;
    }
 
    FToolTargetTypeRequirements& Add(UClass* Interface)
    {
        Interfaces.Add(Interface);
        return *this;
    }
 
    INTERACTIVETOOLSFRAMEWORK_API bool AreSatisfiedBy(UClass* Class) const;
 
    INTERACTIVETOOLSFRAMEWORK_API bool AreSatisfiedBy(UToolTarget* ToolTarget) const;
};
 
 
UCLASS(Transient, Abstract, MinimalAPI)
class UToolTargetFactory : public UObject
{
    GENERATED_BODY()
 
public:
    virtual bool CanBuildTarget(UObject* SourceObject, const FToolTargetTypeRequirements& TargetTypeInfo) const PURE_VIRTUAL(UToolTargetFactory::CanBuildTarget, return false;);
    virtual UToolTarget* BuildTarget(UObject* SourceObject, const FToolTargetTypeRequirements& TargetTypeInfo) PURE_VIRTUAL(UToolTargetFactory::BuildTarget, return nullptr;);
 
 
    // The following methods are used when building from multiple input objects. If not overriden, they will
    //  call BuildTarget/CanBuildTarget on each object in sequence, but they can be overriden to create
    //  combined tool targets out of multiple inputs.
    
    INTERACTIVETOOLSFRAMEWORK_API virtual int32 CanBuildTargets(const TArray<UObject*>& InputObjects, const FToolTargetTypeRequirements& TargetTypeInfo, TArray<bool>& WouldBeUsedOut);
    
    INTERACTIVETOOLSFRAMEWORK_API virtual TArray<UToolTarget*> BuildTargets(const TArray<UObject*>& InputObjects, const FToolTargetTypeRequirements& TargetTypeInfo, TArray<bool>& WasUsedOut);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual UToolTarget* BuildFirstTarget(const TArray<UObject*>& InputObjects, const FToolTargetTypeRequirements& TargetTypeInfo, TArray<bool>& WasUsedOut);
};