org.papervision3d.cameras.SpringCamera3D

Public Properties

	Property		Defined by
		alpha : Number = 1	DisplayObject3D
		autoCalcScreenCoords : Boolean	DisplayObject3D
		blendMode : String = "normal"	DisplayObject3D
		_camTarget : DisplayObject3D [optional] Target object3d that camera should follow.	SpringCamera3D
		children : Object Returns the children object.	DisplayObjectContainer3D
		container : ViewportLayer	DisplayObject3D
		culled : Boolean [internal use] Is this object culled by camera frustum?	DisplayObject3D
		culler : IObjectCuller	CameraObject3D
		cullTest : Number = 0	DisplayObject3D
		damping : Number = 4 Damping is the spring internal friction, or how much it resists the "boinggggg" effect.	SpringCamera3D
		DEFAULT_POS : Number3D [static] The default position for new cameras.	CameraObject3D
		DEFAULT_UP : Number3D [static] The default UP vector for new cameras.	CameraObject3D
		DEFAULT_VIEWPORT : Rectangle [static] The default viewport for new cameras.	CameraObject3D
		extra : Object An object that contains user defined properties.	DisplayObject3D
		eye : Matrix3D	CameraObject3D
		faceLevelMode : Boolean [static] This allows objects faces to have their own containers.	DisplayObject3D
		faces : Array [internal-use]	DisplayObject3D
		far : Number Sets the distance to the far plane.	Camera3D
		filters : Array	DisplayObject3D
		flipLightDirection : Boolean = false	DisplayObject3D
		focus : Number This value is a positive number representing the distance of the observer from the front clipping plane, which is the closest any object can be to the camera.	CameraObject3D
		fov : Number Gets the vertical Field Of View in degrees.	CameraObject3D
		frustumTestMethod : int = 0	DisplayObject3D
		geometry : GeometryObject3D The GeometryObject3D object that contains the 3D definition of this instance.	DisplayObject3D
		id : int [read-only] Unique id of this instance.	DisplayObject3D
		localRotationX : Number	DisplayObject3D
		localRotationY : Number	DisplayObject3D
		localRotationZ : Number	DisplayObject3D
		lookOffset : Number3D offset of facing in target object space, ie: where in the target object space should the camera look.	SpringCamera3D
		mass : Number = 40 Mass of the camera, if over 120 and it'll be very heavy to move.	SpringCamera3D
		material : MaterialObject3D	DisplayObject3D
		materials : MaterialsList The list of materials for this instance.	DisplayObject3D
		meshSort : uint = 1 tells Mesh3D's render() method to compare the measurement choice of the user for a triangle's sorting	DisplayObject3D
		name : String An optional object name.	DisplayObject3D
		near : Number Sets the distance to the near plane (note that this is simply an alias for #focus).	Camera3D
		numChildren : int Returns the number of children of this object.	DisplayObjectContainer3D
		ortho : Boolean Whether the camera uses orthographic projection.	CameraObject3D
		orthoScale : Number Sets the orthographic scale of the camera	Camera3D
		parent : DisplayObjectContainer3D [read-only] Indicates the DisplayObjectContainer3D object that contains this display object.	DisplayObject3D
		parentContainer : DisplayObject3D	DisplayObject3D
		position : Number3D A Number3D containing the current x, y, and z of the DisplayObject3D	DisplayObject3D
		positionOffset : Number3D Offset of spring center from target in target object space, ie: Where the camera should ideally be in the target object space.	SpringCamera3D
		root : DisplayObjectContainer3D [read-only] [read-only] The scene, which is the top-most displayObjectContainer3D in the tree structure.	DisplayObjectContainer3D
		rotationX : Number Specifies the rotation around the X axis from its original orientation.	DisplayObject3D
		rotationY : Number Specifies the rotation around the Y axis from its original orientation.	DisplayObject3D
		rotationZ : Number Specifies the rotation around the Z axis from its original orientation.	DisplayObject3D
		scale : Number Sets the 3D scale as applied from the registration point of the object.	DisplayObject3D
		scaleX : Number Sets the scale along the local X axis as applied from the registration point of the object.	DisplayObject3D
		scaleY : Number Sets the scale along the local Y axis as applied from the registration point of the object.	DisplayObject3D
		scaleZ : Number Sets the scale along the local Z axis as applied from the registration point of the object.	DisplayObject3D
		scene : SceneObject3D	DisplayObject3D
		sceneX : Number The X coordinate of a object relative to the scene coordinate system.	DisplayObject3D
		sceneY : Number The Y coordinate of a object relative to the scene coordinate system.	DisplayObject3D
		sceneZ : Number The Z coordinate of a object relative to the scene coordinate system.	DisplayObject3D
		screen : Number3D [read-only] The coordinate of the object on screen.	DisplayObject3D
		screenZ : Number [internal-use] The average depth of the object faces center.	DisplayObject3D
		sort : Boolean A Boolean value that determines whether the 3D objects are z-depth sorted between themselves when rendering.	CameraObject3D
		sortedArray : Array [static]	DisplayObject3D
		stiffness : Number = 1 Stiffness of the spring, how hard is it to extend.	SpringCamera3D
		target : DisplayObject3D	SpringCamera3D
		testQuad : Boolean = true	DisplayObject3D
		transform : Matrix3D A Matrix3D object containing values that affect the scaling, rotation, and translation of the display object.	DisplayObject3D
		useClipping : Boolean = true	DisplayObject3D
		useCulling : Boolean Whether this camera uses frustum culling.	Camera3D
		useOwnContainer : Boolean	DisplayObject3D
		useProjectionMatrix : Boolean Whether this camera uses a projection matrix.	Camera3D
		userData : UserData	DisplayObject3D
		view : Matrix3D [internal-use] A camera transformed Matrix3D object.	DisplayObject3D
		viewport : Rectangle	CameraObject3D
		visible : Boolean Whether or not the display object is visible.	DisplayObject3D
		world : Matrix3D World transformation.	DisplayObject3D
		x : Number An Number that sets the X coordinate of a object relative to the origin of its parent.	DisplayObject3D
		y : Number An Number that sets the Y coordinate of a object relative to the origin of its parent.	DisplayObject3D
		yUP : Boolean	CameraObject3D
		z : Number An Number that sets the Z coordinate of a object relative to the origin of its parent.	DisplayObject3D
		ZERO : DisplayObject3D [static] Returns an empty DiplayObject3D object positioned in the center of the 3D coordinate system (0, 0 ,0).	DisplayObject3D
		zoom : Number This value specifies the scale at which the 3D objects are rendered.	CameraObject3D
		zrot : Number	SpringCamera3D

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined by
		_children : Dictionary [internal-use] Names indexed by children.	DisplayObjectContainer3D
		_childrenByName : Object [internal-use] Children indexed by name.	DisplayObjectContainer3D
		_far : Number	CameraObject3D
		_focusFix : Matrix3D	Camera3D
		_ortho : Boolean	CameraObject3D
		_orthoScale : Number = 1	CameraObject3D
		_orthoScaleMatrix : Matrix3D	CameraObject3D
		_prevFocus : Number	Camera3D
		_prevHeight : Number	Camera3D
		_prevOrtho : Boolean	Camera3D
		_prevOrthoProjection : Boolean	Camera3D
		_prevUseProjection : Boolean	Camera3D
		_prevWidth : Number	Camera3D
		_prevZoom : Number	Camera3D
		_projection : Matrix3D	Camera3D
		_scene : SceneObject3D = null The scene where the object belongs.	DisplayObject3D
		_sorted : Array	DisplayObject3D
		_target : DisplayObject3D	CameraObject3D
		_transformDirty : Boolean = false [internal-use]	DisplayObject3D
		_useCulling : Boolean	CameraObject3D
		_useOwnContainer : Boolean = false	DisplayObject3D
		_useProjectionMatrix : Boolean	CameraObject3D
		_userData : UserData	DisplayObject3D

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		SpringCamera3D(fov:Number = 60, near:Number = 10, far:Number = 5000, useCulling:Boolean = false, useProjection:Boolean = false) Constructor.	SpringCamera3D
		addChild(child:DisplayObject3D, name:String = null):DisplayObject3D Adds a child DisplayObject3D instance to this DisplayObjectContainer instance.	DisplayObject3D
		addChildren(parent:DisplayObject3D):DisplayObjectContainer3D Adds all the children of a DisplayObject3D instance to this DisplayObjectContainer instance.	DisplayObjectContainer3D
		addChildrenToLayer(do3d:DisplayObject3D, layer:ViewportLayer):void	DisplayObject3D
		addGeometry(geometry:GeometryObject3D = null):void Adds a geometry definition to the instance.	DisplayObject3D
		calculateScreenCoords(camera:CameraObject3D):void	DisplayObject3D
		childrenList():String Returns a string value with the list of objects.	DisplayObjectContainer3D
		clone():DisplayObject3D Clones this object.	DisplayObject3D
		copyPosition(reference:*):void Copies the position information (x, y and z coordinates) from another object or Matrix3D.	DisplayObject3D
		copyTransform(reference:*):void Copies the transformation information (position, rotation and scale) from another object or Matrix3D.	DisplayObject3D
		createOrthoMatrix(left:Number, right:Number, bottom:Number, top:Number, near:Number, far:Number):Matrix3D [static] Creates a transformation that produces a parallel projection.	Camera3D
		createPerspectiveMatrix(fov:Number, aspect:Number, near:Number, far:Number):Matrix3D [static] Creates a transformation that produces a perspective projection.	Camera3D
		createViewportLayer(viewport:Viewport3D, recurse:Boolean = true):ViewportLayer	DisplayObject3D
		distanceTo(obj:DisplayObject3D):Number Gets the distance to the position of the given object.	DisplayObject3D
		getChildByName(name:String, recursive:Boolean = false):DisplayObject3D Returns the child display object that exists with the specified name.	DisplayObjectContainer3D
		getMaterialByName(name:String):MaterialObject3D Returns the material that exists with the specified name in the materials list.	DisplayObject3D
		hitTestObject(obj:DisplayObject3D, multiplier:Number = 1):Boolean Evaluates the display object to see if it overlaps or intersects with the obj display object.	DisplayObject3D
		hitTestPoint(x:Number, y:Number, z:Number):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x, y and z parameters.	DisplayObject3D
		lookAt(targetObject:DisplayObject3D, upAxis:Number3D = null):void Lookat.	CameraObject3D
		materialsList():String Returns a string value with the list of material names of the materials list.	DisplayObject3D
		moveBackward(distance:Number):void Translate the display object in the opposite direction it is facing, i.e.	DisplayObject3D
		moveDown(distance:Number):void Translate the display object downwards, with respect to the direction it is facing, i.e.	DisplayObject3D
		moveForward(distance:Number):void Translate the display object in the direction it is facing, i.e.	DisplayObject3D
		moveLeft(distance:Number):void Translate the display object lateraly, to the left of the direction it is facing, i.e.	DisplayObject3D
		moveRight(distance:Number):void Translate the display object lateraly, to the right of the direction it is facing, i.e.	DisplayObject3D
		moveUp(distance:Number):void Translate the display object upwards, with respect to the direction it is facing, i.e.	DisplayObject3D
		orbit(pitch:Number, yaw:Number, useDegrees:Boolean = true, target:DisplayObject3D = null):void Orbits the camera around the specified target.	Camera3D
		pan(angle:Number):void Rotate the camera in its horizontal plane.	CameraObject3D
		pitch(angle:Number):void Rotate the display object around its lateral or transverse axis —an axis running from the pilot's left to right in piloted aircraft, and parallel to the wings of a winged aircraft; thus the nose pitches up and the tail down, or vice-versa.	DisplayObject3D
		project(parent:DisplayObject3D, renderSessionData:RenderSessionData):Number [internal-use] Projects three dimensional coordinates onto a two dimensional plane to simulate the relationship of the camera to subject.	DisplayObject3D
		projectFaces(faces:Array, object:DisplayObject3D, renderSessionData:RenderSessionData):Number	Camera3D
		projectVertices(vertices:Array, object:DisplayObject3D, renderSessionData:RenderSessionData):Number Projects vertices.	Camera3D
		removeChild(child:DisplayObject3D):DisplayObject3D Removes the specified child DisplayObject3D instance from the child list of the DisplayObjectContainer3D instance.	DisplayObjectContainer3D
		removeChildByName(name:String):DisplayObject3D Removes the child DisplayObject3D instance that exists with the specified name, from the child list of the DisplayObjectContainer3D instance.	DisplayObjectContainer3D
		replaceMaterialByName(material:MaterialObject3D, name:String):void Replaces a material by its name.	DisplayObject3D
		roll(angle:Number):void Rotate the display object around the longitudinal axis —an axis drawn through the body of the vehicle from tail to nose in the normal direction of flight, or the direction the object is facing.	DisplayObject3D
		setChildMaterial(child:DisplayObject3D, material:MaterialObject3D, existingMaterial:MaterialObject3D = null):void Sets the material for a child DisplayObject3D.	DisplayObject3D
		setChildMaterialByName(childName:String, material:MaterialObject3D):void Sets the material for a child DisplayObject3D by the child's name.	DisplayObject3D
		tilt(angle:Number):void Rotate the camera in its vertical plane.	CameraObject3D
		toString():String Returns a string value representing the three-dimensional position values of the display object instance.	DisplayObject3D
		transformView(transform:Matrix3D = null):void	SpringCamera3D
		translate(distance:Number, axis:Number3D):void Move the object along a given direction.	DisplayObject3D
		unproject(mX:Number, mY:Number):Number3D Unproject.	CameraObject3D
		update(viewport:Rectangle):void Updates the internal camera settings.	Camera3D
		updateTransform():void [internal-use] Updates the transform Matrix3D with the current rotation and scale values.	DisplayObject3D
		yaw(angle:Number):void Rotate the display object around about the vertical axis —an axis drawn from top to bottom.	DisplayObject3D

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		setParentContainer(parent:DisplayObject3D, assign:Boolean = true):void	DisplayObject3D

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined by
		MESH_SORT_CENTER : uint = 1 [static] tells Mesh3D's render() method to sort by measuring from the center of a triangle	DisplayObject3D
		MESH_SORT_CLOSE : uint = 3 [static] tells Mesh3D's render() method to sort by measuring from the closest point of a triangle	DisplayObject3D
		MESH_SORT_FAR : uint = 2 [static] tells Mesh3D's render() method to sort by measuring from the farthest point of a triangle	DisplayObject3D

Property detail

_camTarget

property

public var _camTarget:DisplayObject3D

[optional] Target object3d that camera should follow. If target is null, camera behaves just like a normal Camera3D.

damping

property

public 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

target:DisplayObject3D  [read-write]Implementation
    public function get target():DisplayObject3D
    public function set target(value:DisplayObject3D):void

zrot

property

zrot:Number  [read-write]Implementation
    public function get zrot():Number
    public function set zrot(value:Number):void

Constructor detail

SpringCamera3D

()

constructor

public function SpringCamera3D(fov:Number = 60, near:Number = 10, far:Number = 5000, useCulling:Boolean = false, useProjection:Boolean = false)

Constructor.

Parameters

	`fov:Number` (default = `60`) — fov This value is the vertical Field Of View (FOV) in degrees.

	`near:Number` (default = `10`) — near Distance to the near clipping plane.

	`far:Number` (default = `5000`) — far Distance to the far clipping plane.

	`useCulling:Boolean` (default = `false`) — useCulling Boolean indicating whether to use frustum culling. When true all objects outside the view will be culled.

	`useProjection:Boolean` (default = `false`) — useProjection Boolean indicating whether to use a projection matrix for perspective.

Method detail

transformView

()

method

public override function transformView(transform:Matrix3D = null):voidParameters

transform:Matrix3D (default = null)

http://blog.papervision3d.org

Papervision3D Official Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class SpringCamera3D	Properties \| Methods \| Constants

Package	org.papervision3d.cameras
Class	public class SpringCamera3D
Inheritance	SpringCamera3D Camera3D CameraObject3D DisplayObject3D DisplayObjectContainer3D flash.events.EventDispatcher