Directs camera and microphone required to render the game scene. More...

Inheritance diagram for Dragengine.CameraDirectors.CameraDirector:

Public Member Functions
void	activate ()
	Director has been activated. More...

void	applyParameters (Camera camera)
	Apply parameters to camera. More...

void	applyParameters (Microphone microphone)
	Apply parameters to microphone. More...

void	copyParameters (Camera camera)
	Copy parameters from camera. More...

void	copyParameters (CameraDirector director)
	Copy parameters from camera director. More...

void	copyParameters (Microphone microphone)
	Copy parameters from microphone. More...

void	deactivate ()
	Director has been deactivated. More...

float	getAdaptionTime ()
	Adaption time. More...

float	getBloomBlend ()
	Bloom blend as multiplier of intensity beyond bloom intensity. More...

float	getBloomIntensity ()
	Bloom intensity multiplier. More...

float	getBloomSize ()
	Bloom size as percentage of screen width. More...

float	getBloomStrength ()
	Bloom strength as multiplier of intensity beyond bloom intensity. More...

Camera	getCamera ()
	Camera to modify. More...

bool	getEnableAuralization ()
	Enable auralization if supported. More...

bool	getEnableGI ()
	Enable global illumination (GI) if supported. More...

bool	getEnableHDRR ()
	Enable high definition range rendering (HDRR) if supported. More...

float	getExposure ()
	Exposure. More...

float	getFov ()
	Field of view. More...

float	getFovRatio ()
	Field of view ratio (height / width). More...

float	getHighestIntensity ()
	Highest intensity. More...

float	getImageDistance ()
	Camera image distance. More...

LayerMask	getLayerMask ()
	Layer mask. More...

float	getLowestIntensity ()
	Lowest intensity. More...

Microphone	getMicrophone ()
	Microphone to modify. More...

CurveBezier	getToneMapCurve ()
	Custom tone mapping curve or empty curve to disable. More...

float	getViewDistance ()
	Camera view distance. More...

float	getWhiteIntensity ()
	White intensity multiplier. More...

void	initCameraParameters ()
	Init camera parameters. More...

void	initMicrophoneParameters ()
	Init microphone parameters. More...

CameraDirector	new ()
	Create camera director. More...

CameraDirector	new (Camera camera, Microphone microphone)
	Create camera director. More...

void	resetCameraAdaptedIntensity ()
	Request graphic module to reset camera adapted intensity to optimal value. More...

void	setAdaptionTime (float time)
	Set adaption time. More...

void	setBloomBlend (float blend)
	Set bloom blend as multiplier of intensity beyond bloom intensity. More...

void	setBloomIntensity (float intensity)
	Set bloom intensity multiplier. More...

void	setBloomSize (float size)
	Bloom size as percentage of screen width. More...

void	setBloomStrength (float strength)
	Set bloom strength as multiplier of intensity beyond bloom intensity. More...

void	setCamera (Camera camera)
	Set camera to modify. More...

void	setEnableAuralization (bool enable)
	Set to enable auralization if supported. More...

void	setEnableGI (bool enable)
	Set to enable global illumination (GI) if supported. More...

void	setEnableHDRR (bool enable)
	Set to enable high definition range rendering (HDRR) if supported. More...

void	setExposure (float exposure)
	Set exposure. More...

void	setFov (float fov)
	Set field of view. More...

void	setFovRatio (float ratio)
	Set field of view ratio (height / width). More...

void	setHighestIntensity (float intensity)
	Set highest intensity. More...

void	setImageDistance (float distance)
	Set camera image distance. More...

void	setLayerMask (LayerMask layerMask)
	Set layer mask. More...

void	setLowestIntensity (float intensity)
	Set lowest intensity. More...

void	setMicrophone (Microphone microphone)
	Set microphone to modify. More...

void	setToneMapCurve (CurveBezier curve)
	Set custom tone mapping curve or empty curve to disable. More...

void	setViewDistance (float distance)
	Set camera view distance. More...

void	setWhiteIntensity (float intensity)
	Set white intensity multiplier. More...

void	update (float elapsed)
	Update director. More...

void	updateCamera (float elapsed)
	Update camera. More...

void	updateMicrophone (float elapsed)
	Update microphone. More...

Public Attributes
final float	fovFirstPerson = 90
	Typical first person FOV. More...

final float	fovLongTele = 6.87
	Long tele camera FOV. More...

final float	fovMediumTele = 10.29
	Medium tele camera FOV. More...

final float	fovNormal = 39.6
	Normal camera FOV. More...

final float	fovShortFirstPerson = 75
	Shorter first person FOV. More...

final float	fovShortTele = 22.62
	Short tele camera FOV. More...

final float	fovUltraWide = 83.97
	Ultra wide camera FOV. More...

final float	fovWide = 65.47
	Wide camera FOV. More...

float	pAdaptionTime

float	pBloomBlend

float	pBloomIntensity

float	pBloomSize

float	pBloomStrength

Camera	pCamera

bool	pEnableAuralization

bool	pEnableGI

bool	pEnableHDRR

float	pExposure

float	pFov

float	pFovRatio

float	pHighestIntensity

float	pImageDistance

LayerMask	pLayerMask

float	pLowestIntensity

Microphone	pMicrophone

CurveBezier	pToneMapCurve

float	pViewDistance

float	pWhiteIntensity

Detailed Description

Directs camera and microphone required to render the game scene.

The default implementation sets the camera at the origin of the world and the microphone at the same place and orientation as the camera. Subclasses are responsible to set the camera in useful places.

Member Function Documentation

◆ activate()

void Dragengine.CameraDirectors.CameraDirector.activate ( )

Director has been activated.

Useful for init camera parameters that do not change over time. Default implementation calls initCameraParameters if camera is not null and initMicrophoneParameters if microphone is not null.

Reimplemented in Dragengine.CameraDirectors.VRPlayerControlledActorCameraDirector.

◆ applyParameters() [1/2]

void Dragengine.CameraDirectors.CameraDirector.applyParameters ( Camera camera )

Apply parameters to camera.

Version: 1.21

◆ applyParameters() [2/2]

void Dragengine.CameraDirectors.CameraDirector.applyParameters ( Microphone microphone )

Apply parameters to microphone.

Version: 1.23

◆ copyParameters() [1/3]

void Dragengine.CameraDirectors.CameraDirector.copyParameters ( Camera camera )

Copy parameters from camera.

Version: 1.21

◆ copyParameters() [2/3]

void Dragengine.CameraDirectors.CameraDirector.copyParameters ( CameraDirector director )

Copy parameters from camera director.

Version: 1.21

◆ copyParameters() [3/3]

void Dragengine.CameraDirectors.CameraDirector.copyParameters ( Microphone microphone )

Copy parameters from microphone.

Version: 1.23

◆ deactivate()

void Dragengine.CameraDirectors.CameraDirector.deactivate ( )

Director has been deactivated.

Reimplemented in Dragengine.CameraDirectors.VRPlayerControlledActorCameraDirector.

◆ getAdaptionTime()

float Dragengine.CameraDirectors.CameraDirector.getAdaptionTime ( )

Adaption time.

◆ getBloomBlend()

float Dragengine.CameraDirectors.CameraDirector.getBloomBlend ( )

Bloom blend as multiplier of intensity beyond bloom intensity.

Version: 1.21

◆ getBloomIntensity()

float Dragengine.CameraDirectors.CameraDirector.getBloomIntensity ( )

Bloom intensity multiplier.

Version: 1.21

◆ getBloomSize()

float Dragengine.CameraDirectors.CameraDirector.getBloomSize ( )

Bloom size as percentage of screen width.

Version: 1.21

◆ getBloomStrength()

float Dragengine.CameraDirectors.CameraDirector.getBloomStrength ( )

Bloom strength as multiplier of intensity beyond bloom intensity.

Version: 1.21

◆ getCamera()

Camera Dragengine.CameraDirectors.CameraDirector.getCamera ( )

Camera to modify.

◆ getEnableAuralization()

bool Dragengine.CameraDirectors.CameraDirector.getEnableAuralization ( )

Enable auralization if supported.

Version: 1.23

◆ getEnableGI()

bool Dragengine.CameraDirectors.CameraDirector.getEnableGI ( )

Enable global illumination (GI) if supported.

Version: 1.5

◆ getEnableHDRR()

bool Dragengine.CameraDirectors.CameraDirector.getEnableHDRR ( )

Enable high definition range rendering (HDRR) if supported.

Version: 1.5

◆ getExposure()

float Dragengine.CameraDirectors.CameraDirector.getExposure ( )

Exposure.

◆ getFov()

float Dragengine.CameraDirectors.CameraDirector.getFov ( )

Field of view.

◆ getFovRatio()

float Dragengine.CameraDirectors.CameraDirector.getFovRatio ( )

Field of view ratio (height / width).

Version: 1.21

◆ getHighestIntensity()

float Dragengine.CameraDirectors.CameraDirector.getHighestIntensity ( )

Highest intensity.

◆ getImageDistance()

float Dragengine.CameraDirectors.CameraDirector.getImageDistance ( )

Camera image distance.

Version: 1.21

◆ getLayerMask()

LayerMask Dragengine.CameraDirectors.CameraDirector.getLayerMask ( )

Layer mask.

◆ getLowestIntensity()

float Dragengine.CameraDirectors.CameraDirector.getLowestIntensity ( )

Lowest intensity.

◆ getMicrophone()

Microphone Dragengine.CameraDirectors.CameraDirector.getMicrophone ( )

Microphone to modify.

◆ getToneMapCurve()

CurveBezier Dragengine.CameraDirectors.CameraDirector.getToneMapCurve ( )

Custom tone mapping curve or empty curve to disable.

Version: 1.21

◆ getViewDistance()

float Dragengine.CameraDirectors.CameraDirector.getViewDistance ( )

Camera view distance.

◆ getWhiteIntensity()

float Dragengine.CameraDirectors.CameraDirector.getWhiteIntensity ( )

White intensity multiplier.

Version: 1.21

◆ initCameraParameters()

void Dragengine.CameraDirectors.CameraDirector.initCameraParameters ( )

Init camera parameters.

Reimplemented in Dragengine.ConversationSystem.ConversationCameraDirector.

◆ initMicrophoneParameters()

void Dragengine.CameraDirectors.CameraDirector.initMicrophoneParameters ( )

Init microphone parameters.

Version: 1.23

◆ new() [1/2]

CameraDirector Dragengine.CameraDirectors.CameraDirector.new ( )

Create camera director.

Reimplemented in Dragengine.CameraDirectors.VRPlayerControlledActorCameraDirector, and Dragengine.CameraDirectors.PlayerControlledActorCameraDirector.

◆ new() [2/2]

CameraDirector Dragengine.CameraDirectors.CameraDirector.new	(	Camera	camera,
		Microphone	microphone
	)

Create camera director.

Reimplemented in Dragengine.ConversationSystem.ConversationCameraDirector, Dragengine.CameraDirectors.VRPlayerControlledActorCameraDirector, and Dragengine.CameraDirectors.PlayerControlledActorCameraDirector.

◆ resetCameraAdaptedIntensity()

void Dragengine.CameraDirectors.CameraDirector.resetCameraAdaptedIntensity ( )

Request graphic module to reset camera adapted intensity to optimal value.

Version: 1.4

◆ setAdaptionTime()

void Dragengine.CameraDirectors.CameraDirector.setAdaptionTime ( float time )

Set adaption time.

◆ setBloomBlend()

void Dragengine.CameraDirectors.CameraDirector.setBloomBlend ( float blend )

Set bloom blend as multiplier of intensity beyond bloom intensity.

Version: 1.21

◆ setBloomIntensity()

void Dragengine.CameraDirectors.CameraDirector.setBloomIntensity ( float intensity )

Set bloom intensity multiplier.

Version: 1.21

◆ setBloomSize()

void Dragengine.CameraDirectors.CameraDirector.setBloomSize ( float size )

Bloom size as percentage of screen width.

Version: 1.21

◆ setBloomStrength()

void Dragengine.CameraDirectors.CameraDirector.setBloomStrength ( float strength )

Set bloom strength as multiplier of intensity beyond bloom intensity.

Version: 1.21

◆ setCamera()

void Dragengine.CameraDirectors.CameraDirector.setCamera ( Camera camera )

Set camera to modify.

Reimplemented in Dragengine.CameraDirectors.VRPlayerControlledActorCameraDirector.

◆ setEnableAuralization()

void Dragengine.CameraDirectors.CameraDirector.setEnableAuralization ( bool enable )

Set to enable auralization if supported.

Version: 1.23

◆ setEnableGI()

void Dragengine.CameraDirectors.CameraDirector.setEnableGI ( bool enable )

Set to enable global illumination (GI) if supported.

Version: 1.5

◆ setEnableHDRR()

void Dragengine.CameraDirectors.CameraDirector.setEnableHDRR ( bool enable )

Set to enable high definition range rendering (HDRR) if supported.

Version: 1.5

◆ setExposure()

void Dragengine.CameraDirectors.CameraDirector.setExposure ( float exposure )

Set exposure.

◆ setFov()

void Dragengine.CameraDirectors.CameraDirector.setFov ( float fov )

Set field of view.

◆ setFovRatio()

void Dragengine.CameraDirectors.CameraDirector.setFovRatio ( float ratio )

Set field of view ratio (height / width).

Version: 1.21

◆ setHighestIntensity()

void Dragengine.CameraDirectors.CameraDirector.setHighestIntensity ( float intensity )

Set highest intensity.

◆ setImageDistance()

void Dragengine.CameraDirectors.CameraDirector.setImageDistance ( float distance )

Set camera image distance.

Version: 1.21

◆ setLayerMask()

void Dragengine.CameraDirectors.CameraDirector.setLayerMask ( LayerMask layerMask )

Set layer mask.

◆ setLowestIntensity()

void Dragengine.CameraDirectors.CameraDirector.setLowestIntensity ( float intensity )

Set lowest intensity.

◆ setMicrophone()

void Dragengine.CameraDirectors.CameraDirector.setMicrophone ( Microphone microphone )

Set microphone to modify.

◆ setToneMapCurve()

void Dragengine.CameraDirectors.CameraDirector.setToneMapCurve ( CurveBezier curve )

Set custom tone mapping curve or empty curve to disable.

Version: 1.21

Note: If enabled make sure to match the curve range to the white intensity.

◆ setViewDistance()

void Dragengine.CameraDirectors.CameraDirector.setViewDistance ( float distance )

Set camera view distance.

◆ setWhiteIntensity()

void Dragengine.CameraDirectors.CameraDirector.setWhiteIntensity ( float intensity )

Set white intensity multiplier.

Version: 1.21

◆ update()

void Dragengine.CameraDirectors.CameraDirector.update ( float elapsed )

Update director.

Default implementation calls updateCamera if camera is not null and updateMicrophone if microphone is not null.

◆ updateCamera()

void Dragengine.CameraDirectors.CameraDirector.updateCamera ( float elapsed )

Update camera.

Reimplemented in Dragengine.ConversationSystem.ConversationCameraDirector, Dragengine.CameraDirectors.VRPlayerControlledActorCameraDirector, Dragengine.CameraDirectors.PlayerControlledActorCameraDirector, and Dragengine.CameraDirectors.ElementCameraDirector.

◆ updateMicrophone()

void Dragengine.CameraDirectors.CameraDirector.updateMicrophone ( float elapsed )

Update microphone.

Reimplemented in Dragengine.CameraDirectors.PlayerControlledActorCameraDirector.

Member Data Documentation

◆ fovFirstPerson

final float Dragengine.CameraDirectors.CameraDirector.fovFirstPerson = 90

Typical first person FOV.

◆ fovLongTele

final float Dragengine.CameraDirectors.CameraDirector.fovLongTele = 6.87

Long tele camera FOV.

◆ fovMediumTele

final float Dragengine.CameraDirectors.CameraDirector.fovMediumTele = 10.29

Medium tele camera FOV.

◆ fovNormal

final float Dragengine.CameraDirectors.CameraDirector.fovNormal = 39.6

Normal camera FOV.

◆ fovShortFirstPerson

final float Dragengine.CameraDirectors.CameraDirector.fovShortFirstPerson = 75

Shorter first person FOV.

◆ fovShortTele

final float Dragengine.CameraDirectors.CameraDirector.fovShortTele = 22.62

Short tele camera FOV.

◆ fovUltraWide

final float Dragengine.CameraDirectors.CameraDirector.fovUltraWide = 83.97

Ultra wide camera FOV.

◆ fovWide

final float Dragengine.CameraDirectors.CameraDirector.fovWide = 65.47

Wide camera FOV.

◆ pAdaptionTime

float Dragengine.CameraDirectors.CameraDirector.pAdaptionTime

◆ pBloomBlend

float Dragengine.CameraDirectors.CameraDirector.pBloomBlend

◆ pBloomIntensity

float Dragengine.CameraDirectors.CameraDirector.pBloomIntensity

◆ pBloomSize

float Dragengine.CameraDirectors.CameraDirector.pBloomSize

◆ pBloomStrength

float Dragengine.CameraDirectors.CameraDirector.pBloomStrength

◆ pCamera

Camera Dragengine.CameraDirectors.CameraDirector.pCamera

◆ pEnableAuralization

bool Dragengine.CameraDirectors.CameraDirector.pEnableAuralization

◆ pEnableGI

bool Dragengine.CameraDirectors.CameraDirector.pEnableGI

◆ pEnableHDRR

bool Dragengine.CameraDirectors.CameraDirector.pEnableHDRR

◆ pExposure

float Dragengine.CameraDirectors.CameraDirector.pExposure

◆ pFov

float Dragengine.CameraDirectors.CameraDirector.pFov

◆ pFovRatio

float Dragengine.CameraDirectors.CameraDirector.pFovRatio

◆ pHighestIntensity

float Dragengine.CameraDirectors.CameraDirector.pHighestIntensity

◆ pImageDistance

float Dragengine.CameraDirectors.CameraDirector.pImageDistance

◆ pLayerMask

LayerMask Dragengine.CameraDirectors.CameraDirector.pLayerMask

◆ pLowestIntensity

float Dragengine.CameraDirectors.CameraDirector.pLowestIntensity

◆ pMicrophone

Microphone Dragengine.CameraDirectors.CameraDirector.pMicrophone

◆ pToneMapCurve

CurveBezier Dragengine.CameraDirectors.CameraDirector.pToneMapCurve

◆ pViewDistance

float Dragengine.CameraDirectors.CameraDirector.pViewDistance

◆ pWhiteIntensity

float Dragengine.CameraDirectors.CameraDirector.pWhiteIntensity

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

CameraDirector.ds

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ activate()

◆ applyParameters() [1/2]

◆ applyParameters() [2/2]

◆ copyParameters() [1/3]

◆ copyParameters() [2/3]

◆ copyParameters() [3/3]

◆ deactivate()

◆ getAdaptionTime()

◆ getBloomBlend()

◆ getBloomIntensity()

◆ getBloomSize()

◆ getBloomStrength()

◆ getCamera()

◆ getEnableAuralization()

◆ getEnableGI()

◆ getEnableHDRR()

◆ getExposure()

◆ getFov()

◆ getFovRatio()

◆ getHighestIntensity()

◆ getImageDistance()

◆ getLayerMask()

◆ getLowestIntensity()

◆ getMicrophone()

◆ getToneMapCurve()

◆ getViewDistance()

◆ getWhiteIntensity()

◆ initCameraParameters()

◆ initMicrophoneParameters()

◆ new() [1/2]

◆ new() [2/2]

◆ resetCameraAdaptedIntensity()

◆ setAdaptionTime()

◆ setBloomBlend()

◆ setBloomIntensity()

◆ setBloomSize()

◆ setBloomStrength()

◆ setCamera()

◆ setEnableAuralization()

◆ setEnableGI()

◆ setEnableHDRR()

◆ setExposure()

◆ setFov()

◆ setFovRatio()

◆ setHighestIntensity()

◆ setImageDistance()

◆ setLayerMask()

◆ setLowestIntensity()

◆ setMicrophone()

◆ setToneMapCurve()

◆ setViewDistance()

◆ setWhiteIntensity()

◆ update()

◆ updateCamera()

◆ updateMicrophone()

Member Data Documentation

◆ fovFirstPerson

◆ fovLongTele

◆ fovMediumTele

◆ fovNormal

◆ fovShortFirstPerson

◆ fovShortTele

◆ fovUltraWide

◆ fovWide

◆ pAdaptionTime

◆ pBloomBlend

◆ pBloomIntensity

◆ pBloomSize

◆ pBloomStrength

◆ pCamera

◆ pEnableAuralization

◆ pEnableGI

◆ pEnableHDRR

◆ pExposure

◆ pFov

◆ pFovRatio