IEntityRenderProxy

C++
struct IEntityRenderProxy : public IEntityProxy {
};
File

IEntityProxy.h

Description

Interface to the entity Render proxy.

IEntityRenderProxy::AddShaderParamCallback Method
C++
virtual void AddShaderParamCallback(IShaderParamCallbackPtr pCallback) = 0;
Description

Add a render proxy callback

IEntityRenderProxy::CheckShaderParamCallbacks Method
C++
virtual void CheckShaderParamCallbacks() = 0;
Description

Check which shader param callback should be activated or disactived depending on the current entity state

IEntityRenderProxy::ClearShaderParamCallbacks Method
C++
virtual void ClearShaderParamCallbacks() = 0;
Description

Clears all the shader param callback from this entity

IEntityRenderProxy::ClearSlots Method
C++
virtual void ClearSlots() = 0;
Description

Removes all slots from the render proxy

IEntityRenderProxy::DoesCloakFadeByDistance Method
C++
virtual bool DoesCloakFadeByDistance() const = 0;
IEntityRenderProxy::DoesIgnoreCloakRefractionColor Method
C++
virtual bool DoesIgnoreCloakRefractionColor() const = 0;
IEntityRenderProxy::GetCloakBlendTimeScale Method
C++
virtual float GetCloakBlendTimeScale() const = 0;
IEntityRenderProxy::GetCloakColorChannel Method
C++
virtual uint8 GetCloakColorChannel() const = 0;
IEntityRenderProxy::GetCloakInterferenceState Method
C++
virtual bool GetCloakInterferenceState() const = 0;
IEntityRenderProxy::GetEffectLayerParams Method
C++
virtual const uint32 GetEffectLayerParams() const = 0;
IEntityRenderProxy::GetHUDSilhouettesParams Method
C++
virtual uint32 GetHUDSilhouettesParams() const = 0;
IEntityRenderProxy::GetLastSeenTime Method
C++
virtual float GetLastSeenTime() const = 0;
Description

return the last time (as set by the system timer) when the renderproxy was last seen.

IEntityRenderProxy::GetLocalBounds Method
C++
virtual void GetLocalBounds(AABB & bounds) = 0;
Parameters
Parameters
Description
AABB & bounds
Returns Bounding box in local entity space.
Description

Get local space int the entity bounds of render proxy.

IEntityRenderProxy::GetMaterialLayersBlend Method
C++
virtual uint32 GetMaterialLayersBlend() const = 0;
IEntityRenderProxy::GetMaterialLayersMask Method
C++
virtual uint8 GetMaterialLayersMask() const = 0;
IEntityRenderProxy::GetOpacity Method
C++
virtual float GetOpacity() const = 0;
IEntityRenderProxy::GetRenderMaterial Method
C++
virtual IMaterial* GetRenderMaterial(int nSlot = -1) = 0;
Parameters
Parameters
Description
int nSlot = -1
Slot to query used material from, if -1 material will be taken from the first renderable slot.
Return
Material used for rendering, or NULL if slot is not rendered.
Description

Retrieve an actual material used for rendering specified slot. Will return custom applied material or if custom material not set will return an actual material assigned to the slot geometry.

IEntityRenderProxy::GetRenderNode Method
C++
virtual IRenderNode* GetRenderNode() = 0;
Description

Retrieve engine render node, used to render this entity.

IEntityRenderProxy::GetShaderPublicParams Method
C++
virtual IShaderPublicParams* GetShaderPublicParams(bool bCreate = true) = 0;
Parameters
Parameters
Description
bool bCreate = true
If Shader public params are not created for this entity, they will be created.
Description

Retrieve and optionally create a shaders public params for this render proxy.

IEntityRenderProxy::GetShadowDissolve Method
C++
virtual bool GetShadowDissolve() const = 0;
IEntityRenderProxy::GetSlotMaterial Method
C++
virtual IMaterial* GetSlotMaterial(int nSlot) = 0;
Parameters
Parameters
Description
int nSlot
Slot to query custom material from.
Return
Custom material applied on the slot.
Description

Retrieve slot's custom material (This material Must have been applied before with the SetSlotMaterial).

IEntityRenderProxy::GetSubObjHideMask Method
C++
virtual uint64 GetSubObjHideMask(int nSlot) const = 0;
IEntityRenderProxy::GetVisionParams Method
C++
virtual uint32 GetVisionParams() const = 0;
IEntityRenderProxy::GetWorldBounds Method
C++
virtual void GetWorldBounds(AABB & bounds) = 0;
Parameters
Parameters
Description
AABB & bounds
Returns Bounding box in world space.
Description

Get world bounds of render proxy.

IEntityRenderProxy::InvalidateLocalBounds Method
C++
virtual void InvalidateLocalBounds() = 0;
Description

Invalidates local or world space bounding box.

IEntityRenderProxy::IsRenderProxyVisAreaVisible Method
C++
virtual bool IsRenderProxyVisAreaVisible() const = 0;
Description

return true if entity visarea was visible during last frames

IEntityRenderProxy::RemoveShaderParamCallback Method
C++
virtual bool RemoveShaderParamCallback(IShaderParamCallbackPtr pCallback) = 0;
Description

Remove a render proxy callback

IEntityRenderProxy::SetAsPost3dRenderObject Method
C++
virtual void SetAsPost3dRenderObject(bool bPost3dRenderObject, uint8 groupId, float groupScreenRect[4]) = 0;
Description

sets object to be rendered in post 3d pass bPost3dRenderObject - flag object to render in post 3d render pass groupId - assign group ID's to groups of objects that render in the same screen rect groupScreenRect - screen rect that the grouped objects render in (0.0->1.0)

IEntityRenderProxy::SetCloakBlendTimeScale Method
C++
virtual void SetCloakBlendTimeScale(float fCloakBlendTimeScale) = 0;
Description

sets timescale for cloak blending (range 1 - 4)

IEntityRenderProxy::SetCloakColorChannel Method
C++
virtual void SetCloakColorChannel(uint8 nCloakColorChannel) = 0;
Description

set/get cloak color channel

IEntityRenderProxy::SetCloakFadeByDistance Method
C++
virtual void SetCloakFadeByDistance(bool bCloakFadeByDistance) = 0;
Description

set/get cloak fade by distance

IEntityRenderProxy::SetCloakHighlightStrength Method
C++
virtual void SetCloakHighlightStrength(float highlightStrength) = 0;
Description

set cloak highlight strength

IEntityRenderProxy::SetCloakInterferenceState Method
C++
virtual void SetCloakInterferenceState(bool bHasCloakInterference) = 0;
Description

set/get cloak interference state

IEntityRenderProxy::SetCustomPostEffect Method
C++
virtual void SetCustomPostEffect(const char* pPostEffectName) = 0;
Description

sets custom post effect

IEntityRenderProxy::SetEffectLayerParams Method (Vec4 &)
C++
virtual void SetEffectLayerParams(const Vec4 & pParams) = 0;
Description

set/get effect layer params (used for game related layer effects - eg: nanosuit effects)

IEntityRenderProxy::SetEffectLayerParams Method (uint32)
C++
virtual void SetEffectLayerParams(uint32 nEncodedParams) = 0;
IEntityRenderProxy::SetHUDDisableBloom Method
C++
virtual void SetHUDDisableBloom(const bool bDisableBloom) = 0;
Description

sets whether 3D HUD Object should have bloom disabled (Required to avoid overglow and cutoff with alien hud ghosted planes)

IEntityRenderProxy::SetHUDRequireDepthTest Method
C++
virtual void SetHUDRequireDepthTest(const bool bRequire) = 0;
Description

sets whether 3D HUD Objects require to be rendered at correct depth (i.e. behind weapon)

IEntityRenderProxy::SetHUDSilhouettesParams Method
C++
virtual void SetHUDSilhouettesParams(float r, float g, float b, float a) = 0;
Description

set/get hud silhouetes params

IEntityRenderProxy::SetIgnoreCloakRefractionColor Method
C++
virtual void SetIgnoreCloakRefractionColor(bool bIgnoreCloakRefractionColor) = 0;
Description

set/get ignore cloak refraction color

IEntityRenderProxy::SetIgnoreHeatAmount Method
C++
virtual void SetIgnoreHeatAmount(bool bIgnoreHeat) = 0;
Description

set render proxy to ignore heat value of object

IEntityRenderProxy::SetIgnoreHudInterferenceFilter Method
C++
virtual void SetIgnoreHudInterferenceFilter(const bool bIgnoreFiler) = 0;
Description

sets hud render proxy to ignore hud interference filter

IEntityRenderProxy::SetLocalBounds Method
C++
virtual void SetLocalBounds(const AABB & bounds, bool bDoNotRecalculate) = 0;
Parameters
Parameters
Description
const AABB & bounds
Bounding box in local space.
bool bDoNotRecalculate
when set to true entity will never try to recalculate local bounding box set by this call.
Description

Force local bounds.

IEntityRenderProxy::SetLodRatio Method
C++
virtual void SetLodRatio(int nLodRatio) = 0;
Description

Sets the LodRatio on the render node.

IEntityRenderProxy::SetMaterialLayersBlend Method
C++
virtual void SetMaterialLayersBlend(uint32 nMtlLayersBlend) = 0;
Description

overrides material layers blend amount

IEntityRenderProxy::SetMaterialLayersMask Method
C++
virtual void SetMaterialLayersMask(uint8 nMtlLayersMask) = 0;
Description

sets material layers masks

IEntityRenderProxy::SetMotionBlur Method
C++
virtual void SetMotionBlur(bool enable) = 0;
Description

Enables / Disables motion blur

IEntityRenderProxy::SetOpacity Method
C++
virtual void SetOpacity(float fAmount) = 0;
Description

set/get opacity

IEntityRenderProxy::SetShadowDissolve Method
C++
virtual void SetShadowDissolve(bool enable) = 0;
Description

set/get shadow dissolving (fade out for phantom perk etc)

IEntityRenderProxy::SetSlotMaterial Method
C++
virtual void SetSlotMaterial(int nSlot, IMaterial * pMaterial) = 0;
Parameters
Parameters
Description
int nSlot
Slot to apply material to.
Description

Assign custom material to the slot.

IEntityRenderProxy::SetSubObjHideMask Method
C++
virtual void SetSubObjHideMask(int nSlot, uint64 nSubObjHideMask) = 0;
Parameters
Parameters
Description
int nSlot
Slot to apply hide mask to.
Description

Assign sub-object hide mask to slot.

IEntityRenderProxy::SetViewDistRatio Method
C++
virtual void SetViewDistRatio(int nViewDistRatio) = 0;
Description

Set the viewDistRatio on the render node.

IEntityRenderProxy::SetVisionParams Method
C++
virtual void SetVisionParams(float r, float g, float b, float a) = 0;
Description

set/get vision params (thermal/sonar/etc)

IEntityRenderProxy::UpdateIndirLightForChildren Method
C++
virtual void UpdateIndirLightForChildren();
Description

updates indirect lighting for children