Packageaway3d.cameras
Classpublic class HoverCamera3D
InheritanceHoverCamera3D Inheritance TargetCamera3D Inheritance Camera3D Inheritance Object3D Inheritance flash.events.EventDispatcher

Extended camera used to hover round a specified target object.

See also

away3d.containers.View3D
Public Properties
 PropertyDefined by
 Inheritedalpha : Number
An optional alpha value that can be applied to the 3d object.
Object3D
 InheritedanimationLibrary : AnimationLibrary
Reference container for all animations used in the container.
Object3D
 Inheritedaperture : Number
Used in DofSprite3D.
Camera3D
 InheritedblendMode : String
An optional blend mode that can be applied to the 3d object.
Object3D
 InheritedboundingRadius : Number
Returns the bounding radius of the 3d object
Object3D
 Inheritedcenter : Array
Object3D
 Inheritedcollider : Boolean
Indicates whether this object is used for collision detection.
Object3D
 Inheriteddebugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
Object3D
 InheriteddebugBoundingBox : WireCube
Object3D
 InheriteddebugBoundingSphere : WireSphere
Object3D
 Inheriteddebugbs : Boolean
Indicates whether a debug bounding sphere should be rendered around the 3d object.
Object3D
  distance : Number = 800
Distance between the camera and the specified target.
HoverCamera3D
 Inheriteddof : Boolean
Used in DofSprite3D.
Camera3D
 Inheriteddoflevels : Number = 16
Used in DofSprite3D.
Camera3D
 Inheritedeulers : Number3D
Defines the rotation of the 3d object as a Number3D object containing euler angles for rotation around x, y and z axis.
Object3D
 Inheritedextra : Object
An optional untyped object that can contain used-defined properties
Object3D
 Inheritedfilters : Array
An optional array of filters that can be applied to the 3d object.
Object3D
 InheritedfixedZoom : Boolean
Camera3D
 Inheritedfocus : Number
A divisor value for the perspective depth of the view.
Camera3D
 Inheritedfov : Number
Defines the field of view of the camera in a vertical direction.
Camera3D
 InheritedgeometryLibrary : GeometryLibrary
Reference container for all geometries used in the container.
Object3D
 Inheritedid : int
Object3D
 InheritedinverseSceneTransform : Matrix3D
Returns the inverse of sceneTransform.
Object3D
 InheritedinvViewMatrix : Matrix3D
Camera3D
 Inheritedlens : AbstractLens
Defines a lens object used in vertex projection
Camera3D
 InheritedmaterialLibrary : MaterialLibrary
Reference container for all materials used in the container.
Object3D
 Inheritedmaxblur : Number = 150
Used in DofSprite3D.
Camera3D
  maxPanAngle : Number = Infinity
Maximum bounds for the panAngle.
HoverCamera3D
  maxTiltAngle : Number = 90
Maximum bounds for the tiltAngle.
HoverCamera3D
 InheritedmaxX : Number
Returns the maximum x value of the 3d object
Object3D
 InheritedmaxY : Number
Returns the maximum y value of the 3d object
Object3D
 InheritedmaxZ : Number
Returns the maximum z value of the 3d object
Object3D
  minPanAngle : Number
Minimum bounds for the panAngle.
HoverCamera3D
  minTiltAngle : Number = -90
Minimum bounds for the tiltAngle.
HoverCamera3D
 InheritedminX : Number
Returns the minimum x value of the 3d object
Object3D
 InheritedminY : Number
Returns the minimum y value of the 3d object
Object3D
 InheritedminZ : Number
Returns the minimum z value of the 3d object
Object3D
 InheritedmouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
Object3D
 Inheritedname : String
An optional name string for the 3d object.
Object3D
 InheritedobjectDepth : Number
Boundary depth of the 3d object return The depth of the mesh
Object3D
 InheritedobjectHeight : Number
Boundary height of the 3d object return The height of the mesh
Object3D
 InheritedobjectWidth : Number
Boundary width of the 3d object return The width of the object
Object3D
 InheritedownCanvas : Boolean
Defines whether the contents of the 3d object are rendered using it's own render session
Object3D
 InheritedownSession : AbstractSession
Defines a unique render session for the 3d object.
Object3D
  panAngle : Number = 0
Rotation of the camera in degrees around the y axis.
HoverCamera3D
 Inheritedparent : ObjectContainer3D
Cannot parent a TargetCamera3D object.
TargetCamera3D
 InheritedpivotPoint : Number3D
Defines the local point around which the object rotates.
Object3D
 InheritedpivotZero : Boolean
Object3D
 Inheritedposition : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedpushback : Boolean
Elements use their furthest point from the camera when z-sorting
Object3D
 Inheritedpushfront : Boolean
Elements use their nearest point to the camera when z-sorting
Object3D
 Inheritedrenderer : Renderer
An optional renderer object that can be used to render the contents of the object.
Object3D
 InheritedrotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedscaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates.
Object3D
 InheritedscaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates.
Object3D
 InheritedscaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates.
Object3D
 Inheritedscene : Scene3D
Returns the parent scene of the 3d object
Object3D
 InheritedscenePivotPoint : Number3D
Object3D
 InheritedscenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D object.
Object3D
 InheritedsceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D object.
Object3D
 InheritedscreenXOffset : Number
Defines an additional offset to the x coordinate used on mesh elements or objects with ownCanvas set to true
Object3D
 InheritedscreenYOffset : Number
Defines an additional offset to the y coordinate used on mesh elements or objects with ownCanvas set to true
Object3D
 InheritedscreenZOffset : Number
Defines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true
Object3D
 Inheritedsession : AbstractSession
The render session used by the 3d object
Object3D
  steps : Number = 8
Fractional step taken each time the hover() method is called.
HoverCamera3D
 Inheritedtarget : Object3D
The 3d object targeted by the camera.
TargetCamera3D
  tiltAngle : Number = 90
Elevation angle of the camera in degrees.
HoverCamera3D
 Inheritedtransform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheriteduseHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
Object3D
 Inheritedview : View3D
Camera3D
 InheritedviewMatrix : Matrix3D
Returns the transformation matrix used to resolve the scene to the view.
TargetCamera3D
 Inheritedvisible : Boolean
Defines whether the 3d object is visible in the scene
Object3D
  wrapPanAngle : Boolean = false
Defines whether the value of the pan angle wraps when over 360 degrees or under 0 degrees.
HoverCamera3D
 Inheritedx : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedy : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
  yfactor : Number = 2
Fractional difference in distance between the horizontal camera orientation and vertical camera orientation.
HoverCamera3D
 Inheritedz : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedzoom : Number
Provides an overall scale value to the view
Camera3D
Protected Properties
 PropertyDefined by
 Inheritedini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
Object3D
 Inherited_pivotPoint : Number3D
Object3D
Public Methods
 MethodDefined by
  
HoverCamera3D
(init:Object = null)
Creates a new HoverCamera3D object.
HoverCamera3D
 Inherited
addOnCameraUpdate(listener:Function):void
Default method for adding a cameraUpdated event listener
Camera3D
 Inherited
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
Object3D
 Inherited
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
Object3D
 Inherited
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
Object3D
 Inherited
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
Object3D
 Inherited
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
Object3D
 Inherited
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
Object3D
 Inherited
addOnPositionChange(listener:Function):void
Default method for adding a positionchanged event listener
Object3D
 Inherited
addOnRollOut(listener:Function):void
Default method for adding a rollOut3D event listener
Object3D
 Inherited
addOnRollOver(listener:Function):void
Default method for adding a rollOver3D event listener
Object3D
 Inherited
addOnScaleChange(listener:Function):void
Default method for adding a scalechanged event listener
Object3D
 Inherited
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
Object3D
 Inherited
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
Object3D
 Inherited
addOnSessionChange(listener:Function):void
Default method for adding a sessionchanged event listener
Object3D
 Inherited
addOnVisibilityUpdate(listener:Function):void
Default method for adding a visibilityUpdated event listener
Object3D
 Inherited
applyPosition(dx:Number, dy:Number, dz:Number):void
Apply the given position to the object without altering the apperance of child objects
Object3D
 Inherited
Apply the local rotations to the object without altering the apperance of child objects
Object3D
 Inherited
centerPivot():void
Adjusts the pivot point of the object so that it lies at the center of it's geoemtry.
Object3D
 Inherited
clone(object:Object3D = null):Object3D
Duplicates the camera's properties to another Camera3D object.
Camera3D
 Inherited
disableDof():void
Used in DofSprite3D
Camera3D
 Inherited
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
Object3D
 Inherited
enableDof():void
Used in DofSprite3D.
Camera3D
  
hover(jumpTo:Boolean = false):Boolean
Updates the current tilt angle and pan angle values.
HoverCamera3D
 Inherited
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inherited
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
Object3D
 Inherited
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
Object3D
 Inherited
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
Object3D
 Inherited
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
Object3D
 Inherited
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates.
Object3D
 Inherited
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
Object3D
 Inherited
moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
Object3D
 Inherited
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
Object3D
 Inherited
pan(angle:Number):void
Rotates the camera in its horizontal plane.
Camera3D
 Inherited
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
Object3D
 Inherited
removeOnCameraUpdate(listener:Function):void
Default method for removing a cameraUpdated event listener
Camera3D
 Inherited
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
Object3D
 Inherited
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
Object3D
 Inherited
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
Object3D
 Inherited
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
Object3D
 Inherited
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
Object3D
 Inherited
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
Object3D
 Inherited
removeOnPositionChange(listener:Function):void
Default method for removing a positionchanged event listener
Object3D
 Inherited
removeOnRollOut(listener:Function):void
Default method for removing a rollOut3D event listener
Object3D
 Inherited
removeOnRollOver(listener:Function):void
Default method for removing a rollOver3D event listener
Object3D
 Inherited
removeOnScaleChange(listener:Function):void
Default method for removing a scalechanged event listener
Object3D
 Inherited
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
Object3D
 Inherited
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
Object3D
 Inherited
removeOnSessionChange(listener:Function):void
Default method for removing a sessionchanged event listener
Object3D
 Inherited
removeOnVisibilityUpdate(listener:Function):void
Default method for removing a visibilityUpdated event listener
Object3D
 Inherited
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Object3D
 Inherited
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
Object3D
 Inherited
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
Object3D
 Inherited
scale(scale:Number):void
Scales the contents of the 3d object.
Object3D
 Inherited
screen(object:Object3D, vertex:Vertex = null):ScreenVertex
Returns a ScreenVertex object describing the resolved x and y position of the given Vertex object.
Camera3D
 Inherited
tick(time:int):void
Called by the TickTraverser.
Object3D
 Inherited
tilt(angle:Number):void
Rotates the camera in its vertical plane.
Camera3D
 Inherited
toString():String
Used to trace the values of a 3d object.
Object3D
 Inherited
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Object3D
 Inherited
traverse(traverser:Traverser):void
Used when traversing the scenegraph
Object3D
 Inherited
unproject(mX:Number, mY:Number):Number3D
Camera3D
 Inherited
update():void
Updates the transformation matrix used to resolve the scene to the view.
Camera3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined by
 Inherited
Object3D
 Inherited
Object3D
Events
 EventSummaryDefined by
 Inherited Dispatched when the focus or zoom properties of a camera update.Camera3D
 Inherited Dispatched when the contents of the 3d object updates.Object3D
 Inherited Dispatched when the bounding dimensions of the 3d object changes.Object3D
 Inherited Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor while it is over the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor away from the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor over the 3d object.Object3D
 Inherited Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when a user rolls out of the 3d object.Object3D
 Inherited Dispatched when a user rolls over the 3d object.Object3D
 Inherited Dispatched when the parent scene of the 3d object changes.Object3D
 Inherited Dispatched when the scene transform matrix of the 3d object changes.Object3D
 Inherited Dispatched when the render session property of the 3d object changes.Object3D
 Inherited Dispatched when the local transform matrix of the 3d object changes.Object3D
Protected Constants
 ConstantDefined by
 InheritedtoDEGREES : Number = 57.29577951308232
Camera3D
 InheritedtoRADIANS : Number = 0.017453292519943295
Camera3D
Property detail
_currentPanAngleproperty
arcane var _currentPanAngle:Number = 0
_currentTiltAngleproperty 
arcane var _currentTiltAngle:Number = 90
distanceproperty 
public var distance:Number = 800

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

maxPanAngleproperty 
public var maxPanAngle:Number = Infinity

Maximum bounds for the panAngle. Defaults to Infinity.

See also

maxTiltAngleproperty 
public var maxTiltAngle:Number = 90

Maximum bounds for the tiltAngle. Defaults to 90.

See also

minPanAngleproperty 
public var minPanAngle:Number

Minimum bounds for the panAngle. Defaults to -Infinity.

See also

minTiltAngleproperty 
public var minTiltAngle:Number = -90

Minimum bounds for the tiltAngle. Defaults to -90.

See also

panAngleproperty 
public var panAngle:Number = 0

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

stepsproperty 
public var steps:Number = 8

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.

See also

tiltAngleproperty 
public var tiltAngle:Number = 90

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

wrapPanAngleproperty 
public var wrapPanAngle:Boolean = false

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

yfactorproperty 
public var yfactor:Number = 2

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

See also

Constructor detail
HoverCamera3D()constructor
public function HoverCamera3D(init:Object = null)Parameters
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
 yfactor:Number (default = yfactor)
 distance:Number (default = distance)
 wrapPanAngle:Boolean (default = false)
 panAngle:Number (default = panAngle)
 tiltAngle:Number (default = tiltAngle)
 minTiltAngle:Number (default = minTiltAngle)
 maxTiltAngle:Number (default = maxTiltAngle)
 steps:Number (default = steps)
Method detail
hover()method
public function hover(jumpTo:Boolean = false):Boolean

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

Parameters
jumpTo:Boolean (default = false)

Returns
Boolean — True if the camera position was updated, otherwise false.

See also

Wiki link
Click to go to the wiki page for 'away3d.cameras.HoverCamera3D'

Code examples

Comments