Torque 3D - Script Manual: Base Camera

TorqueScript

Main   Class List   Namespace List   Online

Base Camera
[Camera System]

The base camera object that is typically manipulated by a GameConnection's input. More...

Classes

class  Camera
 Represents a position, direction and field of view to render a scene from. More...
class  CameraData
 A datablock that describes a camera. More...

Enumerations

enum  CameraMotionMode {
  Stationary,
  FreeRotate,
  Fly,
  OrbitObject,
  OrbitPoint,
  TrackObject,
  Overhead,
  EditOrbit
}
 

Movement behavior type for Camera.

More...

Variables

static float Camera::movementSpeed
 Global camera movement speed in units/s (typically m/s), with a base value of 40.

Detailed Description

The base camera object that is typically manipulated by a GameConnection's input.


Enumeration Type Documentation

Movement behavior type for Camera.

Enumerator:
Stationary 

Camera does not rotate or move.

FreeRotate 

Camera may rotate but does not move.

Fly 

Camera may rotate and move freely.

OrbitObject 

Camera orbits about a given object. Damage flash and white out is determined by the object being orbited. See Camera::setOrbitMode() to set the orbit object and other parameters.

OrbitPoint 

Camera orbits about a given point. See Camera::setOrbitMode() to set the orbit point and other parameters.

TrackObject 

Camera always faces a given object. See Camera::setTrackObject() to set the object to track and a distance to remain from the object.

Overhead 

Camera moves in the XY plane.

EditOrbit 

Used by the World Editor to orbit about a point. When first activated, the camera is rotated to face the orbit point rather than move to it.


Variable Documentation

float Camera::movementSpeed [static, inherited]

Global camera movement speed in units/s (typically m/s), with a base value of 40.

Used in the following camera modes:

  • Edit Orbit Mode
  • Fly Mode
  • Overhead Mode


Copyright © GarageGames, LLC. All Rights Reserved.