HHitProxy Class Reference

#include <HitProxies.h>

Inheritance diagram for HHitProxy:

Public Member Functions
ENGINE_API	HHitProxy (EHitProxyPriority InPriority=HPP_World)
	HHitProxy (EHitProxyPriority InPriority, EHitProxyPriority InOrthoPriority)
virtual ENGINE_API	~HHitProxy ()
virtual void	AddReferencedObjects (FReferenceCollector &Collector)
ENGINE_API bool	IsA (HHitProxyType *TestType) const
virtual ENGINE_API EMouseCursor::Type	GetMouseCursor ()
virtual bool	AlwaysAllowsTranslucentPrimitives () const
virtual ENGINE_API FTypedElementHandle	GetElementHandle () const
Public Member Functions inherited from FRefCountedObject
	FRefCountedObject ()
virtual	~FRefCountedObject ()
	FRefCountedObject (const FRefCountedObject &Rhs)=delete
FRefCountedObject &	operator= (const FRefCountedObject &Rhs)=delete
FReturnedRefCountValue	AddRef () const
uint32	Release () const
uint32	GetRefCount () const

Public Attributes
const EHitProxyPriority	Priority
const EHitProxyPriority	OrthoPriority
FHitProxyId	Id

Detailed Description

Base class for detecting user-interface hits.

Constructor & Destructor Documentation

HHitProxy() [1/2]

HHitProxy::HHitProxy

(

EHitProxyPriority

InPriority = HPP_World

)

HHitProxy() [2/2]

HHitProxy::HHitProxy	(	EHitProxyPriority	InPriority,
		EHitProxyPriority	InOrthoPriority
	)

~HHitProxy()

HHitProxy::~HHitProxy ( )

virtual

Member Function Documentation

AddReferencedObjects()

virtual void HHitProxy::AddReferencedObjects ( FReferenceCollector &  Collector )

inlinevirtual

Reimplemented in HInstancedStaticMeshInstance, HSkinnedMeshInstance, HActor, HBSPBrushVert, HStaticMeshVert, HModel, HLandscapeSplineProxy_Segment, HLandscapeSplineProxy_ControlPoint, and HLandscapeSplineProxy_Tangent.

AlwaysAllowsTranslucentPrimitives()

virtual bool HHitProxy::AlwaysAllowsTranslucentPrimitives ( ) const

inlinevirtual

Method that specifies whether the hit proxy always allows translucent primitives to be associated with it or not, regardless of any other engine/editor setting. For example, if translucent selection was disabled, any hit proxies returning true would still allow translucent selection.

Returns

true if translucent primitives are always allowed with this hit proxy; false otherwise

Reimplemented in HActor, and HTranslucentActor.

GetElementHandle()

FTypedElementHandle HHitProxy::GetElementHandle ( ) const

virtual

Get the element handle associated with this hit proxy, if any.

Reimplemented in HInstancedStaticMeshInstance, HSkinnedMeshInstance, and HActor.

GetMouseCursor()

EMouseCursor::Type HHitProxy::GetMouseCursor ( )

virtual

Override to change the mouse based on what it is hovering over.

Reimplemented in HInstancedStaticMeshInstance, HSkinnedMeshInstance, HActor, HTranslucentActor, HModel, HDataflowElementHitProxy, HLandscapeSplineProxy, HLandscapeSplineProxy_Tangent, HMovieSceneKeyProxy, and HMovieSceneSkeletalAnimationRootHitProxy.

IsA()

bool HHitProxy::IsA

(

HHitProxyType *

TestType

)

const

Determines whether the hit proxy is of the given type.

Member Data Documentation

Id

FHitProxyId HHitProxy::Id

The hit proxy's ID.

OrthoPriority

const EHitProxyPriority HHitProxy::OrthoPriority

Used in the ortho views, defaults to the same value as Priority

Priority

const EHitProxyPriority HHitProxy::Priority

The priority a hit proxy has when choosing between several hit proxies near the point the user clicked.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/HitProxies.h
• Engine/Source/Runtime/Engine/Private/HitProxies.cpp