HitProxies.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    HitProxies.h: Hit proxy definitions.
=============================================================================*/
 
#pragma once
 
#include "UObject/ObjectMacros.h"
#include "Templates/RefCounting.h"
 
#include "HitProxies.generated.h"
 
class FReferenceCollector;
struct FTypedElementHandle;
 
namespace EMouseCursor { enum Type : int; }
 
UENUM()
enum EHitProxyPriority : int
{
    HPP_World = 0,
    HPP_Wireframe = 1,
    HPP_Foreground = 2,
    HPP_UI = 3
};
 
class HHitProxyType
{
public:
    HHitProxyType(HHitProxyType* InParent,const TCHAR* InName):
        Parent(InParent),
        Name(InName)
    {}
    HHitProxyType* GetParent() const { return Parent; }
    const TCHAR* GetName() const { return Name; }
private:
    HHitProxyType* Parent;
    const TCHAR* Name;
};
 
#if !UE_BUILD_DOCS
#define DECLARE_HIT_PROXY_STATIC( ... /* APIDecl */) \
    public: \
    /* NOTE: This static method must NOT be inlined as it will not work across DLL boundaries if so */ \
    static __VA_ARGS__ HHitProxyType* StaticGetType();
 
#define DECLARE_HIT_PROXY( ... /* APIDecl */) \
    DECLARE_HIT_PROXY_STATIC( __VA_ARGS__ ) \
    virtual HHitProxyType* GetType() const override \
    { \
        return StaticGetType(); \
    }
#endif
 
#define IMPLEMENT_HIT_PROXY_BASE(TypeName,ParentType) \
    HHitProxyType* TypeName::StaticGetType() \
    { \
        static HHitProxyType StaticType(ParentType,TEXT(#TypeName)); \
        return &StaticType; \
    }
 
#define IMPLEMENT_HIT_PROXY(TypeName,ParentTypeName) \
    IMPLEMENT_HIT_PROXY_BASE(TypeName,ParentTypeName::StaticGetType())
 
class FHitProxyId
{
    friend class HHitProxy;
public:
 
    ENGINE_API static const FHitProxyId InvisibleHitProxyId;
 
    FHitProxyId(): Index(INDEX_NONE) {}
 
    ENGINE_API FHitProxyId(FColor Color);
 
    ENGINE_API FColor GetColor() const;
 
    friend ENGINE_API class HHitProxy* GetHitProxyById(FHitProxyId Id);
 
    friend bool operator==(FHitProxyId X, FHitProxyId Y)
    {
        return X.Index == Y.Index;
    }
 
    friend bool operator!=(FHitProxyId X, FHitProxyId Y)
    {
        return X.Index != Y.Index;
    }
 
private:
    
    FHitProxyId(int32 InIndex): Index(InIndex) {}
 
    int32 Index;
};
 
class HHitProxy : public FRefCountedObject
{
    //DECLARE_HIT_PROXY( ENGINE_API )
    //We separate the GetType function implementation here because this is the base class/
    //The base class function should not have the override keyword here.
    DECLARE_HIT_PROXY_STATIC( ENGINE_API )
    virtual HHitProxyType* GetType() const
    {
        return StaticGetType();
    }
public:
 
    const EHitProxyPriority Priority;
 
    const EHitProxyPriority OrthoPriority;
 
    FHitProxyId Id;
 
    ENGINE_API HHitProxy(EHitProxyPriority InPriority = HPP_World);
    HHitProxy(EHitProxyPriority InPriority, EHitProxyPriority InOrthoPriority);
    ENGINE_API virtual ~HHitProxy();
    virtual void AddReferencedObjects( FReferenceCollector& Collector ) {}
 
    ENGINE_API bool IsA(HHitProxyType* TestType) const;
 
    ENGINE_API virtual EMouseCursor::Type GetMouseCursor();
 
    virtual bool AlwaysAllowsTranslucentPrimitives() const
    {
        return false;
    }
 
    ENGINE_API virtual FTypedElementHandle GetElementHandle() const;
 
private:
    void InitHitProxy();
};
 
// Dynamically cast a HHitProxy object type-safely.
template<typename DesiredType>
DesiredType* HitProxyCast(HHitProxy* Src)
{
    return ((Src != NULL) && (Src->IsA(DesiredType::StaticGetType()))) ? ((DesiredType*)Src) : NULL;
}
 
struct HObject : HHitProxy
{
    DECLARE_HIT_PROXY( ENGINE_API );
 
    UObject*    Object;
 
    HObject(UObject* InObject): HHitProxy(HPP_UI), Object(InObject) {}
    virtual void Serialize(FArchive& Ar)
    {
        Ar << Object;
    }
};
 
class FHitProxyConsumer
{
public:
 
    virtual void AddHitProxy(HHitProxy* HitProxy) = 0;
};