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

Classes

enum  eParameters
 

Public Member Functions

int getActorCount ()
 
bool getAlignTargets ()
 
float getCameraDistanceFrom ()
 
float getCameraDistanceTo ()
 
Vector getCameraOrbitFrom ()
 
Vector getCameraOrbitTo ()
 
float getFovFrom ()
 
float getFovTo ()
 
bool getLockCameraTarget ()
 
bool getLockLookAtTarget ()
 
bool getLockUpAxis ()
 
StringID getName ()
 
Vector getOffsetCameraFrom ()
 
Vector getOffsetCameraTo ()
 
Vector getOffsetLookAtFrom ()
 
Vector getOffsetLookAtTo ()
 
CurveBezier getParameterCurve (int parameter)
 
Vector getPositionFrom ()
 
Vector getPositionTo ()
 
bool getRelativeToLookAt ()
 
Vector getRotationFrom ()
 
Vector getRotationTo ()
 
float getTiltFrom ()
 
float getTiltTo ()
 
ConversationCameraShot new (StringID name)
 
void setActorCount (int count)
 
void setAlignTargets (bool alignTargets)
 
void setCameraDistanceFrom (float distance)
 
void setCameraDistanceTo (float distance)
 
void setCameraOrbitFrom (Vector rotation)
 
void setCameraOrbitTo (Vector rotation)
 
void setFovFrom (float fov)
 
void setFovTo (float fov)
 
void setLockCameraTarget (bool lock)
 
void setLockLookAtTarget (bool lock)
 
void setLockUpAxis (bool lockUpAxis)
 
void setOffsetCameraFrom (Vector position)
 
void setOffsetCameraTo (Vector position)
 
void setOffsetLookAtFrom (Vector position)
 
void setOffsetLookAtTo (Vector position)
 
void setPositionFrom (Vector position)
 
void setPositionTo (Vector position)
 
void setRelativeToLookAt (bool relativeToLookAt)
 
void setRotationFrom (Vector rotation)
 
void setRotationTo (Vector rotation)
 
void setTiltFrom (float tilt)
 
void setTiltTo (float tilt)
 

Detailed Description

A camera shot in a conversation script.

Author
Roland Pl├╝ss
Version
1.0

Member Function Documentation

§ getActorCount()

int getActorCount ( )

Retrieves the number of actors required for this camera shot.

§ getAlignTargets()

bool getAlignTargets ( )

Determines if the targets are aligned along the conversation coordinate system.

§ getCameraDistanceFrom()

float getCameraDistanceFrom ( )

Retrieves the start camera orbit distance.

§ getCameraDistanceTo()

float getCameraDistanceTo ( )

Retrieves the end camera orbit distance.

§ getCameraOrbitFrom()

Vector getCameraOrbitFrom ( )

Retrieves the start camera orbit rotation in degrees.

§ getCameraOrbitTo()

Vector getCameraOrbitTo ( )

Retrieves the end camera orbit rotation.

§ getFovFrom()

float getFovFrom ( )

Retrieves the start camera fov in degrees.

§ getFovTo()

float getFovTo ( )

Retrieves the end camera fov in degrees.

§ getLockCameraTarget()

bool getLockCameraTarget ( )

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

§ getLockLookAtTarget()

bool getLockLookAtTarget ( )

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

§ getLockUpAxis()

bool getLockUpAxis ( )

Determines if the up axis of targets is locked during aligning.

§ getName()

StringID getName ( )

Retrieves the name.

§ getOffsetCameraFrom()

Vector getOffsetCameraFrom ( )

Retrieves the start camera offset.

§ getOffsetCameraTo()

Vector getOffsetCameraTo ( )

Retrieves the end camera position.

§ getOffsetLookAtFrom()

Vector getOffsetLookAtFrom ( )

Retrieves the start look-at position.

§ getOffsetLookAtTo()

Vector getOffsetLookAtTo ( )

Retrieves the end look-at position.

§ getParameterCurve()

CurveBezier getParameterCurve ( int  parameter)

Retrieves a curve.

§ getPositionFrom()

Vector getPositionFrom ( )

Retrieves the start position.

§ getPositionTo()

Vector getPositionTo ( )

Retrieves the end position.

§ getRelativeToLookAt()

bool getRelativeToLookAt ( )

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

§ getRotationFrom()

Vector getRotationFrom ( )

Retrieves the start orbit rotation in degrees.

§ getRotationTo()

Vector getRotationTo ( )

Retrieves the end camera rotation.

§ getTiltFrom()

float getTiltFrom ( )

Retrieves the start camera tilt in degrees.

§ getTiltTo()

float getTiltTo ( )

Retrieves the end camera tilt in degrees.

§ new()

Create a new conversation camera shot.

§ setActorCount()

void setActorCount ( int  count)

Sets the number of actors required for this camera shot.

§ setAlignTargets()

void setAlignTargets ( bool  alignTargets)

Sets if the targets are aligned along the conversation coordinate system.

§ setCameraDistanceFrom()

void setCameraDistanceFrom ( float  distance)

Sets the start camera orbit distance.

§ setCameraDistanceTo()

void setCameraDistanceTo ( float  distance)

Sets the end camera orbit distance.

§ setCameraOrbitFrom()

void setCameraOrbitFrom ( Vector  rotation)

Sets the start camera orbit rotation in degrees.

§ setCameraOrbitTo()

void setCameraOrbitTo ( Vector  rotation)

Sets the end camera orbit rotation.

§ setFovFrom()

void setFovFrom ( float  fov)

Sets the start camera fov in degrees.

§ setFovTo()

void setFovTo ( float  fov)

Sets the end camera fov in degrees.

§ setLockCameraTarget()

void setLockCameraTarget ( bool  lock)

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

§ setLockLookAtTarget()

void setLockLookAtTarget ( bool  lock)

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

§ setLockUpAxis()

void setLockUpAxis ( bool  lockUpAxis)

Sets if the up axis of targets is locked during aligning.

§ setOffsetCameraFrom()

void setOffsetCameraFrom ( Vector  position)

Sets the start camera offset.

§ setOffsetCameraTo()

void setOffsetCameraTo ( Vector  position)

Sets the end camera position.

§ setOffsetLookAtFrom()

void setOffsetLookAtFrom ( Vector  position)

Sets the start look-at position.

§ setOffsetLookAtTo()

void setOffsetLookAtTo ( Vector  position)

Sets the end look-at position.

§ setPositionFrom()

void setPositionFrom ( Vector  position)

Sets the start position.

§ setPositionTo()

void setPositionTo ( Vector  position)

Sets the end position.

§ setRelativeToLookAt()

void setRelativeToLookAt ( bool  relativeToLookAt)

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

§ setRotationFrom()

void setRotationFrom ( Vector  rotation)

Sets the start orbit rotation in degrees.

§ setRotationTo()

void setRotationTo ( Vector  rotation)

Sets the end camera rotation.

§ setTiltFrom()

void setTiltFrom ( float  tilt)

Sets the start camera tilt in degrees.

§ setTiltTo()

void setTiltTo ( float  tilt)

Sets the end camera tilt in degrees.


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