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. 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 Dragengine.CameraDirectors.CameraDirector | |
| 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 | initMicrophoneParameters () |
| Init microphone parameters. More... | |
| CameraDirector | new () |
| 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 | updateMicrophone (float elapsed) |
| Update microphone. More... | |
Protected Member Functions | |
| bool | getCameraShotChanged () |
| Camera shot changed. More... | |
| void | onCameraChanged () |
| Camera shot changed hook method. More... | |
Additional Inherited Members | |
| Public Attributes inherited from Dragengine.CameraDirectors.CameraDirector | |
| 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
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()
|
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.
Reimplemented from Dragengine.CameraDirectors.CameraDirector.
◆ new()
| ConversationCameraDirector Dragengine.ConversationSystem.ConversationCameraDirector.new | ( | Camera | camera, |
| Microphone | microphone | ||
| ) |
Creates conversation camera director.
Reimplemented from Dragengine.CameraDirectors.CameraDirector.
◆ 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().
Reimplemented from Dragengine.CameraDirectors.CameraDirector.
◆ 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:
