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
 Inheritedaperture : Number
Used in DofSprite2D.
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
  distance : Number = 800
Distance between the camera and the specified target.
HoverCamera3D
 Inheriteddof : Boolean
Used in DofSprite2D.
Camera3D
 Inheriteddoflevels : Number = 16
Used in DofSprite2D.
Camera3D
 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
 Inheritedfocus : Number
A divisor value for the perspective depth of the view.
Camera3D
 InheritedinverseSceneTransform : Matrix3D
Object3D
 Inheritedmaxblur : Number = 150
Used in DofSprite2D.
Camera3D
  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
  mintiltangle : Number = 0
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
 InheritedownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
Object3D
 InheritedownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
Object3D
  panangle : Number = 0
Rotation of the camera in degrees around the y axis.
HoverCamera3D
 Inheritedparent : ObjectContainer3D
Cannot parent a TargetCamera3D object.
TargetCamera3D
 Inheritedposition : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedprojection : Projection
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
 Inheritedscene : Scene3D
Returns the parent scene of the 3d object
Object3D
 InheritedscenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
Object3D
 InheritedsceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
Object3D
 InheritedsceneTransformed : Boolean
Object3D
 Inheritedsession : AbstractRenderSession
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
  targetpanangle : Number = 0
Target value for the panangle.
HoverCamera3D
  targettiltangle : Number = 90
Target value for the tiltangle.
HoverCamera3D
  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 : Matrix3D
Returns the transformation matrix used to resolve the scene to the view.
TargetCamera3D
 InheritedviewTransform : Matrix3D
Object3D
 Inheritedvisible : Boolean = true
Defines whether the 3d object is visible in the scene
Object3D
 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
Public Methods
 MethodDefined by
  
HoverCamera3D
(init:Object = null)
Creates a new HoverCamera3D object.
HoverCamera3D
 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
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged 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
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
Object3D
 Inherited
clone(object:* = null):*
Duplicates the camera's properties to another Camera3D object.
Camera3D
 Inherited
disableDof():void
Used in DofSprite2D
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 DofSprite2D.
Camera3D
  
hover():Boolean
Updates the tiltangle and panangle values, then calls update().
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
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
Object3D
 Inherited
moveTo(target:Number3D):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
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
Object3D
 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
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged 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
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged 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
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
  
update():Boolean
Updates the camera position.
HoverCamera3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Events
 EventSummaryDefined by
 Inherited Dispatched when the bounding dimensions of the 3d object changes.Object3D
 Inherited Dispatched when a user presses the let 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 let hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when the bounding radius of the 3d object changes.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 local transform matrix of the 3d object changes.Object3D
Property detail
distanceproperty
public var distance:Number = 800

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

maxtiltangleproperty 
public var maxtiltangle:Number = 90

Maximum bounds for the tiltangle. Defaults to 90.

See also

mintiltangleproperty 
public var mintiltangle:Number = 0

Minimum bounds for the tiltangle. Defaults to 0.

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

targetpanangleproperty 
public var targetpanangle:Number = 0

Target value for the panangle. Defaults to 0.

See also

targettiltangleproperty 
public var targettiltangle:Number = 90

Target value for the tiltangle. Defaults to 90.

See also

tiltangleproperty 
public var tiltangle:Number = 90

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

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####
Method detail
hover()method
public function hover():Boolean

Updates the tiltangle and panangle values, then calls update(). Values are calculated using the defined targettiltangle, targetpanangle and steps variables.

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

See also

update()method 
public function update():Boolean

Updates the camera position. Position is calculated using the current values of tiltangle, panangle, distance and yfactor.

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

See also

Wiki link
Click to go to the wiki page for ####WIKI####

Code examples

Comments