Packageaway3d.controllers
Classpublic class HoverController
InheritanceHoverController Inheritance LookAtController Inheritance ControllerBase Inheritance Object
Subclasses FollowController

Extended camera used to hover round a specified target object.

See also

away3d.containers.View3D


Public Properties
 PropertyDefined By
 InheritedautoUpdate : Boolean
Determines whether the controller applies updates automatically.
ControllerBase
  distance : Number
Distance between the camera and the specified target.
HoverController
 InheritedlookAtObject : ObjectContainer3D
The 3d object that the target looks at.
LookAtController
 InheritedlookAtPosition : Vector3D
The Vector3D object that the target looks at.
LookAtController
  maxPanAngle : Number
Maximum bounds for the panAngle.
HoverController
  maxTiltAngle : Number
Maximum bounds for the tiltAngle.
HoverController
  minPanAngle : Number
Minimum bounds for the panAngle.
HoverController
  minTiltAngle : Number
Minimum bounds for the tiltAngle.
HoverController
  panAngle : Number
Rotation of the camera in degrees around the y axis.
HoverController
  steps : uint
Fractional step taken each time the hover() method is called.
HoverController
 InheritedtargetObject : Entity
Target object on which the controller acts.
ControllerBase
  tiltAngle : Number
Elevation angle of the camera in degrees.
HoverController
  wrapPanAngle : Boolean
Defines whether the value of the pan angle wraps when over 360 degrees or under 0 degrees.
HoverController
  yFactor : Number
Fractional difference in distance between the horizontal camera orientation and vertical camera orientation.
HoverController
Protected Properties
 PropertyDefined By
 Inherited_autoUpdate : Boolean = true
ControllerBase
 Inherited_lookAtObject : ObjectContainer3D
LookAtController
 Inherited_lookAtPosition : Vector3D
LookAtController
 Inherited_origin : Vector3D
LookAtController
 Inherited_targetObject : Entity
ControllerBase
Public Methods
 MethodDefined By
  
HoverController(targetObject:Entity = null, lookAtObject:ObjectContainer3D = null, panAngle:Number = 0, tiltAngle:Number = 90, distance:Number = 1000, minTiltAngle:Number = -90, maxTiltAngle:Number = 90, minPanAngle:Number, maxPanAngle:Number, steps:uint = 8, yFactor:Number = 2, wrapPanAngle:Boolean = false)
Creates a new HoverController object.
HoverController
  
update():void
[override] Updates the current tilt angle and pan angle values.
HoverController
Protected Methods
 MethodDefined By
 Inherited
ControllerBase
Property Detail
_currentPanAngleproperty
arcane var _currentPanAngle:Number = 0

_currentTiltAngleproperty 
arcane var _currentTiltAngle:Number = 90

distanceproperty 
distance:Number

Distance between the camera and the specified target. Defaults to 1000.


Implementation
    public function get distance():Number
    public function set distance(value:Number):void
maxPanAngleproperty 
maxPanAngle:Number

Maximum bounds for the panAngle. Defaults to Infinity.


Implementation
    public function get maxPanAngle():Number
    public function set maxPanAngle(value:Number):void

See also

maxTiltAngleproperty 
maxTiltAngle:Number

Maximum bounds for the tiltAngle. Defaults to 90.


Implementation
    public function get maxTiltAngle():Number
    public function set maxTiltAngle(value:Number):void

See also

minPanAngleproperty 
minPanAngle:Number

Minimum bounds for the panAngle. Defaults to -Infinity.


Implementation
    public function get minPanAngle():Number
    public function set minPanAngle(value:Number):void

See also

minTiltAngleproperty 
minTiltAngle:Number

Minimum bounds for the tiltAngle. Defaults to -90.


Implementation
    public function get minTiltAngle():Number
    public function set minTiltAngle(value:Number):void

See also

panAngleproperty 
panAngle:Number

Rotation of the camera in degrees around the y axis. Defaults to 0.


Implementation
    public function get panAngle():Number
    public function set panAngle(value:Number):void
stepsproperty 
steps:uint

Fractional step taken each time the hover() method is called. Defaults to 8. Affects the speed at which the tiltAngle and panAngle resolve to their targets.


Implementation
    public function get steps():uint
    public function set steps(value:uint):void

See also

tiltAngleproperty 
tiltAngle:Number

Elevation angle of the camera in degrees. Defaults to 90.


Implementation
    public function get tiltAngle():Number
    public function set tiltAngle(value:Number):void
wrapPanAngleproperty 
wrapPanAngle:Boolean

Defines whether the value of the pan angle wraps when over 360 degrees or under 0 degrees. Defaults to false.


Implementation
    public function get wrapPanAngle():Boolean
    public function set wrapPanAngle(value:Boolean):void
yFactorproperty 
yFactor:Number

Fractional difference in distance between the horizontal camera orientation and vertical camera orientation. Defaults to 2.


Implementation
    public function get yFactor():Number
    public function set yFactor(value:Number):void

See also

Constructor Detail
HoverController()Constructor
public function HoverController(targetObject:Entity = null, lookAtObject:ObjectContainer3D = null, panAngle:Number = 0, tiltAngle:Number = 90, distance:Number = 1000, minTiltAngle:Number = -90, maxTiltAngle:Number = 90, minPanAngle:Number, maxPanAngle:Number, steps:uint = 8, yFactor:Number = 2, wrapPanAngle:Boolean = false)

Creates a new HoverController object.

Parameters
targetObject:Entity (default = null)
 
lookAtObject:ObjectContainer3D (default = null)
 
panAngle:Number (default = 0)
 
tiltAngle:Number (default = 90)
 
distance:Number (default = 1000)
 
minTiltAngle:Number (default = -90)
 
maxTiltAngle:Number (default = 90)
 
minPanAngle:Number (default = NaN)
 
maxPanAngle:Number (default = NaN)
 
steps:uint (default = 8)
 
yFactor:Number (default = 2)
 
wrapPanAngle:Boolean (default = false)
Method Detail
update()method
override public function update():void

Updates the current tilt angle and pan angle values. Values are calculated using the defined tiltAngle, panAngle and steps variables.

See also