Drag[en]gine Script Module DragonScript Script API  1.0
ConversationCameraDirector Class Reference

Animate camera using camera definition. More...

Inheritance diagram for ConversationCameraDirector:
CameraDirector

Public Member Functions

void advanceCameraTime (float elapsed)
 Advance the camera time. More...
 
ConversationActor getCameraActor ()
 Actor to attach the camera to or null if not set. More...
 
ConversationCoordSystem getCameraCoordSystem ()
 Coordinate system to attach the camera to or null if not set. More...
 
ConversationCameraShot getCameraShot ()
 Camera shot to use or null if not set. More...
 
ConversationTarget getCameraTarget ()
 Camera target or null if not set. More...
 
DMatrix getCoordSys ()
 Coordinate system matrix. More...
 
float getDuration ()
 Duration of the camera shot. More...
 
float getElapsed ()
 Elapsed time. More...
 
DMatrix getLockedCameraMatrix ()
 Locked camera target matrix or null if not yet set. More...
 
DMatrix getLockedLookAtMatrix ()
 Locked look-at target matrix or null if not yet set. More...
 
ConversationActor getLookAtActor ()
 Actor to look at or null if not set. More...
 
ConversationCoordSystem getLookAtCoordSystem ()
 Coordinate system to look at or null if not set. More...
 
ConversationTarget getLookAtTarget ()
 Look-at target or null if not set. More...
 
bool getLooping ()
 Camera shot is looping. More...
 
void initCameraParameters ()
 Init camera parameters. More...
 
ConversationCameraDirector new (Camera camera, Microphone microphone)
 Creates conversation camera director. More...
 
void readFromFile (ConversationPlayback playback, PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
void setCameraActor (ConversationActor actor)
 Set actor to attach the camera to or null if not set. More...
 
void setCameraCoordSystem (ConversationCoordSystem coordSystem)
 Set coordinate system to attach the camera to or null if not set. More...
 
void setCameraShot (ConversationCameraShot cameraShot)
 Set camera shot to use or null if not set. More...
 
void setCameraTarget (ConversationTarget target)
 Set camera target or null if not set. More...
 
void setCoordSys (DMatrix matrix)
 Set coordinate system matrix. More...
 
void setDuration (float duration)
 Set duration of the camera shot. More...
 
void setElapsed (float elapsed)
 Set elapsed time. More...
 
void setLockedCameraMatrix (DMatrix matrix)
 Set locked camera target matrix or null if not yet set. More...
 
void setLockedLookAtMatrix (DMatrix matrix)
 Set locked look-at target matrix or null if not yet set. More...
 
void setLookAtActor (ConversationActor actor)
 Set actor to look at or null if not set. More...
 
void setLookAtCoordSystem (ConversationCoordSystem coordSystem)
 Set coordinate system to look at or null if not set. More...
 
void setLookAtTarget (ConversationTarget target)
 Set look-at target or null if not set. More...
 
void setLooping (bool looping)
 Set if camera shot is looping. More...
 
void updateCamera (float elapsed)
 Update camera. More...
 
void updateConstant ()
 Update camera using the constant method. More...
 
void updateLinear ()
 Update camera using the linear method. More...
 
void updateUsing (DVector offsetCamera, DVector offsetLookAt, DVector cameraOrbit, DVector position, DVector rotation, float cameraDistance, float fov)
 Update camera using calculated parameters. More...
 
void updateUsingCalculated (DVector position, Quaternion orientation, float fov, DVector lookAt)
 Set camera position and orientation from calculated values. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write to file. More...
 
- Public Member Functions inherited from CameraDirector
void activate ()
 Director has been made the current one. More...
 
float getAdaptionTime ()
 Adaption time. More...
 
Camera getCamera ()
 Camera to modify. More...
 
float getExposure ()
 Exposure. More...
 
float getFOV ()
 Field of view. More...
 
float getHighestIntensity ()
 Highest intensity. More...
 
LayerMask getLayerMask ()
 Layer mask. More...
 
float getLowestIntensity ()
 Lowest intensity. More...
 
Microphone getMicrophone ()
 Microphone to modify. More...
 
float getViewDistance ()
 Camera view distance. More...
 
void initCameraParameters ()
 Init camera parameters. More...
 
CameraDirector new (Camera camera, Microphone microphone)
 Create camera director. More...
 
void setAdaptionTime (float adaptionTime)
 Set adaption time. More...
 
void setCamera (Camera camera)
 Set camera to modify. More...
 
void setExposure (float exposure)
 Set exposure. More...
 
void setFOV (float fov)
 Set field of view. More...
 
void setHighestIntensity (float highestIntensity)
 Set highest intensity. More...
 
void setLayerMask (LayerMask layerMask)
 Set layer mask. More...
 
void setLowestIntensity (float lowestIntensity)
 Set lowest intensity. More...
 
void setMicrophone (Microphone microphone)
 Set microphone to modify. More...
 
void setViewDistance (float distance)
 Set camera view distance. More...
 
void update (float elapsed)
 Update director. More...
 
void updateCamera (float elapsed)
 Update camera. More...
 
void updateMicrophone (float elapsed)
 Update microphone. More...
 

Additional Inherited Members

- Public Attributes inherited from CameraDirector
final float FOV_FIRSTPERSON = 90.00
 Typical First Person FOV. More...
 
final float FOV_LONGTELE = 6.87
 Long Tele Camera FOV. More...
 
final float FOV_MEDIUMTELE = 10.29
 Medium Tele Camera FOV. More...
 
final float FOV_NORMAL = 39.60
 Normal Camera FOV. More...
 
final float FOV_SHORTTELE = 22.62
 Short Tele Camera FOV. More...
 
final float FOV_ULTRAWIDE = 83.97
 Ultra Wide Camera FOV. More...
 
final float FOV_WIDE = 65.47
 Wide Camera FOV. More...
 

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 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 getCameraActor ( )

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

◆ getCameraCoordSystem()

ConversationCoordSystem getCameraCoordSystem ( )

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

◆ getCameraShot()

ConversationCameraShot getCameraShot ( )

Camera shot to use or null if not set.

◆ getCameraTarget()

ConversationTarget getCameraTarget ( )

Camera target or null if not set.

◆ getCoordSys()

DMatrix getCoordSys ( )

Coordinate system matrix.

◆ getDuration()

float getDuration ( )

Duration of the camera shot.

◆ getElapsed()

float getElapsed ( )

Elapsed time.

◆ getLockedCameraMatrix()

DMatrix getLockedCameraMatrix ( )

Locked camera target matrix or null if not yet set.

◆ getLockedLookAtMatrix()

DMatrix getLockedLookAtMatrix ( )

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

◆ getLookAtActor()

ConversationActor getLookAtActor ( )

Actor to look at or null if not set.

◆ getLookAtCoordSystem()

ConversationCoordSystem getLookAtCoordSystem ( )

Coordinate system to look at or null if not set.

◆ getLookAtTarget()

ConversationTarget getLookAtTarget ( )

Look-at target or null if not set.

◆ getLooping()

bool getLooping ( )

Camera shot is looping.

◆ initCameraParameters()

void initCameraParameters ( )

Init camera parameters.

◆ new()

ConversationCameraDirector new ( Camera  camera,
Microphone  microphone 
)

Creates conversation camera director.

◆ readFromFile()

void readFromFile ( ConversationPlayback  playback,
PersistencyEnvironment  env,
FileReader  reader 
)

Read from file.

◆ setCameraActor()

void setCameraActor ( ConversationActor  actor)

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

◆ setCameraCoordSystem()

void setCameraCoordSystem ( ConversationCoordSystem  coordSystem)

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

◆ setCameraShot()

void setCameraShot ( ConversationCameraShot  cameraShot)

Set camera shot to use or null if not set.

◆ setCameraTarget()

void setCameraTarget ( ConversationTarget  target)

Set camera target or null if not set.

◆ setCoordSys()

void setCoordSys ( DMatrix  matrix)

Set coordinate system matrix.

◆ setDuration()

void setDuration ( float  duration)

Set duration of the camera shot.

◆ setElapsed()

void setElapsed ( float  elapsed)

Set elapsed time.

◆ setLockedCameraMatrix()

void setLockedCameraMatrix ( DMatrix  matrix)

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

◆ setLockedLookAtMatrix()

void setLockedLookAtMatrix ( DMatrix  matrix)

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

◆ setLookAtActor()

void setLookAtActor ( ConversationActor  actor)

Set actor to look at or null if not set.

◆ setLookAtCoordSystem()

void setLookAtCoordSystem ( ConversationCoordSystem  coordSystem)

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

◆ setLookAtTarget()

void setLookAtTarget ( ConversationTarget  target)

Set look-at target or null if not set.

◆ setLooping()

void setLooping ( bool  looping)

Set if camera shot is looping.

◆ updateCamera()

void updateCamera ( float  elapsed)

Update camera.

◆ updateConstant()

void updateConstant ( )

Update camera using the constant method.

◆ updateLinear()

void updateLinear ( )

Update camera using the linear method.

◆ updateUsing()

void updateUsing ( DVector  offsetCamera,
DVector  offsetLookAt,
DVector  cameraOrbit,
DVector  position,
DVector  rotation,
float  cameraDistance,
float  fov 
)

Update camera using calculated parameters.

◆ updateUsingCalculated()

void 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
positionCamera position after calculation.
orientationCamera orientation after calculation.
fovCamera field of view after calculation.
lookAtCamera look-at position after calculation.

◆ writeToFile()

void writeToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write to file.


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