SCR_MapDescriptorManualCameraComponent Interface Reference

Inheritance diagram for SCR_MapDescriptorManualCameraComponent:

Public Member Functions
void	TraceScreenPos (float width, float height, out vector dir, out float traceCoef)
override void	EOnCameraFrame (SCR_ManualCameraParam param)
	Evaluate the component every frame.
override bool	EOnCameraInit ()
	Initialise the component.
override void	EOnCameraExit ()
	Terminate the component.
Public Member Functions inherited from SCR_BaseManualCameraComponent
void	SetEnabled (bool enabled)
	Enable the component.
int	IsEnabled ()
	Check if the component is enabled.
int	GetPriority ()
	Get evaluation priority.
bool	HasFlag (EManualCameraFlag flag)
	Check if the required flag is active.
bool	InitBase (SCR_ManualCamera camera)
void	EOnCameraReset ()
	Camera value are reset.
void	EOnCameraParentChange (bool attached, IEntity parent)
	Terminate the component.
void	EOnCameraSave (SCR_ManualCameraComponentSave data)
	Save persistent data.
void	EOnCameraLoad (SCR_ManualCameraComponentSave data)
	Load persistent data.

Protected Attributes
EMapDescriptorType	m_iBaseType
string	m_sImageDef
ref Color	m_IconColor
ref Color	m_ViewConeColor
float	m_fIconScale
float	m_fMaxViewConeLength
string	m_sMapCanvasWidgetName
SCR_MapEntity	m_MapEntity
ref MapItem	m_MapItem
CanvasWidget	m_MapCanvas
ref PolygonDrawCommand	m_DrawLine = new PolygonDrawCommand()
ref array< ref CanvasWidgetCommand >	m_MapDrawCommands = { m_DrawLine }
WorkspaceWidget	m_Workspace
BaseWorld	m_World
ref TraceParam	m_Trace = new TraceParam()
Protected Attributes inherited from SCR_BaseManualCameraComponent
int	m_iPriority
SCR_ManualCamera	m_Camera
InputManager	m_InputManager

Additional Inherited Members
Protected Member Functions inherited from SCR_BaseManualCameraComponent
SCR_ManualCamera	GetCameraEntity ()
InputManager	GetInputManager ()
vector	CoordToCamera (vector pos)
vector	CoordFromCamera (vector pos)

Detailed Description

Camera representation in the map

Member Function Documentation

EOnCameraExit()

override void SCR_MapDescriptorManualCameraComponent.EOnCameraExit

(

)

Terminate the component.

Implements SCR_BaseManualCameraComponent.

EOnCameraFrame()

override void SCR_MapDescriptorManualCameraComponent.EOnCameraFrame

(

SCR_ManualCameraParam

param

)

Evaluate the component every frame.

Parameters

[in]

param

Object carrying camera properties

Implements SCR_BaseManualCameraComponent.

EOnCameraInit()

override bool SCR_MapDescriptorManualCameraComponent.EOnCameraInit

(

)

Initialise the component.

Returns

True if the component should be evaluated every frame

Implements SCR_BaseManualCameraComponent.

TraceScreenPos()

void SCR_MapDescriptorManualCameraComponent.TraceScreenPos	(	float	width,
		float	height,
		out vector	dir,
		out float	traceCoef
	)

Parameters

[in]	width
[in]	height
[out]	dir
[out]	traceCoef

Member Data Documentation

m_DrawLine

ref PolygonDrawCommand SCR_MapDescriptorManualCameraComponent.m_DrawLine = new PolygonDrawCommand()

protected

m_fIconScale

float SCR_MapDescriptorManualCameraComponent.m_fIconScale

protected

m_fMaxViewConeLength

float SCR_MapDescriptorManualCameraComponent.m_fMaxViewConeLength

protected

m_iBaseType

EMapDescriptorType SCR_MapDescriptorManualCameraComponent.m_iBaseType

protected

m_IconColor

ref Color SCR_MapDescriptorManualCameraComponent.m_IconColor

protected

m_MapCanvas

CanvasWidget SCR_MapDescriptorManualCameraComponent.m_MapCanvas

protected

m_MapDrawCommands

ref array<ref CanvasWidgetCommand> SCR_MapDescriptorManualCameraComponent.m_MapDrawCommands = { m_DrawLine }

protected

m_MapEntity

SCR_MapEntity SCR_MapDescriptorManualCameraComponent.m_MapEntity

protected

m_MapItem

ref MapItem SCR_MapDescriptorManualCameraComponent.m_MapItem

protected

m_sImageDef

string SCR_MapDescriptorManualCameraComponent.m_sImageDef

protected

m_sMapCanvasWidgetName

string SCR_MapDescriptorManualCameraComponent.m_sMapCanvasWidgetName

protected

m_Trace

ref TraceParam SCR_MapDescriptorManualCameraComponent.m_Trace = new TraceParam()

protected

m_ViewConeColor

ref Color SCR_MapDescriptorManualCameraComponent.m_ViewConeColor

protected

m_Workspace

WorkspaceWidget SCR_MapDescriptorManualCameraComponent.m_Workspace

protected

m_World

BaseWorld SCR_MapDescriptorManualCameraComponent.m_World

protected

---

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

• Game/Camera/Components/SCR_MapDescriptorManualCameraComponent.c