Package | away3d.cameras |
Class | public class HoverCamera3D |
Inheritance | HoverCamera3D TargetCamera3D Camera3D Object3D flash.events.EventDispatcher |
See also
Property | Defined By | ||
---|---|---|---|
alpha : Number
An optional alpha value that can be applied to the 3d object. | Object3D | ||
animationLibrary : AnimationLibrary
Reference container for all animations used in the container. | Object3D | ||
aperture : Number
Used in DofSprite3D. | Camera3D | ||
blendMode : String
An optional blend mode that can be applied to the 3d object. | Object3D | ||
boundingRadius : Number [read-only]
Returns the bounding radius of the 3d object
| Object3D | ||
collider : Boolean
Indicates whether this object is used for collision detection. | Object3D | ||
debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object. | Object3D | ||
debugBoundingBox : WireCube [read-only] | Object3D | ||
debugBoundingSphere : WireSphere [read-only] | Object3D | ||
debugbs : 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 | ||
dof : Boolean
Used in DofSprite3D. | Camera3D | ||
doflevels : Number = 16
Used in DofSprite3D. | Camera3D | ||
eulers : Vector3D
Defines the rotation of the 3d object as a Vector3D object containing euler angles for rotation around x, y and z axis. | Object3D | ||
extra : Object
An optional untyped object that can contain used-defined properties
| Object3D | ||
filters : Array
An optional array of filters that can be applied to the 3d object. | Object3D | ||
fixedZoom : Boolean | Camera3D | ||
focus : Number
A divisor value for the perspective depth of the view. | Camera3D | ||
fov : Number
Defines the field of view of the camera in a vertical direction. | Camera3D | ||
geometryLibrary : GeometryLibrary
Reference container for all geometries used in the container. | Object3D | ||
id : int [read-only] | Object3D | ||
inverseSceneTransform : Matrix3D
Returns the inverse of sceneTransform. | Object3D | ||
invViewMatrix : Matrix3D | Camera3D | ||
lens : AbstractLens
Defines a lens object used in vertex projection
| Camera3D | ||
materialLibrary : MaterialLibrary
Reference container for all materials used in the container. | Object3D | ||
maxblur : Number = 150
Used in DofSprite3D. | Camera3D | ||
maxPanAngle : Number = Infinity
Maximum bounds for the panAngle. | HoverCamera3D | ||
maxTiltAngle : Number = 90
Maximum bounds for the tiltAngle. | HoverCamera3D | ||
maxX : Number [read-only]
Returns the maximum x value of the 3d object
| Object3D | ||
maxY : Number [read-only]
Returns the maximum y value of the 3d object
| Object3D | ||
maxZ : Number [read-only]
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 | ||
minX : Number [read-only]
Returns the minimum x value of the 3d object
| Object3D | ||
minY : Number [read-only]
Returns the minimum y value of the 3d object
| Object3D | ||
minZ : Number [read-only]
Returns the minimum z value of the 3d object
| Object3D | ||
mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
| Object3D | ||
name : String
An optional name string for the 3d object. | Object3D | ||
objectDepth : Number [read-only]
Boundary depth of the 3d object
return The depth of the mesh
| Object3D | ||
objectHeight : Number [read-only]
Boundary height of the 3d object
return The height of the mesh
| Object3D | ||
objectWidth : Number [read-only]
Boundary width of the 3d object
return The width of the object
| Object3D | ||
ownCanvas : Boolean
Defines whether the contents of the 3d object are rendered using it's own render session
| Object3D | ||
ownSession : 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 | ||
parent : ObjectContainer3D [override]
Cannot parent a TargetCamera3D object. | TargetCamera3D | ||
pivotPoint : Vector3D
Defines the local point around which the object rotates. | Object3D | ||
pivotZero : Boolean [read-only] | Object3D | ||
position : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
pushback : Boolean
Elements use their furthest point from the camera when z-sorting
| Object3D | ||
pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
| Object3D | ||
renderer : Renderer
An optional renderer object that can be used to render the contents of the object. | Object3D | ||
rotationX : 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 | ||
rotationY : 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 | ||
rotationZ : 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 | ||
scaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates. | Object3D | ||
scaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates. | Object3D | ||
scaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates. | Object3D | ||
scene : Scene3D [read-only]
Returns the parent scene of the 3d object
| Object3D | ||
scenePivotPoint : Vector3D [read-only] | Object3D | ||
scenePosition : Vector3D [read-only]
Returns the position of the 3d object, relative to the global coordinates of the Scene3D object. | Object3D | ||
sceneTransform : Matrix3D [read-only]
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D object. | Object3D | ||
screenXOffset : Number
Defines an additional offset to the x coordinate used on mesh elements or objects with ownCanvas set to true
| Object3D | ||
screenYOffset : Number
Defines an additional offset to the y coordinate used on mesh elements or objects with ownCanvas set to true
| Object3D | ||
screenZOffset : Number
Defines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true
| Object3D | ||
session : AbstractSession [read-only]
The render session used by the 3d object
| Object3D | ||
steps : Number = 8
Fractional step taken each time the hover() method is called. | HoverCamera3D | ||
target : Object3D
The 3d object targeted by the camera. | TargetCamera3D | ||
tiltAngle : Number = 90
Elevation angle of the camera in degrees. | HoverCamera3D | ||
transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object. | Object3D | ||
view : View3D | Camera3D | ||
viewMatrix : Matrix3D [override] [read-only]
Returns the transformation matrix used to resolve the scene to the view. | TargetCamera3D | ||
visible : 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 | ||
x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
y : 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 | ||
z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
zoom : Number
Provides an overall scale value to the view
| Camera3D |
Method | Defined By | ||
---|---|---|---|
HoverCamera3D(init:Object = null)
Creates a new HoverCamera3D object. | HoverCamera3D | ||
addOnCameraUpdate(listener:Function):void
Default method for adding a cameraUpdated event listener
| Camera3D | ||
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
| Object3D | ||
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
| Object3D | ||
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
| Object3D | ||
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
| Object3D | ||
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
| Object3D | ||
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
| Object3D | ||
addOnPositionChange(listener:Function):void
Default method for adding a positionchanged event listener
| Object3D | ||
addOnRollOut(listener:Function):void
Default method for adding a rollOut3D event listener
| Object3D | ||
addOnRollOver(listener:Function):void
Default method for adding a rollOver3D event listener
| Object3D | ||
addOnScaleChange(listener:Function):void
Default method for adding a scalechanged event listener
| Object3D | ||
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
| Object3D | ||
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
| Object3D | ||
addOnSessionChange(listener:Function):void
Default method for adding a sessionchanged event listener
| Object3D | ||
addOnVisibilityUpdate(listener:Function):void
Default method for adding a visibilityUpdated event listener
| Object3D | ||
applyPosition(dx:Number, dy:Number, dz:Number):void
Apply the given position to the object without altering the apperance of child objects
| Object3D | ||
applyRotations():void
Apply the local rotations to the object without altering the apperance of child objects
| Object3D | ||
centerPivot():void
Adjusts the pivot point of the object so that it lies at the center of it's geoemtry. | Object3D | ||
[override]
Duplicates the camera's properties to another Camera3D object. | Camera3D | ||
disableDof():void
Used in DofSprite3D
| Camera3D | ||
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
| Object3D | ||
enableDof():void
Used in DofSprite3D. | Camera3D | ||
hover(jumpTo:Boolean = false):Boolean
Updates the current tilt angle and pan angle values. | HoverCamera3D | ||
lookAt(target:Vector3D, upAxis:Vector3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
| Object3D | ||
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
| Object3D | ||
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
| Object3D | ||
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
| Object3D | ||
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates. | Object3D | ||
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
| Object3D | ||
moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
| Object3D | ||
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
| Object3D | ||
pan(angle:Number):void
Rotates the camera in its horizontal plane. | Camera3D | ||
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
| Object3D | ||
removeOnCameraUpdate(listener:Function):void
Default method for removing a cameraUpdated event listener
| Camera3D | ||
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
| Object3D | ||
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
| Object3D | ||
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
| Object3D | ||
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
| Object3D | ||
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
| Object3D | ||
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
| Object3D | ||
removeOnPositionChange(listener:Function):void
Default method for removing a positionchanged event listener
| Object3D | ||
removeOnRollOut(listener:Function):void
Default method for removing a rollOut3D event listener
| Object3D | ||
removeOnRollOver(listener:Function):void
Default method for removing a rollOver3D event listener
| Object3D | ||
removeOnScaleChange(listener:Function):void
Default method for removing a scalechanged event listener
| Object3D | ||
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
| Object3D | ||
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
| Object3D | ||
removeOnSessionChange(listener:Function):void
Default method for removing a sessionchanged event listener
| Object3D | ||
removeOnVisibilityUpdate(listener:Function):void
Default method for removing a visibilityUpdated event listener
| Object3D | ||
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | ||
rotate(axis:Vector3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
| Object3D | ||
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
| Object3D | ||
scale(scale:Number):void
Scales the contents of the 3d object. | Object3D | ||
Returns a ScreenVertex object describing the resolved x and y position of the given Vertex object. | Camera3D | ||
tick(time:int):void
Called by the TickTraverser. | Object3D | ||
tilt(angle:Number):void
Rotates the camera in its vertical plane. | Camera3D | ||
toString():String [override]
Used to trace the values of a 3d object. | Object3D | ||
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
| Object3D | ||
Used when traversing the scenegraph
| Object3D | ||
unproject(mX:Number, mY:Number):Vector3D | Camera3D | ||
update():void
Updates the transformation matrix used to resolve the scene to the view. | Camera3D | ||
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
_currentPanAngle | property |
arcane var _currentPanAngle:Number = 0
_currentTiltAngle | property |
arcane var _currentTiltAngle:Number = 90
distance | property |
public var distance:Number = 800
Distance between the camera and the specified target. Defaults to 800.
maxPanAngle | property |
public var maxPanAngle:Number = Infinity
Maximum bounds for the panAngle
. Defaults to Infinity.
See also
maxTiltAngle | property |
public var maxTiltAngle:Number = 90
Maximum bounds for the tiltAngle
. Defaults to 90.
See also
minPanAngle | property |
public var minPanAngle:Number
Minimum bounds for the panAngle
. Defaults to -Infinity.
See also
minTiltAngle | property |
public var minTiltAngle:Number = -90
Minimum bounds for the tiltAngle
. Defaults to -90.
See also
panAngle | property |
public var panAngle:Number = 0
Rotation of the camera in degrees around the y axis. Defaults to 0.
steps | property |
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
tiltAngle | property |
public var tiltAngle:Number = 90
Elevation angle of the camera in degrees. Defaults to 90.
wrapPanAngle | property |
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.
yfactor | property |
public var yfactor:Number = 2
Fractional difference in distance between the horizontal camera orientation and vertical camera orientation. Defaults to 2.
See also
HoverCamera3D | () | Constructor |
public function HoverCamera3D(init:Object = null)
Creates a new HoverCamera3D
object.
init:Object (default = null ) — [optional] An initialisation object for specifying default instance properties.
|
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 )
|
Boolean — True if the camera position was updated, otherwise false.
|
See also