UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
HitProxies.h File Reference
#include "UObject/ObjectMacros.h"
#include "Templates/RefCounting.h"
#include "HitProxies.generated.h"

Go to the source code of this file.

Classes

class  HHitProxyType
 
class  FHitProxyId
 
class  HHitProxy
 
struct  HObject
 
class  FHitProxyConsumer
 

Namespaces

namespace  EMouseCursor
 

Macros

#define DECLARE_HIT_PROXY_STATIC(...)
 
#define DECLARE_HIT_PROXY(...)
 
#define IMPLEMENT_HIT_PROXY_BASE(TypeName, ParentType)
 
#define IMPLEMENT_HIT_PROXY(TypeName, ParentTypeName)    IMPLEMENT_HIT_PROXY_BASE(TypeName,ParentTypeName::StaticGetType())
 

Enumerations

enum  EHitProxyPriority : int { HPP_World = 0 , HPP_Wireframe = 1 , HPP_Foreground = 2 , HPP_UI = 3 }
 

Functions

template<typename DesiredType >
DesiredTypeHitProxyCast (HHitProxy *Src)
 

Macro Definition Documentation

◆ DECLARE_HIT_PROXY

#define DECLARE_HIT_PROXY (   ...)
Value:
virtual HHitProxyType* GetType() const override \
{ \
return StaticGetType(); \
}
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
#define DECLARE_HIT_PROXY_STATIC(...)
Definition HitProxies.h:56
Definition HitProxies.h:38

◆ DECLARE_HIT_PROXY_STATIC

#define DECLARE_HIT_PROXY_STATIC (   ...)
Value:
public: \
/* NOTE: This static method must NOT be inlined as it will not work across DLL boundaries if so */ \

A macro which creates a HHitProxyType for a HHitProxy-derived class. (Doxygen cannot match this, and a different version is given explicitly when building documentation).

◆ IMPLEMENT_HIT_PROXY

#define IMPLEMENT_HIT_PROXY (   TypeName,
  ParentTypeName 
)     IMPLEMENT_HIT_PROXY_BASE(TypeName,ParentTypeName::StaticGetType())

◆ IMPLEMENT_HIT_PROXY_BASE

#define IMPLEMENT_HIT_PROXY_BASE (   TypeName,
  ParentType 
)
Value:
HHitProxyType* TypeName::StaticGetType() \
{ \
static HHitProxyType StaticType(ParentType,TEXT(#TypeName)); \
return &StaticType; \
}
#define TEXT(x)
Definition Platform.h:1272

A macro which creates a HHitProxyType for a HHitProxy-derived class.

Enumeration Type Documentation

◆ EHitProxyPriority

The priority a hit proxy has when choosing between several hit proxies near the point the user clicked. HPP_World - this is the default priority HPP_Wireframe - the priority of items that are drawn in wireframe, such as volumes HPP_UI - the priority of the UI components such as the translation widget

Enumerator
HPP_World 
HPP_Wireframe 
HPP_Foreground 
HPP_UI 

Function Documentation

◆ HitProxyCast()

template<typename DesiredType >
DesiredType * HitProxyCast ( HHitProxy Src)