Drag[en]gine Script Module DragonScript Script API  1.0
CameraWrapper Class Reference
Inheritance diagram for CameraWrapper:

Public Member Functions

Camera getCamera ()
 
float getFov ()
 
float getFovRatio ()
 
float getImageDistance ()
 
DMatrix getMatrix ()
 
Quaternion getOrientation ()
 
DVector getPosition ()
 
float getViewDistance ()
 
CameraWrapper new ()
 
CameraWrapper new (CameraWrapper cam)
 
void setFov (float fov)
 
void setFovRatio (float ratio)
 
void setFromMatrix (DMatrix matrix)
 
void setImageDistance (float distance)
 
void setOrientation (Quaternion orientation)
 
void setPosition (DVector pos)
 
void setRotation (Vector rot)
 
void setViewDistance (float distance)
 
void update (float elapsed)
 

Static Public Member Functions

static float fovFromFocal (float filmSize, float focalLength)
 

Public Attributes

final float FOV_FIRSTPERSON = 90.00
 
final float FOV_LONGTELE = 6.87
 
final float FOV_MEDIUMTELE = 10.29
 
final float FOV_NORMAL = 39.60
 
final float FOV_SHORTTELE = 22.62
 
final float FOV_ULTRAWIDE = 83.97
 
final float FOV_WIDE = 65.47
 

Detailed Description

Wraper for an engine camera. Allows altering the wrapped camera using scripted logic.

Author
Roland Pl├╝ss
Version
1.0

Member Function Documentation

§ fovFromFocal()

static float fovFromFocal ( float  filmSize,
float  focalLength 
)
static

Helper function that calculates the field-of-view for a given focal length of a camera.

§ getCamera()

Camera getCamera ( )

Retrieves the camera.

§ getFov()

float getFov ( )

Retrieves Field of View of camera.

§ getFovRatio()

float getFovRatio ( )

Retrieves Field of View Ratio.

§ getImageDistance()

float getImageDistance ( )

Retrieves Image Distance of Camera.

§ getMatrix()

DMatrix getMatrix ( )

Calculates the matrix of this camera.

§ getOrientation()

Quaternion getOrientation ( )

Retrieve Orientation of camera.

§ getPosition()

DVector getPosition ( )

Retrieve Position of camera.

§ getViewDistance()

float getViewDistance ( )

Retrieves View Distance of Camera.

§ new() [1/2]

CameraWrapper new ( )

Creates a new named camera object.

§ new() [2/2]

Creates a copy of a camera.

§ setFov()

void setFov ( float  fov)

Sets the Field of View of the Camera.

§ setFovRatio()

void setFovRatio ( float  ratio)

Sets the View Distance of the Camera.

§ setFromMatrix()

void setFromMatrix ( DMatrix  matrix)

Sets the camera position and orientation from the given matrix.

§ setImageDistance()

void setImageDistance ( float  distance)

Sets the Image Distance of the camera.

§ setOrientation()

void setOrientation ( Quaternion  orientation)

Set Orientation of camera.

§ setPosition()

void setPosition ( DVector  pos)

Set Position of camera.

§ setRotation()

void setRotation ( Vector  rot)

Set camera orientation using a rotation vector.

§ setViewDistance()

void setViewDistance ( float  distance)

Sets the View Distance of the camera.

§ update()

void update ( float  elapsed)

Update the camera.

Member Data Documentation

§ FOV_FIRSTPERSON

final float FOV_FIRSTPERSON = 90.00

Typical First Person FOV

§ FOV_LONGTELE

final float FOV_LONGTELE = 6.87

Long Tele Camera FOV

§ FOV_MEDIUMTELE

final float FOV_MEDIUMTELE = 10.29

Medium Tele Camera FOV

§ FOV_NORMAL

final float FOV_NORMAL = 39.60

Normal Camera FOV

§ FOV_SHORTTELE

final float FOV_SHORTTELE = 22.62

Short Tele Camera FOV

§ FOV_ULTRAWIDE

final float FOV_ULTRAWIDE = 83.97

Ultra Wide Camera FOV

§ FOV_WIDE

final float FOV_WIDE = 65.47

Wide Camera FOV


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