Drag[en]gine Script Module DragonScript  1.23
Dragengine.CameraDirectors.ElementCameraDirector Class Reference

Place camera relative an element with orbit support. More...

Inheritance diagram for Dragengine.CameraDirectors.ElementCameraDirector:
Dragengine.CameraDirectors.CameraDirector Dragengine.CameraDirectors.PlayerControlledActorCameraDirector Dragengine.CameraDirectors.VRPlayerControlledActorCameraDirector

Public Member Functions

float getAzimuth ()
 Vertical rotation. More...
 
DMatrix getCameraMatrix ()
 Camera matrix. More...
 
float getDistance ()
 Distance. More...
 
Element getElement ()
 Element. More...
 
float getElevation ()
 Horizontal rotation. More...
 
DMatrix getLocalMatrix ()
 Local matrix. More...
 
DVector getPivot ()
 Rotation point. More...
 
bool getUseOrientation ()
 Use element orientation. More...
 
ElementCameraDirector new (Element element)
 Create camera director. More...
 
ElementCameraDirector new (Element element, Camera camera, Microphone microphone)
 Create camera director. More...
 
void setAzimuth (float azimuth)
 Set vertical rotation. More...
 
void setDistance (float distance)
 Set distance. More...
 
void setElement (Element element)
 Set element. More...
 
void setElevation (float elevation)
 Set horizontal rotation. More...
 
void setLocalMatrix (DMatrix localMatrix)
 Set local matrix. More...
 
void setLocalMatrix (Vector position, Vector rotation)
 Set local matrix from position and rotation. More...
 
void setPivot (DVector pivot)
 Set rotation point. More...
 
void setUseOrientation (bool useOrientation)
 Set use element orientation. More...
 
void updateCamera (float elapsed)
 Update camera. 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 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 updateMicrophone (float elapsed)
 Update microphone. More...
 

Public Attributes

float pAzimuth
 
float pDistance
 
Element pElement
 
float pElevation
 
DMatrix pLocalMatrix
 
DVector pPivot
 
bool pUseOrientation
 
- 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

Place camera relative an element with orbit support.

Camera is placed using a rotation point, oribtal rotation and a matrix local to this rotation point.

Member Function Documentation

◆ getAzimuth()

float Dragengine.CameraDirectors.ElementCameraDirector.getAzimuth ( )

Vertical rotation.

◆ getCameraMatrix()

DMatrix Dragengine.CameraDirectors.ElementCameraDirector.getCameraMatrix ( )

◆ getDistance()

float Dragengine.CameraDirectors.ElementCameraDirector.getDistance ( )

Distance.

◆ getElement()

Element Dragengine.CameraDirectors.ElementCameraDirector.getElement ( )

Element.

◆ getElevation()

float Dragengine.CameraDirectors.ElementCameraDirector.getElevation ( )

Horizontal rotation.

◆ getLocalMatrix()

DMatrix Dragengine.CameraDirectors.ElementCameraDirector.getLocalMatrix ( )

Local matrix.

◆ getPivot()

DVector Dragengine.CameraDirectors.ElementCameraDirector.getPivot ( )

Rotation point.

◆ getUseOrientation()

bool Dragengine.CameraDirectors.ElementCameraDirector.getUseOrientation ( )

Use element orientation.

Version
1.19

If true the camera rotates together with the element. If false the camera only moves together with the element. The default is false.

◆ new() [1/2]

ElementCameraDirector Dragengine.CameraDirectors.ElementCameraDirector.new ( Element  element)

Create camera director.

◆ new() [2/2]

ElementCameraDirector Dragengine.CameraDirectors.ElementCameraDirector.new ( Element  element,
Camera  camera,
Microphone  microphone 
)

Create camera director.

◆ setAzimuth()

void Dragengine.CameraDirectors.ElementCameraDirector.setAzimuth ( float  azimuth)

Set vertical rotation.

◆ setDistance()

void Dragengine.CameraDirectors.ElementCameraDirector.setDistance ( float  distance)

Set distance.

◆ setElement()

void Dragengine.CameraDirectors.ElementCameraDirector.setElement ( Element  element)

Set element.

◆ setElevation()

void Dragengine.CameraDirectors.ElementCameraDirector.setElevation ( float  elevation)

Set horizontal rotation.

◆ setLocalMatrix() [1/2]

void Dragengine.CameraDirectors.ElementCameraDirector.setLocalMatrix ( DMatrix  localMatrix)

Set local matrix.

◆ setLocalMatrix() [2/2]

void Dragengine.CameraDirectors.ElementCameraDirector.setLocalMatrix ( Vector  position,
Vector  rotation 
)

Set local matrix from position and rotation.

◆ setPivot()

void Dragengine.CameraDirectors.ElementCameraDirector.setPivot ( DVector  pivot)

Set rotation point.

◆ setUseOrientation()

void Dragengine.CameraDirectors.ElementCameraDirector.setUseOrientation ( bool  useOrientation)

Set use element orientation.

Version
1.19

If true the camera rotates together with the element. If false the camera only moves together with the element. The default is false.

◆ updateCamera()

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

Member Data Documentation

◆ pAzimuth

float Dragengine.CameraDirectors.ElementCameraDirector.pAzimuth

◆ pDistance

float Dragengine.CameraDirectors.ElementCameraDirector.pDistance

◆ pElement

Element Dragengine.CameraDirectors.ElementCameraDirector.pElement

◆ pElevation

float Dragengine.CameraDirectors.ElementCameraDirector.pElevation

◆ pLocalMatrix

DMatrix Dragengine.CameraDirectors.ElementCameraDirector.pLocalMatrix

◆ pPivot

DVector Dragengine.CameraDirectors.ElementCameraDirector.pPivot

◆ pUseOrientation

bool Dragengine.CameraDirectors.ElementCameraDirector.pUseOrientation

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