SCR_PIPSightsComponent Class Reference

Inheritance diagram for SCR_PIPSightsComponent:

Protected Member Functions
ResourceName	GetLayoutResource ()
string	GetRTTextureWidgetName ()
string	GetRTargetWidgetName ()
int	GetCameraIndex ()
float	GetCameraFOV ()
float	GetNearPlane ()
float	GetFarPlane ()
float	GetResolutionScale ()
vector	GetCameraPoint ()
void	SetEnabled (bool enabled)
Widget	CreateUI (string layout, string rtTextureName, string rtName, out RTTextureWidget RTTexture, out RenderTargetWidget RTWidget)
void	DestroyUI (Widget root)
ScriptCamera	CreateCamera (IEntity parent, vector position, int cameraIndex, float fov, float nearPlane, float farPlane)
void	DestroyCamera (ScriptCamera camera)
void	Destroy ()
override void	OnSightADSActivated ()
override void	OnSightADSDeactivated ()
override void	OnInit (IEntity owner)
void	SCR_PIPSightsComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
	Constructor.
void	~SCR_PIPSightsComponent ()
	Destructor.

Protected Attributes
ref Widget	m_wRoot
	The root layout hierarchy widget.
IEntity	m_pOwner
	Parent entity owner.
RTTextureWidget	m_wRenderTargetTextureWidget
	The render target texture found within our layout.
RenderTargetWidget	m_wRenderTargetWidget
	The render target found within our layout.
ScriptCamera	m_PIPCamera
	The camera to be used by this pip component.
bool	m_bIsEnabled
	Is this PIP currently enabled?

Detailed Description

Definition at line 89 of file SCR_PIPSightsComponent.c.

Constructor & Destructor Documentation

SCR_PIPSightsComponent()

void SCR_PIPSightsComponent::SCR_PIPSightsComponent ( IEntityComponentSource src, IEntity ent, IEntity parent )

inlineprotected

Constructor.

Definition at line 364 of file SCR_PIPSightsComponent.c.

~SCR_PIPSightsComponent()

void SCR_PIPSightsComponent::~SCR_PIPSightsComponent ( )

inlineprotected

Destructor.

Definition at line 370 of file SCR_PIPSightsComponent.c.

Member Function Documentation

CreateCamera()

ScriptCamera SCR_PIPSightsComponent::CreateCamera ( IEntity parent, vector position, int cameraIndex, float fov, float nearPlane, float farPlane )

inlineprotected

Parameters

parent	Parent entity this camera should be attached to
position	Local offset from parent entity
cameraIndex	The index created camera should use, 0-31
fov	The field of view of camera 0-89
nearPlane	Near clipping plane of the camera in metres
farPlane	Far clipping plane of the camera in metres

Definition at line 283 of file SCR_PIPSightsComponent.c.

CreateUI()

Widget SCR_PIPSightsComponent::CreateUI ( string layout, string rtTextureName, string rtName, out RTTextureWidget RTTexture, out RenderTargetWidget RTWidget )

inlineprotected

Definition at line 242 of file SCR_PIPSightsComponent.c.

Destroy()

void SCR_PIPSightsComponent::Destroy ( )

inlineprotected

Definition at line 335 of file SCR_PIPSightsComponent.c.

DestroyCamera()

void SCR_PIPSightsComponent::DestroyCamera ( ScriptCamera camera )

inlineprotected

Definition at line 321 of file SCR_PIPSightsComponent.c.

DestroyUI()

void SCR_PIPSightsComponent::DestroyUI ( Widget root )

inlineprotected

Definition at line 268 of file SCR_PIPSightsComponent.c.

GetCameraFOV()

float SCR_PIPSightsComponent::GetCameraFOV ( )

inlineprotected

Definition at line 135 of file SCR_PIPSightsComponent.c.

GetCameraIndex()

int SCR_PIPSightsComponent::GetCameraIndex ( )

inlineprotected

Definition at line 129 of file SCR_PIPSightsComponent.c.

GetCameraPoint()

vector SCR_PIPSightsComponent::GetCameraPoint ( )

inlineprotected

Definition at line 159 of file SCR_PIPSightsComponent.c.

GetFarPlane()

float SCR_PIPSightsComponent::GetFarPlane ( )

inlineprotected

Definition at line 147 of file SCR_PIPSightsComponent.c.

GetLayoutResource()

ResourceName SCR_PIPSightsComponent::GetLayoutResource ( )

inlineprotected

Definition at line 111 of file SCR_PIPSightsComponent.c.

GetNearPlane()

float SCR_PIPSightsComponent::GetNearPlane ( )

inlineprotected

Definition at line 141 of file SCR_PIPSightsComponent.c.

GetResolutionScale()

float SCR_PIPSightsComponent::GetResolutionScale ( )

inlineprotected

Definition at line 153 of file SCR_PIPSightsComponent.c.

GetRTargetWidgetName()

string SCR_PIPSightsComponent::GetRTargetWidgetName ( )

inlineprotected

Definition at line 123 of file SCR_PIPSightsComponent.c.

GetRTTextureWidgetName()

string SCR_PIPSightsComponent::GetRTTextureWidgetName ( )

inlineprotected

Definition at line 117 of file SCR_PIPSightsComponent.c.

OnInit()

override void SCR_PIPSightsComponent::OnInit ( IEntity owner )

inlineprotected

Definition at line 357 of file SCR_PIPSightsComponent.c.

OnSightADSActivated()

override void SCR_PIPSightsComponent::OnSightADSActivated ( )

inlineprotected

Definition at line 343 of file SCR_PIPSightsComponent.c.

OnSightADSDeactivated()

override void SCR_PIPSightsComponent::OnSightADSDeactivated ( )

inlineprotected

Definition at line 350 of file SCR_PIPSightsComponent.c.

SetEnabled()

void SCR_PIPSightsComponent::SetEnabled ( bool enabled )

inlineprotected

Definition at line 189 of file SCR_PIPSightsComponent.c.

Member Data Documentation

m_bIsEnabled

bool SCR_PIPSightsComponent::m_bIsEnabled

protected

Is this PIP currently enabled?

Definition at line 107 of file SCR_PIPSightsComponent.c.

m_PIPCamera

ScriptCamera SCR_PIPSightsComponent::m_PIPCamera

protected

The camera to be used by this pip component.

Definition at line 104 of file SCR_PIPSightsComponent.c.

m_pOwner

IEntity SCR_PIPSightsComponent::m_pOwner

protected

Parent entity owner.

Definition at line 95 of file SCR_PIPSightsComponent.c.

m_wRenderTargetTextureWidget

RTTextureWidget SCR_PIPSightsComponent::m_wRenderTargetTextureWidget

protected

The render target texture found within our layout.

Definition at line 98 of file SCR_PIPSightsComponent.c.

m_wRenderTargetWidget

RenderTargetWidget SCR_PIPSightsComponent::m_wRenderTargetWidget

protected

The render target found within our layout.

Definition at line 101 of file SCR_PIPSightsComponent.c.

m_wRoot

ref Widget SCR_PIPSightsComponent::m_wRoot

protected

The root layout hierarchy widget.

Definition at line 92 of file SCR_PIPSightsComponent.c.

---

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

• scripts/Game/Weapon/Sights/SCR_PIPSightsComponent.c