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

Camera shot. More...

Inheritance diagram for ConversationCameraShot:

Classes

enum  eParameters
 Camera shot parameters. More...
 

Public Member Functions

int getActorCount ()
 Number of actors required for this camera shot. More...
 
bool getAlignTargets ()
 Targets are aligned along the conversation coordinate system. More...
 
float getCameraDistanceFrom ()
 Start camera orbit distance. More...
 
float getCameraDistanceTo ()
 End camera orbit distance. More...
 
Vector getCameraOrbitFrom ()
 Start camera orbit rotation in degrees. More...
 
Vector getCameraOrbitTo ()
 End camera orbit rotation. More...
 
float getFovFrom ()
 Start camera fov in degrees. More...
 
float getFovTo ()
 End camera fov in degrees. More...
 
bool getLockCameraTarget ()
 Camera target position is locked during the camera shot. More...
 
bool getLockLookAtTarget ()
 Look-at target position is locked during the camera shot. More...
 
bool getLockUpAxis ()
 Up axis of targets is locked during aligning. More...
 
StringID getName ()
 Name. More...
 
Vector getOffsetCameraFrom ()
 Start camera offset. More...
 
Vector getOffsetCameraTo ()
 End camera position. More...
 
Vector getOffsetLookAtFrom ()
 Start look-at position. More...
 
Vector getOffsetLookAtTo ()
 End look-at position. More...
 
CurveBezier getParameterCurve (int parameter)
 Curve. More...
 
Vector getPositionFrom ()
 Start position. More...
 
Vector getPositionTo ()
 End position. More...
 
bool getRelativeToLookAt ()
 Camera is relative to the camera target or the look-at target. More...
 
Vector getRotationFrom ()
 Start orbit rotation in degrees. More...
 
Vector getRotationTo ()
 End camera rotation. More...
 
float getTiltFrom ()
 Start camera tilt in degrees. More...
 
float getTiltTo ()
 End camera tilt in degrees. More...
 
ConversationCameraShot new (StringID name)
 Create conversation camera shot. More...
 
void setActorCount (int count)
 Set number of actors required for this camera shot. More...
 
void setAlignTargets (bool alignTargets)
 Set if targets are aligned along the conversation coordinate system. More...
 
void setCameraDistanceFrom (float distance)
 Set start camera orbit distance. More...
 
void setCameraDistanceTo (float distance)
 Set end camera orbit distance. More...
 
void setCameraOrbitFrom (Vector rotation)
 Set start camera orbit rotation in degrees. More...
 
void setCameraOrbitTo (Vector rotation)
 Set end camera orbit rotation. More...
 
void setFovFrom (float fov)
 Set start camera fov in degrees. More...
 
void setFovTo (float fov)
 Set end camera fov in degrees. More...
 
void setLockCameraTarget (bool lock)
 Set if camera target position is locked during the camera shot. More...
 
void setLockLookAtTarget (bool lock)
 Set if look-at target position is locked during the camera shot. More...
 
void setLockUpAxis (bool lockUpAxis)
 Set if up axis of targets is locked during aligning. More...
 
void setOffsetCameraFrom (Vector position)
 Set start camera offset. More...
 
void setOffsetCameraTo (Vector position)
 Set end camera position. More...
 
void setOffsetLookAtFrom (Vector position)
 Set start look-at position. More...
 
void setOffsetLookAtTo (Vector position)
 Set end look-at position. More...
 
void setPositionFrom (Vector position)
 Set start position. More...
 
void setPositionTo (Vector position)
 Set end position. More...
 
void setRelativeToLookAt (bool relativeToLookAt)
 Set if camera is relative to the camera target or the look-at target. More...
 
void setRotationFrom (Vector rotation)
 Set start orbit rotation in degrees. More...
 
void setRotationTo (Vector rotation)
 Set end camera rotation. More...
 
void setTiltFrom (float tilt)
 Set start camera tilt in degrees. More...
 
void setTiltTo (float tilt)
 Set end camera tilt in degrees. More...
 
void writeToFile (FileWriter writer)
 Write to file. More...
 

Static Public Member Functions

static ConversationCameraShot readFromFile (FileReader reader)
 Read from file. More...
 

Detailed Description

Camera shot.

Member Function Documentation

◆ getActorCount()

int getActorCount ( )

Number of actors required for this camera shot.

◆ getAlignTargets()

bool getAlignTargets ( )

Targets are aligned along the conversation coordinate system.

◆ getCameraDistanceFrom()

float getCameraDistanceFrom ( )

Start camera orbit distance.

◆ getCameraDistanceTo()

float getCameraDistanceTo ( )

End camera orbit distance.

◆ getCameraOrbitFrom()

Vector getCameraOrbitFrom ( )

Start camera orbit rotation in degrees.

◆ getCameraOrbitTo()

Vector getCameraOrbitTo ( )

End camera orbit rotation.

◆ getFovFrom()

float getFovFrom ( )

Start camera fov in degrees.

◆ getFovTo()

float getFovTo ( )

End camera fov in degrees.

◆ getLockCameraTarget()

bool getLockCameraTarget ( )

Camera target position is locked during the camera shot.

◆ getLockLookAtTarget()

bool getLockLookAtTarget ( )

Look-at target position is locked during the camera shot.

◆ getLockUpAxis()

bool getLockUpAxis ( )

Up axis of targets is locked during aligning.

◆ getName()

StringID getName ( )

Name.

◆ getOffsetCameraFrom()

Vector getOffsetCameraFrom ( )

Start camera offset.

◆ getOffsetCameraTo()

Vector getOffsetCameraTo ( )

End camera position.

◆ getOffsetLookAtFrom()

Vector getOffsetLookAtFrom ( )

Start look-at position.

◆ getOffsetLookAtTo()

Vector getOffsetLookAtTo ( )

End look-at position.

◆ getParameterCurve()

CurveBezier getParameterCurve ( int  parameter)

Curve.

◆ getPositionFrom()

Vector getPositionFrom ( )

Start position.

◆ getPositionTo()

Vector getPositionTo ( )

End position.

◆ getRelativeToLookAt()

bool getRelativeToLookAt ( )

Camera is relative to the camera target or the look-at target.

◆ getRotationFrom()

Vector getRotationFrom ( )

Start orbit rotation in degrees.

◆ getRotationTo()

Vector getRotationTo ( )

End camera rotation.

◆ getTiltFrom()

float getTiltFrom ( )

Start camera tilt in degrees.

◆ getTiltTo()

float getTiltTo ( )

End camera tilt in degrees.

◆ new()

Create conversation camera shot.

◆ readFromFile()

static ConversationCameraShot readFromFile ( FileReader  reader)
static

Read from file.

◆ setActorCount()

void setActorCount ( int  count)

Set number of actors required for this camera shot.

◆ setAlignTargets()

void setAlignTargets ( bool  alignTargets)

Set if targets are aligned along the conversation coordinate system.

◆ setCameraDistanceFrom()

void setCameraDistanceFrom ( float  distance)

Set start camera orbit distance.

◆ setCameraDistanceTo()

void setCameraDistanceTo ( float  distance)

Set end camera orbit distance.

◆ setCameraOrbitFrom()

void setCameraOrbitFrom ( Vector  rotation)

Set start camera orbit rotation in degrees.

◆ setCameraOrbitTo()

void setCameraOrbitTo ( Vector  rotation)

Set end camera orbit rotation.

◆ setFovFrom()

void setFovFrom ( float  fov)

Set start camera fov in degrees.

◆ setFovTo()

void setFovTo ( float  fov)

Set end camera fov in degrees.

◆ setLockCameraTarget()

void setLockCameraTarget ( bool  lock)

Set if camera target position is locked during the camera shot.

◆ setLockLookAtTarget()

void setLockLookAtTarget ( bool  lock)

Set if look-at target position is locked during the camera shot.

◆ setLockUpAxis()

void setLockUpAxis ( bool  lockUpAxis)

Set if up axis of targets is locked during aligning.

◆ setOffsetCameraFrom()

void setOffsetCameraFrom ( Vector  position)

Set start camera offset.

◆ setOffsetCameraTo()

void setOffsetCameraTo ( Vector  position)

Set end camera position.

◆ setOffsetLookAtFrom()

void setOffsetLookAtFrom ( Vector  position)

Set start look-at position.

◆ setOffsetLookAtTo()

void setOffsetLookAtTo ( Vector  position)

Set end look-at position.

◆ setPositionFrom()

void setPositionFrom ( Vector  position)

Set start position.

◆ setPositionTo()

void setPositionTo ( Vector  position)

Set end position.

◆ setRelativeToLookAt()

void setRelativeToLookAt ( bool  relativeToLookAt)

Set if camera is relative to the camera target or the look-at target.

◆ setRotationFrom()

void setRotationFrom ( Vector  rotation)

Set start orbit rotation in degrees.

◆ setRotationTo()

void setRotationTo ( Vector  rotation)

Set end camera rotation.

◆ setTiltFrom()

void setTiltFrom ( float  tilt)

Set start camera tilt in degrees.

◆ setTiltTo()

void setTiltTo ( float  tilt)

Set end camera tilt in degrees.

◆ writeToFile()

void writeToFile ( FileWriter  writer)

Write to file.


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