FHitProxyId Class Reference

#include <HitProxies.h>

Public Member Functions
	FHitProxyId ()
ENGINE_API	FHitProxyId (FColor Color)
ENGINE_API FColor	GetColor () const

Static Public Attributes
static ENGINE_API const FHitProxyId	InvisibleHitProxyId

Friends
class	HHitProxy
ENGINE_API class HHitProxy *	GetHitProxyById (FHitProxyId Id)
bool	operator== (FHitProxyId X, FHitProxyId Y)
bool	operator!= (FHitProxyId X, FHitProxyId Y)

Detailed Description

Encapsulates a hit proxy ID.

Constructor & Destructor Documentation

FHitProxyId() [1/2]

FHitProxyId::FHitProxyId ( )

inline

Default constructor.

FHitProxyId() [2/2]

FHitProxyId::FHitProxyId

(

FColor

Color

)

Color conversion constructor.

Member Function Documentation

GetColor()

FColor FHitProxyId::GetColor

(

)

const

Maps the ID to a color which can be used to represent the ID.

Friends And Related Symbol Documentation

GetHitProxyById

ENGINE_API class HHitProxy * GetHitProxyById ( FHitProxyId  Id )

friend

Maps a hit proxy ID to its hit proxy. If the ID doesn't map to a valid hit proxy, NULL is returned.

Parameters

ID	- The hit proxy ID to match.

Returns

The hit proxy with matching ID, or NULL if no match.

HHitProxy

friend class HHitProxy

friend

operator!=

bool operator!= ( FHitProxyId  X, FHitProxyId  Y  )

friend

operator==

bool operator== ( FHitProxyId  X, FHitProxyId  Y  )

friend

Member Data Documentation

InvisibleHitProxyId

const FHitProxyId FHitProxyId::InvisibleHitProxyId

static

A special hit proxy ID that can be used to omit rendering a primitive to the hit proxy buffer entirely. This is useful when rendering translucent primitives that you never want to obscure selection of objects behind them

---

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