| Package | away3d.core.base |
| Class | public class Object3D |
| Inheritance | Object3D flash.events.EventDispatcher |
| Implements | IClonable |
| Subclasses | Camera3D, Mesh, Morpher, Sound3D |
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| materialLibrary : MaterialLibrary
Reference container for all materials used in the container. | Object3D | ||
| 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 | ||
| 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 | ||
| parent : ObjectContainer3D
Defines the parent of the 3d object. | Object3D | ||
| 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 | ||
| 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 | ||
| 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 | ||
| Property | Defined By | ||
|---|---|---|---|
| ini : Init
Instance of the Init object used to hold and parse default property values
specified by the initialiser object in the 3d object constructor. | Object3D | ||
| _pivotPoint : Vector3D | Object3D | ||
| Method | Defined By | ||
|---|---|---|---|
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 | ||
Duplicates the 3d object's properties to another Object3D object
| Object3D | ||
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
| 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 | ||
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 | ||
tick(time:int):void
Called by the TickTraverser. | Object3D | ||
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 | ||
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D | ||
| Method | Defined By | ||
|---|---|---|---|
updateDimensions():void | Object3D | ||
updateTransform():void | Object3D | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the contents of the 3d object updates. | Object3D | |||
| Dispatched when the bounding dimensions of the 3d object changes. | Object3D | |||
| Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object. | Object3D | |||
| Dispatched when a user moves the cursor while it is over the 3d object. | Object3D | |||
| Dispatched when a user moves the cursor away from the 3d object. | Object3D | |||
| Dispatched when a user moves the cursor over the 3d object. | Object3D | |||
| Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object. | Object3D | |||
| Dispatched when a user rolls out of the 3d object. | Object3D | |||
| Dispatched when a user rolls over the 3d object. | Object3D | |||
| Dispatched when the parent scene of the 3d object changes. | Object3D | |||
| Dispatched when the scene transform matrix of the 3d object changes. | Object3D | |||
| Dispatched when the render session property of the 3d object changes. | Object3D | |||
| Dispatched when the local transform matrix of the 3d object changes. | Object3D | |||
| _contentDirty | property |
arcane var _contentDirty:Boolean| _id | property |
arcane var _id:int| _pivotPoint | property |
protected var _pivotPoint:Vector3D| _rotationX | property |
arcane var _rotationX:Number = 0| _rotationY | property |
arcane var _rotationY:Number = 0| _rotationZ | property |
arcane var _rotationZ:Number = 0| _scaleX | property |
arcane var _scaleX:Number = 1| _scaleY | property |
arcane var _scaleY:Number = 1| _scaleZ | property |
arcane var _scaleZ:Number = 1| _scene | property |
arcane var _scene:Scene3D| _session | property |
arcane var _session:AbstractSession| alpha | property |
alpha:Number
An optional alpha value that can be applied to the 3d object.
Requires ownCanvas to be set to true.
public function get alpha():Number public function set alpha(value:Number):voidSee also
| animationLibrary | property |
public var animationLibrary:AnimationLibrary
Reference container for all animations used in the container. Populated in Collada parsers.
See also
| blendMode | property |
blendMode:String
An optional blend mode that can be applied to the 3d object.
Requires ownCanvas to be set to true.
public function get blendMode():String public function set blendMode(value:String):voidSee also
| boundingRadius | property |
boundingRadius:Number [read-only] Returns the bounding radius of the 3d object
public function get boundingRadius():Number| collider | property |
collider:BooleanIndicates whether this object is used for collision detection. Currently only used for dynamic objects in BSP trees.
public function get collider():Boolean public function set collider(value:Boolean):void| debugbb | property |
public var debugbb:BooleanIndicates whether a debug bounding box should be rendered around the 3d object.
| debugBoundingBox | property |
debugBoundingBox:WireCube [read-only] public function get debugBoundingBox():WireCube| debugBoundingSphere | property |
debugBoundingSphere:WireSphere [read-only] public function get debugBoundingSphere():WireSphere| debugbs | property |
public var debugbs:BooleanIndicates whether a debug bounding sphere should be rendered around the 3d object.
| 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:ObjectAn optional untyped object that can contain used-defined properties
| filters | property |
filters:Array
An optional array of filters that can be applied to the 3d object.
Requires ownCanvas to be set to true.
public function get filters():Array public function set filters(value:Array):voidSee also
| geometryLibrary | property |
public var geometryLibrary:GeometryLibrary
Reference container for all geometries used in the container. Populated in Collada and Max3DS parsers.
See also
| id | property |
id:int [read-only] public function get id():int| ini | property |
protected var ini:InitInstance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
| inverseSceneTransform | property |
public var inverseSceneTransform:Matrix3DReturns the inverse of sceneTransform.
See also
| materialLibrary | property |
public var materialLibrary:MaterialLibrary
Reference container for all materials used in the container. Populated in Collada, Max3DS and Obj parsers.
See also
| maxX | property |
maxX:Number [read-only] Returns the maximum x value of the 3d object
public function get maxX():NumberSee also
| maxY | property |
maxY:Number [read-only] Returns the maximum y value of the 3d object
public function get maxY():NumberSee also
| maxZ | property |
maxZ:Number [read-only] Returns the maximum z value of the 3d object
public function get maxZ():NumberSee also
| minX | property |
minX:Number [read-only] Returns the minimum x value of the 3d object
public function get minX():NumberSee also
| minY | property |
minY:Number [read-only] Returns the minimum y value of the 3d object
public function get minY():NumberSee also
| minZ | property |
minZ:Number [read-only] Returns the minimum z value of the 3d object
public function get minZ():NumberSee also
| mouseEnabled | property |
public var mouseEnabled:Boolean = trueDefines whether mouse events are received on the 3d object
| name | property |
public var name:String
An optional name string for the 3d object.
Can be used to access specific 3d object in a scene by calling the getChildByName method on the parent ObjectContainer3D.
See also
| objectDepth | property |
objectDepth:Number [read-only] Boundary depth of the 3d object return The depth of the mesh
public function get objectDepth():Number| objectHeight | property |
objectHeight:Number [read-only] Boundary height of the 3d object return The height of the mesh
public function get objectHeight():Number| objectWidth | property |
objectWidth:Number [read-only] Boundary width of the 3d object return The width of the object
public function get objectWidth():Number| ownCanvas | property |
ownCanvas:BooleanDefines whether the contents of the 3d object are rendered using it's own render session
public function get ownCanvas():Boolean public function set ownCanvas(value:Boolean):void| ownSession | property |
ownSession:AbstractSessionDefines a unique render session for the 3d object.
public function get ownSession():AbstractSession public function set ownSession(value:AbstractSession):void| parent | property |
parent:ObjectContainer3DDefines the parent of the 3d object.
public function get parent():ObjectContainer3D public function set parent(value:ObjectContainer3D):void| pivotPoint | property |
pivotPoint:Vector3DDefines the local point around which the object rotates.
public function get pivotPoint():Vector3D public function set pivotPoint(value:Vector3D):void| pivotZero | property |
pivotZero:Boolean [read-only] public function get pivotZero():Boolean| 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| pushback | property |
public var pushback:BooleanElements use their furthest point from the camera when z-sorting
| pushfront | property |
public var pushfront:BooleanElements use their nearest point to the camera when z-sorting
| renderer | property |
renderer:Renderer
An optional renderer object that can be used to render the contents of the object.
Requires ownCanvas to be set to true.
public function get renderer():Renderer public function set renderer(value:Renderer):voidSee also
| 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:NumberDefines 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:NumberDefines 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:NumberDefines 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| scene | property |
scene:Scene3D [read-only] Returns the parent scene of the 3d object
public function get scene():Scene3D| scenePivotPoint | property |
scenePivotPoint:Vector3D [read-only] public function get scenePivotPoint():Vector3D| scenePosition | property |
scenePosition:Vector3D [read-only]
Returns the position of the 3d object, relative to the global coordinates of the Scene3D object.
public function get scenePosition():Vector3D| sceneTransform | property |
sceneTransform:Matrix3D [read-only]
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D object.
public function get sceneTransform():Matrix3D| screenXOffset | property |
public var screenXOffset:NumberDefines an additional offset to the x coordinate used on mesh elements or objects with ownCanvas set to true
| screenYOffset | property |
public var screenYOffset:NumberDefines an additional offset to the y coordinate used on mesh elements or objects with ownCanvas set to true
| screenZOffset | property |
public var screenZOffset:NumberDefines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true
| session | property |
session:AbstractSession [read-only] The render session used by the 3d object
public function get session():AbstractSession| transform | property |
transform:Matrix3D
Defines 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| useHandCursor | property |
public var useHandCursor:Boolean = falseDefines whether a hand cursor is displayed when the mouse rolls over the 3d object.
| visible | property |
visible:BooleanDefines whether the 3d object is visible in the scene
public function get visible():Boolean public function set visible(value:Boolean):void| 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| addOnDimensionsChange | () | method |
public function addOnDimensionsChange(listener:Function):voidDefault method for adding a dimensionschanged event listener
Parameters
listener:Function — The listener function
|
| addOnMouseDown | () | method |
public function addOnMouseDown(listener:Function):voidDefault method for adding a mouseDown3D event listener
Parameters
listener:Function — The listener function
|
| addOnMouseMove | () | method |
public function addOnMouseMove(listener:Function):voidDefault method for adding a mouseMove3D event listener
Parameters
listener:Function — The listener function
|
| addOnMouseOut | () | method |
public function addOnMouseOut(listener:Function):voidDefault method for adding a mouseOut3D event listener
Parameters
listener:Function — The listener function
|
| addOnMouseOver | () | method |
public function addOnMouseOver(listener:Function):voidDefault method for adding a mouseOver3D event listener
Parameters
listener:Function — The listener function
|
| addOnMouseUp | () | method |
public function addOnMouseUp(listener:Function):voidDefault method for adding a mouseUp3D event listener
Parameters
listener:Function — The listener function
|
| addOnPositionChange | () | method |
public function addOnPositionChange(listener:Function):voidDefault method for adding a positionchanged event listener
Parameters
listener:Function — The listener function
|
| addOnRollOut | () | method |
public function addOnRollOut(listener:Function):voidDefault method for adding a rollOut3D event listener
Parameters
listener:Function — The listener function
|
| addOnRollOver | () | method |
public function addOnRollOver(listener:Function):voidDefault method for adding a rollOver3D event listener
Parameters
listener:Function — The listener function
|
| addOnScaleChange | () | method |
public function addOnScaleChange(listener:Function):voidDefault method for adding a scalechanged event listener
Parameters
listener:Function — The listener function
|
| addOnSceneChange | () | method |
public function addOnSceneChange(listener:Function):voidDefault method for adding a scenechanged event listener
Parameters
listener:Function — The listener function
|
| addOnSceneTransformChange | () | method |
public function addOnSceneTransformChange(listener:Function):voidDefault method for adding a scenetransformchanged event listener
Parameters
listener:Function — The listener function
|
| addOnSessionChange | () | method |
public function addOnSessionChange(listener:Function):voidDefault method for adding a sessionchanged event listener
Parameters
listener:Function — The listener function
|
| addOnVisibilityUpdate | () | method |
public function addOnVisibilityUpdate(listener:Function):voidDefault method for adding a visibilityUpdated event listener
Parameters
listener:Function — The listener function
|
| applyPosition | () | method |
public function applyPosition(dx:Number, dy:Number, dz:Number):voidApply the given position to the object without altering the apperance of child objects
Parameters
dx:Number | |
dy:Number | |
dz:Number |
| applyRotations | () | method |
public function applyRotations():voidApply the local rotations to the object without altering the apperance of child objects
| centerPivot | () | method |
public function centerPivot():voidAdjusts the pivot point of the object so that it lies at the center of it's geoemtry.
| clone | () | method |
public function clone(object:Object3D = null):Object3D
Duplicates the 3d object's properties to another Object3D object
Parameters
object:Object3D (default = null) — [optional] The new object instance into which all properties are copied
|
Object3D — The new object instance with duplicated properties applied
|
| distanceTo | () | method |
public function distanceTo(obj:Object3D):NumberCalulates the absolute distance between the local 3d object position and the position of the given 3d object
Parameters
obj:Object3D — The 3d object to use for calulating the distance
|
Number — The scalar distance between objects
|
See also
| 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):voidMoves 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):voidMoves 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):voidMoves 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):voidMoves 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):voidMoves 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):voidMoves 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):voidMoves 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):voidMoves 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):voidRotates the 3d object around it's local x-axis
Parameters
angle:Number — The amount of rotation in degrees
|
| removeOnDimensionsChange | () | method |
public function removeOnDimensionsChange(listener:Function):voidDefault method for removing a dimensionschanged event listener
Parameters
listener:Function — The listener function
|
| removeOnMouseDown | () | method |
public function removeOnMouseDown(listener:Function):voidDefault method for removing a mouseDown3D event listener
Parameters
listener:Function — The listener function
|
| removeOnMouseMove | () | method |
public function removeOnMouseMove(listener:Function):voidDefault method for removing a mouseMove3D event listener
Parameters
listener:Function — The listener function
|
| removeOnMouseOut | () | method |
public function removeOnMouseOut(listener:Function):voidDefault method for removing a mouseOut3D event listener
Parameters
listener:Function — The listener function
|
| removeOnMouseOver | () | method |
public function removeOnMouseOver(listener:Function):voidDefault method for removing a mouseOver3D event listener
Parameters
listener:Function — The listener function
|
| removeOnMouseUp | () | method |
public function removeOnMouseUp(listener:Function):voidDefault method for removing a mouseUp3D event listener
Parameters
listener:Function — The listener function
|
| removeOnPositionChange | () | method |
public function removeOnPositionChange(listener:Function):voidDefault method for removing a positionchanged event listener
Parameters
listener:Function — The listener function
|
| removeOnRollOut | () | method |
public function removeOnRollOut(listener:Function):voidDefault method for removing a rollOut3D event listener
Parameters
listener:Function — The listener function
|
| removeOnRollOver | () | method |
public function removeOnRollOver(listener:Function):voidDefault method for removing a rollOver3D event listener
Parameters
listener:Function — The listener function
|
| removeOnScaleChange | () | method |
public function removeOnScaleChange(listener:Function):voidDefault method for removing a scalechanged event listener
Parameters
listener:Function — The listener function
|
| removeOnSceneChange | () | method |
public function removeOnSceneChange(listener:Function):voidDefault method for removing a scenechanged event listener
Parameters
listener:Function — The listener function
|
| removeOnSceneTransformChange | () | method |
public function removeOnSceneTransformChange(listener:Function):voidDefault method for removing a scenetransformchanged event listener
Parameters
listener:Function — The listener function
|
| removeOnSessionChange | () | method |
public function removeOnSessionChange(listener:Function):voidDefault method for removing a sessionchanged event listener
Parameters
listener:Function — The listener function
|
| removeOnVisibilityUpdate | () | method |
public function removeOnVisibilityUpdate(listener:Function):voidDefault method for removing a visibilityUpdated event listener
Parameters
listener:Function — The listener function
|
| roll | () | method |
public function roll(angle:Number):voidRotates 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):voidRotates 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):voidRotates 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(scale:Number):voidScales the contents of the 3d object.
Parameters
scale:Number — The scaling value
|
| tick | () | method |
public function tick(time:int):void
Called by the TickTraverser.
Can be overridden to provide updates to the 3d object based on individual render calls from the renderer.
Parameters
time:int — The absolute time at the start of the render cycle
|
See also
| toString | () | method |
override public function toString():StringUsed to trace the values of a 3d object.
ReturnsString — A string representation of the 3d object.
|
| translate | () | method |
public function translate(axis:Vector3D, distance:Number):voidMoves 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
|
| traverse | () | method |
public function traverse(traverser:Traverser):voidUsed when traversing the scenegraph
Parameters
traverser:Traverser — The traverser object
|
See also
| updateDimensions | () | method |
protected function updateDimensions():void| updateTransform | () | method |
protected function updateTransform():void| yaw | () | method |
public function yaw(angle:Number):voidRotates the 3d object around it's local y-axis
Parameters
angle:Number — The amount of rotation in degrees
|
| contentUpdated | Event |
away3d.events.Object3DEventaway3d.events.Object3DEventDispatched when the contents of the 3d object updates.
| dimensionsChanged | Event |
away3d.events.Object3DEventaway3d.events.Object3DEventDispatched when the bounding dimensions of the 3d object changes.
See also
| mouseDown | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user presses the left hand mouse button while the cursor is over the 3d object.
| mouseMove | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user moves the cursor while it is over the 3d object.
| mouseOut | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user moves the cursor away from the 3d object.
| mouseOver | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user moves the cursor over the 3d object.
| mouseUp | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user releases the left hand mouse button while the cursor is over the 3d object.
| rollOut | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user rolls out of the 3d object.
| rollOver | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user rolls over the 3d object.
| sceneChanged | Event |
away3d.events.Object3DEventaway3d.events.Object3DEventDispatched when the parent scene of the 3d object changes.
See also
| scenetransformChanged | Event |
away3d.events.Object3DEventaway3d.events.Object3DEventDispatched when the scene transform matrix of the 3d object changes.
See also
| sessionChanged | Event |
away3d.events.Object3DEventaway3d.events.Object3DEventDispatched when the render session property of the 3d object changes.
See also
| transformChanged | Event |
away3d.events.Object3DEventaway3d.events.Object3DEventDispatched when the local transform matrix of the 3d object changes.
See also