Create a light on camera position. More...

Inheritance diagram for SCR_LightManualCameraComponent:

Public Member Functions
void	ToggleLight ()
	Toggle camera light.

void	SetLight (bool enable, bool noSound=false)
	Set camera light.

bool	IsLightOn ()

ScriptInvoker	GetOnLightChanged ()
	Get current light change ScriptInvoker which is called if Light is turned on/off.

override void	EOnCameraSave (SCR_ManualCameraComponentSave data)
	Save persistent data.

override void	EOnCameraLoad (SCR_ManualCameraComponentSave data)
	Load persistent data.

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.

Protected Member Functions
void	OnInputDeviceIsGamepad (bool isGamepad)

void	CameraLightIntensityUpdate (vector cameraTransform[4])

void	PointingLightTransformUpdateKeyboard (SCR_ManualCameraParam param)

void	PointingLightTransformUpdateGamepad (SCR_ManualCameraParam param)

void	PointingLightTransformUpdate (SCR_ManualCameraParam param, vector pointingPosition, float cameraHeightBeforeDeatach, float lightDetachDistanceSq)

vector	GetCursorWorldPosition ()

vector	GetCameraCenterRayCastPosition ()

Protected Member Functions inherited from SCR_BaseManualCameraComponent
SCR_ManualCamera	GetCameraEntity ()

InputManager	GetInputManager ()

vector	CoordToCamera (vector pos)

vector	CoordFromCamera (vector pos)

Protected Attributes
ResourceName	m_LightPrefab

float	m_fLongitudinalOffset

string	m_sSoundEvent

ref Color	m_cCameraLightColor

ref Color	m_cPointingLightColor

ref Curve	m_cCameraLightIntensityCurve

ref Curve	m_cPointingLightIntensityCurve

float	m_fPointingLightHeight

float	m_fCameraHeightBeforeShowPointing_keyboard

float	m_fCameraHeightBeforeShowPointing_gamepad

float	m_fShowPointingLightDistance_keyboard

float	m_fShowPointingLightDistance_gamepad

bool	m_bPointingLightRotationOverride

float	m_fPointingLightRotationOverrideY

float	m_fCameraLightIntensityMaxHeight

float	m_fPointingLightIntensityMaxDistance

float	m_fCameraLightIntesityMin

float	m_fCameraLightIntesityMax

float	m_fPointingLightIntesityMin

float	m_fPointingLightIntesityMax

bool	m_bIsUsingKeyboardAndMouse = true

float	m_fLightMaxLV = 21

float	m_fLightMinLV = -8

LightEntity	m_CameraLight

LightEntity	m_PointingLight

BaseWorld	m_World

WorkspaceWidget	m_WorkSpace

bool	m_bIsLightOn

ref ScriptInvoker	Event_OnLightChanged = new ScriptInvoker()

bool	m_bLightAtCameraPosition = true

Protected Attributes inherited from SCR_BaseManualCameraComponent
int	m_iPriority

SCR_ManualCamera	m_Camera

InputManager	m_InputManager

Detailed Description

Create a light on camera position.

Member Function Documentation

◆ CameraLightIntensityUpdate()

void SCR_LightManualCameraComponent.CameraLightIntensityUpdate ( vector cameraTransform[4] )

protected

◆ EOnCameraExit()

override void SCR_LightManualCameraComponent.EOnCameraExit ( )

Terminate the component.

Implements SCR_BaseManualCameraComponent.

◆ EOnCameraFrame()

override void SCR_LightManualCameraComponent.EOnCameraFrame ( SCR_ManualCameraParam param )

Evaluate the component every frame.

Parameters

[in] param Object carrying camera properties

Implements SCR_BaseManualCameraComponent.

◆ EOnCameraInit()

override bool SCR_LightManualCameraComponent.EOnCameraInit ( )

Initialise the component.

Returns: True if the component should be evaluated every frame

Implements SCR_BaseManualCameraComponent.

◆ EOnCameraLoad()

override void SCR_LightManualCameraComponent.EOnCameraLoad ( SCR_ManualCameraComponentSave data )

Load persistent data.

Parameters

[in] data

Implements SCR_BaseManualCameraComponent.

◆ EOnCameraSave()

override void SCR_LightManualCameraComponent.EOnCameraSave ( SCR_ManualCameraComponentSave data )

Save persistent data.

Parameters

[in] data

Implements SCR_BaseManualCameraComponent.

◆ GetCameraCenterRayCastPosition()

vector SCR_LightManualCameraComponent.GetCameraCenterRayCastPosition ( )

protected

◆ GetCursorWorldPosition()

vector SCR_LightManualCameraComponent.GetCursorWorldPosition ( )

protected

◆ GetOnLightChanged()

ScriptInvoker SCR_LightManualCameraComponent.GetOnLightChanged ( )

Get current light change ScriptInvoker which is called if Light is turned on/off.

Returns: Script invoker

◆ IsLightOn()

bool SCR_LightManualCameraComponent.IsLightOn ( )

Returns: if light is on in editor or not

◆ OnInputDeviceIsGamepad()

void SCR_LightManualCameraComponent.OnInputDeviceIsGamepad ( bool isGamepad )

protected

◆ PointingLightTransformUpdate()

void SCR_LightManualCameraComponent.PointingLightTransformUpdate	(	SCR_ManualCameraParam	param,
		vector	pointingPosition,
		float	cameraHeightBeforeDeatach,
		float	lightDetachDistanceSq )

protected

◆ PointingLightTransformUpdateGamepad()

void SCR_LightManualCameraComponent.PointingLightTransformUpdateGamepad ( SCR_ManualCameraParam param )

protected

◆ PointingLightTransformUpdateKeyboard()

void SCR_LightManualCameraComponent.PointingLightTransformUpdateKeyboard ( SCR_ManualCameraParam param )

protected

◆ SetLight()

void SCR_LightManualCameraComponent.SetLight	(	bool	enable,
		bool	noSound = false )

Set camera light.

Parameters

[in]	enable	True to turn on the light, false to turn it off
[in]	noSound	True to prevent the sound from being played.

◆ ToggleLight()

void SCR_LightManualCameraComponent.ToggleLight ( )

Toggle camera light.

Member Data Documentation

◆ Event_OnLightChanged

ref ScriptInvoker SCR_LightManualCameraComponent.Event_OnLightChanged = new ScriptInvoker()

protected

◆ m_bIsLightOn

bool SCR_LightManualCameraComponent.m_bIsLightOn

protected

◆ m_bIsUsingKeyboardAndMouse

bool SCR_LightManualCameraComponent.m_bIsUsingKeyboardAndMouse = true

protected

◆ m_bLightAtCameraPosition

bool SCR_LightManualCameraComponent.m_bLightAtCameraPosition = true

protected

◆ m_bPointingLightRotationOverride

bool SCR_LightManualCameraComponent.m_bPointingLightRotationOverride

protected

◆ m_CameraLight

LightEntity SCR_LightManualCameraComponent.m_CameraLight

protected

◆ m_cCameraLightColor

ref Color SCR_LightManualCameraComponent.m_cCameraLightColor

protected

◆ m_cCameraLightIntensityCurve

ref Curve SCR_LightManualCameraComponent.m_cCameraLightIntensityCurve

protected

◆ m_cPointingLightColor

ref Color SCR_LightManualCameraComponent.m_cPointingLightColor

protected

◆ m_cPointingLightIntensityCurve

ref Curve SCR_LightManualCameraComponent.m_cPointingLightIntensityCurve

protected

◆ m_fCameraHeightBeforeShowPointing_gamepad

float SCR_LightManualCameraComponent.m_fCameraHeightBeforeShowPointing_gamepad

protected

◆ m_fCameraHeightBeforeShowPointing_keyboard

float SCR_LightManualCameraComponent.m_fCameraHeightBeforeShowPointing_keyboard

protected

◆ m_fCameraLightIntensityMaxHeight

float SCR_LightManualCameraComponent.m_fCameraLightIntensityMaxHeight

protected

◆ m_fCameraLightIntesityMax

float SCR_LightManualCameraComponent.m_fCameraLightIntesityMax

protected

◆ m_fCameraLightIntesityMin

float SCR_LightManualCameraComponent.m_fCameraLightIntesityMin

protected

◆ m_fLightMaxLV

float SCR_LightManualCameraComponent.m_fLightMaxLV = 21

protected

◆ m_fLightMinLV

float SCR_LightManualCameraComponent.m_fLightMinLV = -8

protected

◆ m_fLongitudinalOffset

float SCR_LightManualCameraComponent.m_fLongitudinalOffset

protected

◆ m_fPointingLightHeight

float SCR_LightManualCameraComponent.m_fPointingLightHeight

protected

◆ m_fPointingLightIntensityMaxDistance

float SCR_LightManualCameraComponent.m_fPointingLightIntensityMaxDistance

protected

◆ m_fPointingLightIntesityMax

float SCR_LightManualCameraComponent.m_fPointingLightIntesityMax

protected

◆ m_fPointingLightIntesityMin

float SCR_LightManualCameraComponent.m_fPointingLightIntesityMin

protected

◆ m_fPointingLightRotationOverrideY

float SCR_LightManualCameraComponent.m_fPointingLightRotationOverrideY

protected

◆ m_fShowPointingLightDistance_gamepad

float SCR_LightManualCameraComponent.m_fShowPointingLightDistance_gamepad

protected

◆ m_fShowPointingLightDistance_keyboard

float SCR_LightManualCameraComponent.m_fShowPointingLightDistance_keyboard

protected

◆ m_LightPrefab

ResourceName SCR_LightManualCameraComponent.m_LightPrefab

protected

◆ m_PointingLight

LightEntity SCR_LightManualCameraComponent.m_PointingLight

protected

◆ m_sSoundEvent

string SCR_LightManualCameraComponent.m_sSoundEvent

protected

◆ m_WorkSpace

WorkspaceWidget SCR_LightManualCameraComponent.m_WorkSpace

protected

◆ m_World

BaseWorld SCR_LightManualCameraComponent.m_World

protected

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

Game/Camera/Components/SCR_LightManualCameraComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ CameraLightIntensityUpdate()

◆ EOnCameraExit()

◆ EOnCameraFrame()

◆ EOnCameraInit()

◆ EOnCameraLoad()

◆ EOnCameraSave()

◆ GetCameraCenterRayCastPosition()

◆ GetCursorWorldPosition()

◆ GetOnLightChanged()

◆ IsLightOn()

◆ OnInputDeviceIsGamepad()

◆ PointingLightTransformUpdate()

◆ PointingLightTransformUpdateGamepad()

◆ PointingLightTransformUpdateKeyboard()

◆ SetLight()

◆ ToggleLight()

Member Data Documentation

◆ Event_OnLightChanged

◆ m_bIsLightOn

◆ m_bIsUsingKeyboardAndMouse

◆ m_bLightAtCameraPosition

◆ m_bPointingLightRotationOverride

◆ m_CameraLight

◆ m_cCameraLightColor

◆ m_cCameraLightIntensityCurve

◆ m_cPointingLightColor

◆ m_cPointingLightIntensityCurve

◆ m_fCameraHeightBeforeShowPointing_gamepad

◆ m_fCameraHeightBeforeShowPointing_keyboard

◆ m_fCameraLightIntensityMaxHeight

◆ m_fCameraLightIntesityMax

◆ m_fCameraLightIntesityMin

◆ m_fLightMaxLV

◆ m_fLightMinLV

◆ m_fLongitudinalOffset

◆ m_fPointingLightHeight

◆ m_fPointingLightIntensityMaxDistance

◆ m_fPointingLightIntesityMax

◆ m_fPointingLightIntesityMin

◆ m_fPointingLightRotationOverrideY

◆ m_fShowPointingLightDistance_gamepad

◆ m_fShowPointingLightDistance_keyboard

◆ m_LightPrefab

◆ m_PointingLight

◆ m_sSoundEvent

◆ m_WorkSpace

◆ m_World