Dragengine.ConversationSystem.ConversationCameraDirector Class Reference

Animate camera using camera definition. More...

Inheritance diagram for Dragengine.ConversationSystem.ConversationCameraDirector:

Public Member Functions
void	advanceCameraTime (float elapsed)
	Advance the camera time.
ConversationActor	getCameraActor ()
	Actor to attach the camera to or null if not set.
ConversationCoordSystem	getCameraCoordSystem ()
	Coordinate system to attach the camera to or null if not set.
ConversationCameraShot	getCameraShot ()
	Camera shot to use or null if not set.
ConversationTarget	getCameraTarget ()
	Camera target or null if not set.
DMatrix	getCoordSys ()
	Coordinate system matrix.
float	getDuration ()
	Duration of the camera shot.
float	getElapsed ()
	Elapsed time.
DMatrix	getLockedCameraMatrix ()
	Locked camera target matrix or null if not yet set.
DMatrix	getLockedLookAtMatrix ()
	Locked look-at target matrix or null if not yet set.
ConversationActor	getLookAtActor ()
	Actor to look at or null if not set.
ConversationCoordSystem	getLookAtCoordSystem ()
	Coordinate system to look at or null if not set.
ConversationTarget	getLookAtTarget ()
	Look-at target or null if not set.
bool	getLooping ()
	Camera shot is looping.
void	initCameraParameters ()
	Init camera parameters.
ConversationCameraDirector	new (Camera camera, Microphone microphone)
	Creates conversation camera director.
void	readFromFile (ConversationPlayback playback, PersistencyEnvironment env, FileReader reader)
	Read from file.
void	setCameraActor (ConversationActor actor)
	Set actor to attach the camera to or null if not set.
void	setCameraCoordSystem (ConversationCoordSystem coordSystem)
	Set coordinate system to attach the camera to or null if not set.
void	setCameraShot (ConversationCameraShot cameraShot)
	Set camera shot to use or null if not set.
void	setCameraTarget (ConversationTarget target)
	Set camera target or null if not set.
void	setCoordSys (DMatrix matrix)
	Set coordinate system matrix.
void	setDuration (float duration)
	Set duration of the camera shot.
void	setElapsed (float elapsed)
	Set elapsed time.
void	setLockedCameraMatrix (DMatrix matrix)
	Set locked camera target matrix or null if not yet set.
void	setLockedLookAtMatrix (DMatrix matrix)
	Set locked look-at target matrix or null if not yet set.
void	setLookAtActor (ConversationActor actor)
	Set actor to look at or null if not set.
void	setLookAtCoordSystem (ConversationCoordSystem coordSystem)
	Set coordinate system to look at or null if not set.
void	setLookAtTarget (ConversationTarget target)
	Set look-at target or null if not set.
void	setLooping (bool looping)
	Set if camera shot is looping.
void	updateCamera (float elapsed)
	Update camera.
void	updateConstant ()
	Update camera using the constant method.
void	updateLinear ()
	Update camera using the linear method.
void	updateUsing (DVector offsetCamera, DVector offsetLookAt, DVector cameraOrbit, DVector position, DVector rotation, float cameraDistance, float fov)
	Update camera using calculated parameters.
void	updateUsingCalculated (DVector position, Quaternion orientation, float fov, DVector lookAt)
	Set camera position and orientation from calculated values.
void	writeToFile (PersistencyEnvironment env, FileWriter writer)
	Write to file.

Protected Member Functions
bool	getCameraShotChanged ()
	Camera shot changed.
void	onCameraChanged ()
	Camera shot changed hook method.

Detailed Description

Animate camera using camera definition.

The conversation playback is responsible to set camera definition to use as well as updating the camera director.

Member Function Documentation

advanceCameraTime()

void Dragengine.ConversationSystem.ConversationCameraDirector.advanceCameraTime

(

float

elapsed

)

Advance the camera time.

This call is different from update(float) as this one is used by the conversation playback to set the proper camera time. The update(float) call is called by the game state thus the timing would be disturbed.

getCameraActor()

ConversationActor Dragengine.ConversationSystem.ConversationCameraDirector.getCameraActor

(

)

Actor to attach the camera to or null if not set.

getCameraCoordSystem()

ConversationCoordSystem Dragengine.ConversationSystem.ConversationCameraDirector.getCameraCoordSystem

(

)

Coordinate system to attach the camera to or null if not set.

getCameraShot()

ConversationCameraShot Dragengine.ConversationSystem.ConversationCameraDirector.getCameraShot

(

)

Camera shot to use or null if not set.

getCameraShotChanged()

bool Dragengine.ConversationSystem.ConversationCameraDirector.getCameraShotChanged ( )

protected

Camera shot changed.

Version

1.6

getCameraTarget()

ConversationTarget Dragengine.ConversationSystem.ConversationCameraDirector.getCameraTarget

(

)

Camera target or null if not set.

getCoordSys()

DMatrix Dragengine.ConversationSystem.ConversationCameraDirector.getCoordSys

(

)

Coordinate system matrix.

getDuration()

float Dragengine.ConversationSystem.ConversationCameraDirector.getDuration

(

)

Duration of the camera shot.

getElapsed()

float Dragengine.ConversationSystem.ConversationCameraDirector.getElapsed

(

)

Elapsed time.

getLockedCameraMatrix()

DMatrix Dragengine.ConversationSystem.ConversationCameraDirector.getLockedCameraMatrix

(

)

Locked camera target matrix or null if not yet set.

getLockedLookAtMatrix()

DMatrix Dragengine.ConversationSystem.ConversationCameraDirector.getLockedLookAtMatrix

(

)

Locked look-at target matrix or null if not yet set.

getLookAtActor()

ConversationActor Dragengine.ConversationSystem.ConversationCameraDirector.getLookAtActor

(

)

Actor to look at or null if not set.

getLookAtCoordSystem()

ConversationCoordSystem Dragengine.ConversationSystem.ConversationCameraDirector.getLookAtCoordSystem

(

)

Coordinate system to look at or null if not set.

getLookAtTarget()

ConversationTarget Dragengine.ConversationSystem.ConversationCameraDirector.getLookAtTarget

(

)

Look-at target or null if not set.

getLooping()

bool Dragengine.ConversationSystem.ConversationCameraDirector.getLooping

(

)

Camera shot is looping.

initCameraParameters()

void Dragengine.ConversationSystem.ConversationCameraDirector.initCameraParameters

(

)

Init camera parameters.

new()

ConversationCameraDirector Dragengine.ConversationSystem.ConversationCameraDirector.new	(	Camera	camera,
		Microphone	microphone
	)

Creates conversation camera director.

onCameraChanged()

void Dragengine.ConversationSystem.ConversationCameraDirector.onCameraChanged ( )

protected

Camera shot changed hook method.

Version

1.6

Called once by updateCamera() after camera shot changed.

readFromFile()

void Dragengine.ConversationSystem.ConversationCameraDirector.readFromFile	(	ConversationPlayback	playback,
		PersistencyEnvironment	env,
		FileReader	reader
	)

Read from file.

setCameraActor()

void Dragengine.ConversationSystem.ConversationCameraDirector.setCameraActor

(

ConversationActor

actor

)

Set actor to attach the camera to or null if not set.

setCameraCoordSystem()

void Dragengine.ConversationSystem.ConversationCameraDirector.setCameraCoordSystem

(

ConversationCoordSystem

coordSystem

)

Set coordinate system to attach the camera to or null if not set.

setCameraShot()

void Dragengine.ConversationSystem.ConversationCameraDirector.setCameraShot

(

ConversationCameraShot

cameraShot

)

Set camera shot to use or null if not set.

setCameraTarget()

void Dragengine.ConversationSystem.ConversationCameraDirector.setCameraTarget

(

ConversationTarget

target

)

Set camera target or null if not set.

setCoordSys()

void Dragengine.ConversationSystem.ConversationCameraDirector.setCoordSys

(

DMatrix

matrix

)

Set coordinate system matrix.

setDuration()

void Dragengine.ConversationSystem.ConversationCameraDirector.setDuration

(

float

duration

)

Set duration of the camera shot.

setElapsed()

void Dragengine.ConversationSystem.ConversationCameraDirector.setElapsed

(

float

elapsed

)

Set elapsed time.

setLockedCameraMatrix()

void Dragengine.ConversationSystem.ConversationCameraDirector.setLockedCameraMatrix

(

DMatrix

matrix

)

Set locked camera target matrix or null if not yet set.

setLockedLookAtMatrix()

void Dragengine.ConversationSystem.ConversationCameraDirector.setLockedLookAtMatrix

(

DMatrix

matrix

)

Set locked look-at target matrix or null if not yet set.

setLookAtActor()

void Dragengine.ConversationSystem.ConversationCameraDirector.setLookAtActor

(

ConversationActor

actor

)

Set actor to look at or null if not set.

setLookAtCoordSystem()

void Dragengine.ConversationSystem.ConversationCameraDirector.setLookAtCoordSystem

(

ConversationCoordSystem

coordSystem

)

Set coordinate system to look at or null if not set.

setLookAtTarget()

void Dragengine.ConversationSystem.ConversationCameraDirector.setLookAtTarget

(

ConversationTarget

target

)

Set look-at target or null if not set.

setLooping()

void Dragengine.ConversationSystem.ConversationCameraDirector.setLooping

(

bool

looping

)

Set if camera shot is looping.

updateCamera()

void Dragengine.ConversationSystem.ConversationCameraDirector.updateCamera

(

float

elapsed

)

Update camera.

Updates camera using super.updateCamera() or updateLinear() if a camera shot is set.

Version 1.6 and later

If camera shot changed calls resetAdaptedIntensity() on camera. This ensures camera is fully adapted to the lighting conditions. This is required if the camera switches between locations of drastically different lighting conditions.

If camera shot changed calls onCameraChanged().

updateConstant()

void Dragengine.ConversationSystem.ConversationCameraDirector.updateConstant

(

)

Update camera using the constant method.

updateLinear()

void Dragengine.ConversationSystem.ConversationCameraDirector.updateLinear

(

)

Update camera using the linear method.

updateUsing()

void Dragengine.ConversationSystem.ConversationCameraDirector.updateUsing	(	DVector	offsetCamera,
		DVector	offsetLookAt,
		DVector	cameraOrbit,
		DVector	position,
		DVector	rotation,
		float	cameraDistance,
		float	fov
	)

Update camera using calculated parameters.

updateUsingCalculated()

void Dragengine.ConversationSystem.ConversationCameraDirector.updateUsingCalculated	(	DVector	position,
		Quaternion	orientation,
		float	fov,
		DVector	lookAt
	)

Set camera position and orientation from calculated values.

Allows subclasses to modify the calculated values before updating the camera position and orientation.

The default implementation sets the values the to the camera without further processing.

Parameters

position	Camera position after calculation.
orientation	Camera orientation after calculation.
fov	Camera field of view after calculation.
lookAt	Camera look-at position after calculation.

writeToFile()

void Dragengine.ConversationSystem.ConversationCameraDirector.writeToFile	(	PersistencyEnvironment	env,
		FileWriter	writer
	)

Write to file.

---

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

• ConversationCameraDirector.ds