| Package | away3d.cameras |
| Class | public class SpringCam |
| Inheritance | SpringCam  Camera3D Object3D flash.events.EventDispatcher |
| Package | away3d.cameras |
| Class | public class SpringCam |
| Inheritance | SpringCam Camera3D Object3D flash.events.EventDispatcher |
| 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
Returns the bounding radius of the 3d object
| Object3D | |
| center : Array | Object3D | |
| collider : Boolean
Indicates whether this object is used for collision detection.
| Object3D | |
| damping : Number = 4
Damping is the spring internal friction, or how much it resists the "boinggggg" effect.
| SpringCam | ||
| debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
| Object3D | |
| debugBoundingBox : WireCube | Object3D | |
| debugBoundingSphere : WireSphere | Object3D | |
| debugbs : Boolean
Indicates whether a debug bounding sphere should be rendered around the 3d object.
| Object3D | |
| dof : Boolean
Used in
DofSprite3D. | Camera3D | |
| doflevels : Number = 16
Used in
DofSprite3D. | Camera3D | |
| eulers : Number3D
Defines the rotation of the 3d object as a
Number3D 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 | Object3D | |
| inverseSceneTransform : MatrixAway3D
Returns the inverse of sceneTransform.
| Object3D | |
| invViewMatrix : MatrixAway3D | Camera3D | |
| lens : AbstractLens
Defines a lens object used in vertex projection
| Camera3D | |
| lightarray : ILightConsumer
returns the array of lights contained inside the container.
| Object3D | |
| lookOffset : Number3D
offset of facing in target object space, ie: where in the target object space should the camera look.
| SpringCam | ||
| mass : Number = 40
Mass of the camera, if over 120 and it'll be very heavy to move.
| SpringCam | ||
| materialLibrary : MaterialLibrary
Reference container for all materials used in the container.
| Object3D | |
| maxblur : Number = 150
Used in
DofSprite3D. | Camera3D | |
| maxX : Number
Returns the maximum x value of the 3d object
| Object3D | |
| maxY : Number
Returns the maximum y value of the 3d object
| Object3D | |
| maxZ : Number
Returns the maximum z value of the 3d object
| Object3D | |
| minX : Number
Returns the minimum x value of the 3d object
| Object3D | |
| minY : Number
Returns the minimum y value of the 3d object
| Object3D | |
| minZ : Number
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
Boundary depth of the 3d object
return The depth of the mesh
| Object3D | |
| objectHeight : Number
Boundary height of the 3d object
return The height of the mesh
| Object3D | |
| objectWidth : Number
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 | |
| ownLights : Boolean
Defines whether the children of the container are rendered using it's own lights.
| Object3D | |
| ownSession : AbstractRenderSession
Defines a unique render session for the 3d object.
| Object3D | |
| parent : ObjectContainer3D
Defines the parent of the 3d object.
| Object3D | |
| pivotPoint : Number3D
Defines the local point around which the object rotates.
| Object3D | |
| pivotZero : Boolean | Object3D | |
| position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D. | Object3D | |
| positionOffset : Number3D
Offset of spring center from target in target object space, ie: Where the camera should ideally be in the target object space.
| SpringCam | ||
| projectorType : String | 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 : IPrimitiveConsumer
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
Returns the parent scene of the 3d object
| Object3D | |
| scenePivotPoint : Number3D | Object3D | |
| scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the
Scene3D object. | Object3D | |
| sceneTransform : MatrixAway3D
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 : AbstractRenderSession
The render session used by the 3d object
| Object3D | |
| stiffness : Number = 1
Stiffness of the spring, how hard is it to extend.
| SpringCam | ||
| target : Object3D
[optional] Target object3d that camera should follow.
| SpringCam | ||
| transform : MatrixAway3D
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
[read-only]
| SpringCam | ||
| viewMatrix : MatrixAway3D
Returns the transformation matrix used to resolve the scene to the view.
| Camera3D | |
| visible : Boolean
Defines whether the 3d object is visible in the scene
| Object3D | |
| 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 | |
| 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 | |
| zrot : Number | SpringCam | ||
| Method | Defined by | ||
|---|---|---|---|
|
SpringCam
(init:Object = null) | SpringCam | ||
|
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 | |
|
addOnParentUpdate(listener:Function):void
Default method for adding a parentupdated 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 | |
|
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 | |
|
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged 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 | |
|
Duplicates the camera's properties to another
Camera3D object. | Camera3D | |
|
disableDof():void
Used in
DofSprite3D
| Camera3D | |
|
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 | |
|
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 | |
|
removeOnParentUpdate(listener:Function):void
Default method for removing a parentupdated 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 | |
|
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 | |
|
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
| Object3D | |
|
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | |
|
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
Used to trace the values of a 3d object.
| Object3D | |
|
Moves the 3d object along a vector by a defined length
| Object3D | |
|
Used when traversing the scenegraph
| Object3D | |
| Camera3D | ||
|
update():void
Updates the transformation matrix used to resolve the scene to the view.
| Camera3D | |
|
updateObject():void
| Object3D | |
|
updateSession():void
| Object3D | |
|
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D | |
| damping | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var damping:Number = 4
Damping is the spring internal friction, or how much it resists the "boinggggg" effect. Too high and you'll lose it! A number between 1 and 20 is recommended.
| lookOffset | property |
public var lookOffset:Number3D
offset of facing in target object space, ie: where in the target object space should the camera look.
| mass | property |
public var mass:Number = 40
Mass of the camera, if over 120 and it'll be very heavy to move.
| positionOffset | property |
public var positionOffset:Number3D
Offset of spring center from target in target object space, ie: Where the camera should ideally be in the target object space.
| stiffness | property |
public var stiffness:Number = 1
Stiffness of the spring, how hard is it to extend. The higher it is, the more "fixed" the cam will be. A number between 1 and 20 is recommended.
| target | property |
public var target:Object3D
[optional] Target object3d that camera should follow. If target is null, camera behaves just like a normal Camera3D.
| view | property |
| zrot | property |
zrot:Number [read-write]Implementation
public function get zrot():Number
public function set zrot(value:Number):void
| SpringCam | () | constructor |
public function SpringCam(init:Object = null)Parameters
init:Object (default = null) |