Packageorg.flintparticles.threeD.renderers.controllers
Classpublic class OrbitCamera
InheritanceOrbitCamera Inheritance KeyboardControllerBase Inheritance Object

Sets keyboard input to make a renderer's camera orbit around a point in response to keyboard input.

After assigning a camera to an instance of this class, the camera responds to the following keyboard input


Public Properties
 PropertyDefined By
 InheritedautoStart : Boolean = true
KeyboardControllerBase
 Inheritedcamera : Camera
The camera to control with this controller.
KeyboardControllerBase
 InheritedfixedFrameTime : Number
Indicates a fixed time (in seconds) to use for every frame.
KeyboardControllerBase
 InheritedmaximumFrameTime : Number
The maximum duration for a single update frame, in seconds.
KeyboardControllerBase
  rotationRate : Number
The rate at which to rotate the camera when the appropriate keys are pressed, in radians per second.
OrbitCamera
 Inheritedstage : DisplayObject
The stage - used for listening to keyboard events
KeyboardControllerBase
  trackRate : Number
The rate at which to track the camera when the appropriate keys are pressed, in units per second.
OrbitCamera
 InheriteduseInternalTick : Boolean
Indicates whether the controller should manage its own internal update tick.
KeyboardControllerBase
Protected Properties
 PropertyDefined By
 InheritedaDown : Boolean = false
KeyboardControllerBase
 Inherited_camera : Camera
KeyboardControllerBase
 InheriteddDown : Boolean = false
KeyboardControllerBase
 InheriteddownDown : Boolean = false
KeyboardControllerBase
 Inherited_fixedFrameTime : Number = 0
KeyboardControllerBase
 InheritedleftDown : Boolean = false
KeyboardControllerBase
 Inherited_maximumFrameTime : Number = 0.5
KeyboardControllerBase
 InheritedpgDownDown : Boolean = false
KeyboardControllerBase
 InheritedpgUpDown : Boolean = false
KeyboardControllerBase
 InheritedrightDown : Boolean = false
KeyboardControllerBase
 Inherited_running : Boolean = false
KeyboardControllerBase
 InheritedsDown : Boolean = false
KeyboardControllerBase
 Inherited_stage : DisplayObject
KeyboardControllerBase
 InheritedupDown : Boolean = false
KeyboardControllerBase
 Inherited_useInternalTick : Boolean = true
KeyboardControllerBase
 InheritedwDown : Boolean = false
KeyboardControllerBase
Public Methods
 MethodDefined By
  
OrbitCamera(stage:DisplayObject = null, camera:Camera = null, rotationRate:Number = 1, trackRate:Number = 100, useInternalTick:Boolean = true)
The constructor creates an OrbitCamera controller.
OrbitCamera
 Inherited
start():void
Starts the controller.
KeyboardControllerBase
 Inherited
stop():void
Stops the controller.
KeyboardControllerBase
 Inherited
update(time:Number):void
KeyboardControllerBase
Protected Methods
 MethodDefined By
  
updateCamera(time:Number):void
[override]
OrbitCamera
Property Detail
rotationRateproperty
rotationRate:Number

The rate at which to rotate the camera when the appropriate keys are pressed, in radians per second.


Implementation
    public function get rotationRate():Number
    public function set rotationRate(value:Number):void
trackRateproperty 
trackRate:Number

The rate at which to track the camera when the appropriate keys are pressed, in units per second.


Implementation
    public function get trackRate():Number
    public function set trackRate(value:Number):void
Constructor Detail
OrbitCamera()Constructor
public function OrbitCamera(stage:DisplayObject = null, camera:Camera = null, rotationRate:Number = 1, trackRate:Number = 100, useInternalTick:Boolean = true)

The constructor creates an OrbitCamera controller.

Parameters
stage:DisplayObject (default = null) — The display object on which to listen for keyboard input. This should usually be a reference to the stage.
 
camera:Camera (default = null) — The camera to control with this controller.
 
rotationRate:Number (default = 1) — The rate at which to rotate the camera when the appropriate keys are pressed, in radians per second.
 
trackRate:Number (default = 100) — The rate at which to track the camera when the appropriate keys are pressed, in units per second.
 
useInternalTick:Boolean (default = true) — Indicates whether the camera controller should use its own tick event to update its state. The internal tick process is tied to the framerate and updates the camera every frame.
Method Detail
updateCamera()method
override protected function updateCamera(time:Number):void

Parameters

time:Number




© Richard Lord 2008-2011

Sun Feb 27 2011, 06:00 PM Z