Package | org.papervision3d.core.proto |
Class | public class CameraObject3D |
Inheritance | CameraObject3D ![]() ![]() ![]() |
Subclasses | Camera3D, FreeCamera3D |
Property | Defined by | ||
---|---|---|---|
![]() | children : Object
Returns the children object.
| DisplayObjectContainer3D | |
![]() | container : Sprite
The Sprite that you draw into when rendering in a MovieScene3D.
| DisplayObject3D | |
DEFAULT_POS : Number3D
[static]
The default position for new cameras.
| CameraObject3D | ||
![]() | extra : Object
An object that contains user defined properties.
| DisplayObject3D | |
![]() | faceLevelMode : Boolean [static]
This allows objects faces to have their own containers.
| DisplayObject3D | |
![]() | faces : Array
[internal-use]
| 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 | ||
![]() | geometry : GeometryObject3D
The GeometryObject3D object that contains the 3D definition of this instance.
| DisplayObject3D | |
![]() | id : int
[read-only] Unique id of this instance.
| DisplayObject3D | |
![]() | interactiveSceneManager : InteractiveSceneManager
If an InteractiveScene3D is used, this will DisplayObject3D will be registered with the InteractiveSceneManager
| DisplayObject3D | |
![]() | material : MaterialObject3D
The default material for the object instance.
| 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 | |
![]() | numChildren : int
Returns the number of children of this object.
| DisplayObjectContainer3D | |
![]() | parent : DisplayObjectContainer3D
[read-only] Indicates the DisplayObjectContainer3D object that contains this display object.
| DisplayObject3D | |
![]() | 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 | ||
![]() | transform : Matrix3D
A Matrix3D object containing values that affect the scaling, rotation, and translation of the display object.
| DisplayObject3D | |
![]() | view : Matrix3D
[internal-use] A camera transformed Matrix3D object.
| DisplayObject3D | |
![]() | 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 | |
![]() | 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 |
Method | Defined by | ||
---|---|---|---|
CameraObject3D(zoom:Number = 3, focus:Number = 500, initObject:Object = null)
The CameraObject3D constructor lets you create cameras for setting up the view from which a scene will be rendered.
| CameraObject3D | ||
![]() |
Adds a child DisplayObject3D instance to this DisplayObjectContainer instance.
| DisplayObject3D | |
![]() |
Adds all the children of a DisplayObject3D instance to this DisplayObjectContainer instance.
| DisplayObjectContainer3D | |
![]() |
addCollada(filename:String, materials:MaterialsList = null, scale:Number = 1):void
This method has been deprecated.
| DisplayObjectContainer3D | |
![]() |
addGeometry(geometry:GeometryObject3D = null):void
Adds a geometry definition to the instance.
| DisplayObject3D | |
![]() |
childrenList():String
Returns a string value with the list of objects.
| DisplayObjectContainer3D | |
![]() |
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 | |
![]() |
distanceTo(obj:DisplayObject3D):Number
Gets the distance to the position of the given object.
| DisplayObject3D | |
![]() |
getChildByName(name:String):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 | |
![]() |
Make the object look at a specific position.
| DisplayObject3D | |
![]() |
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 | |
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 | |
![]() |
[internal-use] Projects three dimensional coordinates onto a two dimensional plane to simulate the relationship of the camera to subject.
| 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 | |
![]() |
render(scene:SceneObject3D):void
[internal-use] Render the projected object.
| 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 | |
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
[internal-use] Transforms world coordinates into camera space.
| CameraObject3D | ||
![]() |
Move the object along a given direction.
| DisplayObject3D | |
![]() |
yaw(angle:Number):void
Rotate the display object around about the vertical axis —an axis drawn from top to bottom.
| DisplayObject3D |
DEFAULT_POS | property |
public static var DEFAULT_POS:Number3D
The default position for new cameras.
focus | property |
public var 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. Use it in conjunction with zoom.
Higher focus values tend to magnify distance between objects while allowing greater depth of field, as if the camera had a wider lenses. One result of using a wide angle lens in proximity to the subject is an apparent perspective distortion: parallel lines may appear to converge and with a fisheye lens, straight edges will appear to bend. Different lenses generally require a different camera to subject distance to preserve the size of a subject. Changing the angle of view can indirectly distort perspective, modifying the apparent relative size of the subject and foreground.sort | property |
public var sort:Boolean
A Boolean value that determines whether the 3D objects are z-depth sorted between themselves when rendering.
zoom | property |
public var zoom:Number
This value specifies the scale at which the 3D objects are rendered. Higher values magnify the scene, compressing distance. Use it in conjunction with focus.
CameraObject3D | () | constructor |
public function CameraObject3D(zoom:Number = 3, focus:Number = 500, initObject:Object = null)
The CameraObject3D constructor lets you create cameras for setting up the view from which a scene will be rendered. Its initial position can be specified in the initObject.
Parameterszoom:Number (default = 3 ) — This value specifies the scale at which the 3D objects are rendered. Higher values magnify the scene, compressing distance. Use it in conjunction with focus.
|
|
focus:Number (default = 500 ) — 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. Use it in conjunction with zoom.
|
|
initObject:Object (default = null ) — An optional object that contains user defined properties with which to populate the newly created DisplayObject3D.
It includes x, y, z, rotationX, rotationY, rotationZ, scaleX, scaleY scaleZ and a user defined extra object.
If extra is not an object, it is ignored. All properties of the extra field are copied into the new instance. The properties specified with extra are publicly available.
The following initObject property is also recognized by the constructor:
|
pan | () | method |
public function pan(angle:Number):void
Rotate the camera in its horizontal plane.
Panning the camera results in a motion similar to someone shaking their head "no". Parametersangle:Number — Angle to pan the camera.
|
tilt | () | method |
public function tilt(angle:Number):void
Rotate the camera in its vertical plane.
Tilting the camera results in a motion similar to someone nodding their head "yes". Parametersangle:Number — Angle to tilt the camera.
|
transformView | () | method |
public function transformView(transform:Matrix3D = null):void
[internal-use] Transforms world coordinates into camera space.
Parameterstransform:Matrix3D (default = null )
|