Main Page   Modules   File List   File Members  

LuaCamera.cpp File Reference


Detailed Description

Contains function specific to cameras.

System: Scar

>


Functions

void Camera_FocusSobGroupWithBuffer (const char *sobGroupName, float distance, float bufferDistance, float time)
 sobGroupName: the sob group to focus on distance: the distance at which to focus bufferDistance: if the camera is already within that buffer, the time will not be taken into consideration time: the time it will take to cover the distance

void Camera_AltFocusWithVolume (const char *sobGroupName, bool closeZoom, const char *volumeName)
 same as Camera_AltFocus, except a volume can be added to the focus sobGroupName: the sobGroup to focus on closeZoom: will zoom in close if 1 volumeName: the name of the volume that can be added to to focus selection

void Camera_AltFocus (const char *sobGroupName, bool closeZoom=false)
 perform a simple Alt-focus on a sobgroup as a whole

void Camera_FocusVolumeKeepingEyePosition (const char *volumeName)
 performs an (instant) focus on the given volume, keeping the camera's current position

void Camera_FocusSobGroup (const char *sobGroupName, bool closeZoom, float distance, float time)
 will focus on first squadron in the sobGroup, obsolete, use Camera_FocusSobGroupWithBuffer

void Camera_FocusVolumeWithBuffer (const char *volumeName, float distance, float bufferDistance, float time)
 will focus on the center of the volume, any volume can be used if clozeZoom is 1 it will zoom in close to the bounding sphere of the volume if a time and distance is given, the closeZoom flag will be set to false

void Camera_FocusVolume (const char *volumeName, bool closeZoom, float distance, float time)
 Obsolete use Camera_FocusVolumeWithBuffer.

void Camera_ZoomClose (bool bClose)
 toggles between setting the camera zoom as close or far

void Camera_UseCameraPoint (const char *cameraPoint)
 Uses a camera point created in maya with LevelEd.

void Camera_FocusCameraPoint (const char *cameraPoint, float distance, float time)
 to allow us to use a Camera Point with a transition time to the camera point

void Camera_FocusCancel ()
 Cancels the focus on the current point, and reverts back to the previous point.

void Camera_FocusRestore ()
 Restores the camera to the save focus point.

void Camera_FocusSave ()
 Saves a focus point for later use with FocusRestore.

void Camera_ResetRotated ()
 resets the camera rotation flag

bool Camera_PlayerHasRotated (float degree)
 will return true if the user rotated the camera

void Camera_ResetPanned ()
 resets the camera panning flag

bool Camera_PlayerHasPanned (float distance)
 will return true if the user panned the camera

bool Camera_UsePanning (bool panning)
 turn on/off camera panning, returns the current flag the user had

void Camera_ResetFocused ()
 resets the camera focus point history

real32 Camera_GetLastZoomAmount ()
 get the last zoom

bool Camera_PlayerHasFocused (const char *sobGroupName)
 returns true if the camera has the lead ship of the sobGroup in it's current history of selection

bool Camera_IsFocused (const char *sobGroupName)
 returns true if the camera is currently focused on the specified sobgroup

void Camera_SetLetterboxState (bool state, float numSeconds)
 sets the letter box state, UI if active stays there

float Camera_GetDistanceToSobGroup (const char *sobGroupName)
 returns the distance from the camera to the specified sobGroup

void Camera_SetLetterboxStateNoUI (bool state, float numSeconds)
 sets the letter box state and disables the UI

void Camera_Interpolate (const char *fromCameraPoint, const char *toCameraPoint, float transitTime)
 Interpolate between a pair of camera points created in maya with LevelEd; use "here" as the first point to interpolate from the current camera position.

void Camera_AllowControl (bool enable)
 if true allows rotation of the camera


Generated on Fri Oct 31 04:05:39 2003 for Scar by doxygen1.3-rc3