Package | away3d.core.base |
Class | public class Object3D |
Inheritance | Object3D NamedAssetBase flash.events.EventDispatcher |
Subclasses | ObjectContainer3D |
Property | Defined By | ||
---|---|---|---|
assetFullPath : Array [read-only] | NamedAssetBase | ||
assetNamespace : String [read-only] | NamedAssetBase | ||
backVector : Vector3D [read-only]
| Object3D | ||
downVector : Vector3D [read-only]
| Object3D | ||
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 object that can contain any extra data. | Object3D | ||
forwardVector : Vector3D [read-only]
| Object3D | ||
leftVector : Vector3D [read-only]
| Object3D | ||
name : String | NamedAssetBase | ||
originalName : String [read-only]
The original name used for this asset in the resource (e.g. | NamedAssetBase | ||
pivotPoint : Vector3D
Defines the local point around which the object rotates. | Object3D | ||
position : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
rightVector : Vector3D [read-only]
| 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 | ||
transform : Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
upVector : Vector3D [read-only]
| 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 |
Property | Defined By | ||
---|---|---|---|
_pivotPoint : Vector3D | Object3D | ||
_pivotZero : Boolean = true | Object3D | ||
_pos : Vector3D | Object3D | ||
_rot : Vector3D | Object3D | ||
_sca : Vector3D | Object3D | ||
_scaleX : Number = 1 | Object3D | ||
_scaleY : Number = 1 | Object3D | ||
_scaleZ : Number = 1 | Object3D | ||
_transform : Matrix3D | Object3D | ||
_transformComponents : Vector.<Vector3D> | Object3D | ||
_x : Number = 0 | Object3D | ||
_y : Number = 0 | Object3D | ||
_z : Number = 0 | Object3D |
Method | Defined By | ||
---|---|---|---|
Object3D()
Creates an Object3D object. | Object3D | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override] | Object3D | ||
assetPathEquals(name:String, ns:String):Boolean | NamedAssetBase | ||
Object3D | |||
dispose():void
Cleans up any resources used by the current object. | Object3D | ||
disposeAsset():void | Object3D | ||
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 | ||
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
| Object3D | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override] | Object3D | ||
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void | NamedAssetBase | ||
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(value:Number):void
Appends a uniform scale to the current transformation. | Object3D | ||
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
| Object3D | ||
translateLocal(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
| Object3D | ||
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
Method | Defined By | ||
---|---|---|---|
updateTransform():void | Object3D |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the position of the 3d object changes. | Object3D | |||
Dispatched when the rotation of the 3d object changes. | Object3D | |||
Dispatched when the scale of the 3d object changes. | Object3D |
_pivotPoint | property |
protected var _pivotPoint:Vector3D
_pivotZero | property |
protected var _pivotZero:Boolean = true
_pos | property |
protected var _pos:Vector3D
_rot | property |
protected var _rot:Vector3D
_sca | property |
protected var _sca:Vector3D
_scaleX | property |
protected var _scaleX:Number = 1
_scaleY | property |
protected var _scaleY:Number = 1
_scaleZ | property |
protected var _scaleZ:Number = 1
_transform | property |
protected var _transform:Matrix3D
_transformComponents | property |
protected var _transformComponents:Vector.<Vector3D>
_x | property |
protected var _x:Number = 0
_y | property |
protected var _y:Number = 0
_z | property |
protected var _z:Number = 0
backVector | property |
backVector:Vector3D
[read-only]
public function get backVector():Vector3D
downVector | property |
downVector:Vector3D
[read-only]
public function get downVector():Vector3D
eulers | property |
eulers:Vector3D
Defines the rotation of the 3d object as a Vector3D
object containing euler angles for rotation around x, y and z axis.
public function get eulers():Vector3D
public function set eulers(value:Vector3D):void
extra | property |
public var extra:Object
An object that can contain any extra data.
forwardVector | property |
forwardVector:Vector3D
[read-only]
public function get forwardVector():Vector3D
leftVector | property |
leftVector:Vector3D
[read-only]
public function get leftVector():Vector3D
pivotPoint | property |
pivotPoint:Vector3D
Defines the local point around which the object rotates.
public function get pivotPoint():Vector3D
public function set pivotPoint(value:Vector3D):void
position | property |
position:Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D
.
public function get position():Vector3D
public function set position(value:Vector3D):void
rightVector | property |
rightVector:Vector3D
[read-only]
public function get rightVector():Vector3D
rotationX | property |
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
.
public function get rotationX():Number
public function set rotationX(value:Number):void
rotationY | property |
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
.
public function get rotationY():Number
public function set rotationY(value:Number):void
rotationZ | property |
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
.
public function get rotationZ():Number
public function set rotationZ(value:Number):void
scaleX | property |
scaleX:Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates.
public function get scaleX():Number
public function set scaleX(value:Number):void
scaleY | property |
scaleY:Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates.
public function get scaleY():Number
public function set scaleY(value:Number):void
scaleZ | property |
scaleZ:Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates.
public function get scaleZ():Number
public function set scaleZ(value:Number):void
transform | property |
transform:Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D
.
public function get transform():Matrix3D
public function set transform(value:Matrix3D):void
upVector | property |
upVector:Vector3D
[read-only]
public function get upVector():Vector3D
x | property |
x:Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D
.
public function get x():Number
public function set x(value:Number):void
y | property |
y:Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D
.
public function get y():Number
public function set y(value:Number):void
z | property |
z:Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D
.
public function get z():Number
public function set z(value:Number):void
Object3D | () | Constructor |
public function Object3D()
Creates an Object3D object.
addEventListener | () | method |
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false )
| |
priority:int (default = 0 )
| |
useWeakReference:Boolean (default = false )
|
clone | () | method |
dispose | () | method |
public function dispose():void
Cleans up any resources used by the current object.
disposeAsset | () | method |
public function disposeAsset():void
invalidateTransform | () | method |
arcane function invalidateTransform():void
Invalidates the transformation matrix, causing it to be updated upon the next request
lookAt | () | method |
public function 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
.
Parameters
target:Vector3D — The vector defining the point to be looked at
| |
upAxis:Vector3D (default = null ) — An optional vector used to define the desired up orientation of the 3d object after rotation has occurred
|
moveBackward | () | method |
public function moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
Parameters
distance:Number — The length of the movement
|
moveDown | () | method |
public function moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
Parameters
distance:Number — The length of the movement
|
moveForward | () | method |
public function moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
Parameters
distance:Number — The length of the movement
|
moveLeft | () | method |
public function moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
Parameters
distance:Number — The length of the movement
|
movePivot | () | method |
public function movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates.
Parameters
dx:Number — The amount of movement along the local x axis.
| |
dy:Number — The amount of movement along the local y axis.
| |
dz:Number — The amount of movement along the local z axis.
|
moveRight | () | method |
public function moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
Parameters
distance:Number — The length of the movement
|
moveTo | () | method |
public function moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
Parameters
dx:Number — The amount of movement along the local x axis.
| |
dy:Number — The amount of movement along the local y axis.
| |
dz:Number — The amount of movement along the local z axis.
|
moveUp | () | method |
public function moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
Parameters
distance:Number — The length of the movement
|
pitch | () | method |
public function pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
Parameters
angle:Number — The amount of rotation in degrees
|
removeEventListener | () | method |
override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false )
|
roll | () | method |
public function roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Parameters
angle:Number — The amount of rotation in degrees
|
rotate | () | method |
public function rotate(axis:Vector3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
Parameters
axis:Vector3D — The vector defining the axis of rotation
| |
angle:Number — The amount of rotation in degrees
|
rotateTo | () | method |
public function rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
Parameters
ax:Number — The angle in degrees of the rotation around the x axis.
| |
ay:Number — The angle in degrees of the rotation around the y axis.
| |
az:Number — The angle in degrees of the rotation around the z axis.
|
scale | () | method |
public function scale(value:Number):void
Appends a uniform scale to the current transformation.
Parameters
value:Number — The amount by which to scale.
|
translate | () | method |
public function translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Parameters
axis:Vector3D — The vector defining the axis of movement
| |
distance:Number — The length of the movement
|
translateLocal | () | method |
public function translateLocal(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Parameters
axis:Vector3D — The vector defining the axis of movement
| |
distance:Number — The length of the movement
|
updateTransform | () | method |
protected function updateTransform():void
yaw | () | method |
public function yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Parameters
angle:Number — The amount of rotation in degrees
|
positionChanged | Event |
away3d.events.Object3DEvent
away3d.events.Object3DEvent
Dispatched when the position of the 3d object changes.
rotationChanged | Event |
away3d.events.Object3DEvent
away3d.events.Object3DEvent
Dispatched when the rotation of the 3d object changes.
scaleChanged | Event |
away3d.events.Object3DEvent
away3d.events.Object3DEvent
Dispatched when the scale of the 3d object changes.