Packageaway3d.core.base
Classpublic class Object3D
InheritanceObject3D Inheritance flash.events.EventDispatcher
ImplementsIClonable
SubclassesCamera3D, ConvexBlock, DirSprite2D, DofSprite2D, Mesh, Morpher, MovieClipSprite, Sound3D, Sprite2D

Base class for all 3d objects.

Public Properties
 PropertyDefined 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
  center : Array
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 : 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
  geometryLibrary : GeometryLibrary
Reference container for all geometries used in the container.
Object3D
  id : int
[read-only]
Object3D
  inverseSceneTransform : MatrixAway3D
Returns the inverse of sceneTransform.
Object3D
  lightarray : ILightConsumer
[read-only] returns the array of lights contained inside the container.
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
  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
[read-only]
Object3D
  position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
  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
[read-only] Returns the parent scene of the 3d object
Object3D
  scenePivotPoint : Number3D
[read-only]
Object3D
  scenePosition : Number3D
[read-only] Returns the position of the 3d object, relative to the global coordinates of the Scene3D object.
Object3D
  sceneTransform : MatrixAway3D
[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 : AbstractRenderSession
[read-only] The render session used by the 3d object
Object3D
  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
  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
Protected Properties
 PropertyDefined 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 : Number3D
Object3D
Public Methods
 MethodDefined 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
  
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
  
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
  
clone(object:Object3D = null):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:Number3D, upAxis:Number3D = 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
  
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
  
rotate(axis:Number3D, 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
Used to trace the values of a 3d object.
Object3D
  
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Object3D
  
traverse(traverser:Traverser):void
Used when traversing the scenegraph
Object3D
  
updateObject():void
Object3D
  
updateSession():void
Object3D
  
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined by
  
Object3D
  
Object3D
Events
 EventSummaryDefined by
   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 render session property of the 3d object updates its contents.Object3D
   Dispatched when the local transform matrix of the 3d object changes.Object3D
Property detail
alphaproperty
alpha:Number  [read-write]

An optional alpha value that can be applied to the 3d object. Requires ownCanvas to be set to true.

Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void

See also

animationLibraryproperty 
public var animationLibrary:AnimationLibrary

Reference container for all animations used in the container. Populated in Collada parsers.

See also

blendModeproperty 
blendMode:String  [read-write]

An optional blend mode that can be applied to the 3d object. Requires ownCanvas to be set to true.

Implementation
    public function get blendMode():String
    public function set blendMode(value:String):void

See also

boundingRadiusproperty 
boundingRadius:Number  [read-only]

Returns the bounding radius of the 3d object

Implementation
    public function get boundingRadius():Number
centerproperty 
public var center:Array
colliderproperty 
collider:Boolean  [read-write]

Indicates whether this object is used for collision detection. Currently only used for dynamic objects in BSP trees.

Implementation
    public function get collider():Boolean
    public function set collider(value:Boolean):void
debugbbproperty 
public var debugbb:Boolean

Indicates whether a debug bounding box should be rendered around the 3d object.

debugBoundingBoxproperty 
debugBoundingBox:WireCube  [read-only]Implementation
    public function get debugBoundingBox():WireCube
debugBoundingSphereproperty 
debugBoundingSphere:WireSphere  [read-only]Implementation
    public function get debugBoundingSphere():WireSphere
debugbsproperty 
public var debugbs:Boolean

Indicates whether a debug bounding sphere should be rendered around the 3d object.

eulersproperty 
eulers:Number3D  [read-write]

Defines the rotation of the 3d object as a Number3D object containing euler angles for rotation around x, y and z axis.

Implementation
    public function get eulers():Number3D
    public function set eulers(value:Number3D):void
extraproperty 
public var extra:Object

An optional untyped object that can contain used-defined properties

filtersproperty 
filters:Array  [read-write]

An optional array of filters that can be applied to the 3d object. Requires ownCanvas to be set to true.

Implementation
    public function get filters():Array
    public function set filters(value:Array):void

See also

geometryLibraryproperty 
public var geometryLibrary:GeometryLibrary

Reference container for all geometries used in the container. Populated in Collada and Max3DS parsers.

See also

_idproperty 
arcane var _id:int
idproperty 
id:int  [read-only]Implementation
    public function get id():int
iniproperty 
protected var 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.

inverseSceneTransformproperty 
public var inverseSceneTransform:MatrixAway3D

Returns the inverse of sceneTransform.

See also

lightarrayproperty 
lightarray:ILightConsumer  [read-only]

returns the array of lights contained inside the container.

Implementation
    public function get lightarray():ILightConsumer
materialLibraryproperty 
public var materialLibrary:MaterialLibrary

Reference container for all materials used in the container. Populated in Collada, Max3DS and Obj parsers.

See also

maxXproperty 
maxX:Number  [read-only]

Returns the maximum x value of the 3d object

Implementation
    public function get maxX():Number

See also

x
maxYproperty 
maxY:Number  [read-only]

Returns the maximum y value of the 3d object

Implementation
    public function get maxY():Number

See also

y
maxZproperty 
maxZ:Number  [read-only]

Returns the maximum z value of the 3d object

Implementation
    public function get maxZ():Number

See also

z
minXproperty 
minX:Number  [read-only]

Returns the minimum x value of the 3d object

Implementation
    public function get minX():Number

See also

x
minYproperty 
minY:Number  [read-only]

Returns the minimum y value of the 3d object

Implementation
    public function get minY():Number

See also

y
minZproperty 
minZ:Number  [read-only]

Returns the minimum z value of the 3d object

Implementation
    public function get minZ():Number

See also

z
mouseEnabledproperty 
public var mouseEnabled:Boolean = true

Defines whether mouse events are received on the 3d object

nameproperty 
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

objectDepthproperty 
objectDepth:Number  [read-only]

Boundary depth of the 3d object return The depth of the mesh

Implementation
    public function get objectDepth():Number
_objectDirtyproperty 
arcane var _objectDirty:Boolean
objectHeightproperty 
objectHeight:Number  [read-only]

Boundary height of the 3d object return The height of the mesh

Implementation
    public function get objectHeight():Number
objectWidthproperty 
objectWidth:Number  [read-only]

Boundary width of the 3d object return The width of the object

Implementation
    public function get objectWidth():Number
ownCanvasproperty 
ownCanvas:Boolean  [read-write]

Defines whether the contents of the 3d object are rendered using it's own render session

Implementation
    public function get ownCanvas():Boolean
    public function set ownCanvas(value:Boolean):void
ownLightsproperty 
ownLights:Boolean  [read-write]

Defines whether the children of the container are rendered using it's own lights.

Implementation
    public function get ownLights():Boolean
    public function set ownLights(value:Boolean):void
ownSessionproperty 
ownSession:AbstractRenderSession  [read-write]

Defines a unique render session for the 3d object.

Implementation
    public function get ownSession():AbstractRenderSession
    public function set ownSession(value:AbstractRenderSession):void
parentproperty 
parent:ObjectContainer3D  [read-write]

Defines the parent of the 3d object.

Implementation
    public function get parent():ObjectContainer3D
    public function set parent(value:ObjectContainer3D):void
_pivotPointproperty 
protected var _pivotPoint:Number3D
pivotPointproperty 
pivotPoint:Number3D  [read-write]

Defines the local point around which the object rotates.

Implementation
    public function get pivotPoint():Number3D
    public function set pivotPoint(value:Number3D):void
pivotZeroproperty 
pivotZero:Boolean  [read-only]Implementation
    public function get pivotZero():Boolean
positionproperty 
position:Number3D  [read-write]

Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get position():Number3D
    public function set position(value:Number3D):void
projectorTypeproperty 
public var projectorType:String
pushbackproperty 
public var pushback:Boolean

Elements use their furthest point from the camera when z-sorting

pushfrontproperty 
public var pushfront:Boolean

Elements use their nearest point to the camera when z-sorting

rendererproperty 
renderer:IPrimitiveConsumer  [read-write]

An optional renderer object that can be used to render the contents of the object. Requires ownCanvas to be set to true.

Implementation
    public function get renderer():IPrimitiveConsumer
    public function set renderer(value:IPrimitiveConsumer):void

See also

_rotationXproperty 
arcane var _rotationX:Number = 0
rotationXproperty 
rotationX:Number  [read-write]

Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get rotationX():Number
    public function set rotationX(value:Number):void
_rotationYproperty 
arcane var _rotationY:Number = 0
rotationYproperty 
rotationY:Number  [read-write]

Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get rotationY():Number
    public function set rotationY(value:Number):void
_rotationZproperty 
arcane var _rotationZ:Number = 0
rotationZproperty 
rotationZ:Number  [read-write]

Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get rotationZ():Number
    public function set rotationZ(value:Number):void
_scaleXproperty 
arcane var _scaleX:Number = 1
scaleXproperty 
scaleX:Number  [read-write]

Defines the scale of the 3d object along the x-axis, relative to local coordinates.

Implementation
    public function get scaleX():Number
    public function set scaleX(value:Number):void
_scaleYproperty 
arcane var _scaleY:Number = 1
scaleYproperty 
scaleY:Number  [read-write]

Defines the scale of the 3d object along the y-axis, relative to local coordinates.

Implementation
    public function get scaleY():Number
    public function set scaleY(value:Number):void
_scaleZproperty 
arcane var _scaleZ:Number = 1
scaleZproperty 
scaleZ:Number  [read-write]

Defines the scale of the 3d object along the z-axis, relative to local coordinates.

Implementation
    public function get scaleZ():Number
    public function set scaleZ(value:Number):void
_sceneproperty 
arcane var _scene:Scene3D
sceneproperty 
scene:Scene3D  [read-only]

Returns the parent scene of the 3d object

Implementation
    public function get scene():Scene3D
scenePivotPointproperty 
scenePivotPoint:Number3D  [read-only]Implementation
    public function get scenePivotPoint():Number3D
scenePositionproperty 
scenePosition:Number3D  [read-only]

Returns the position of the 3d object, relative to the global coordinates of the Scene3D object.

Implementation
    public function get scenePosition():Number3D
sceneTransformproperty 
sceneTransform:MatrixAway3D  [read-only]

Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D object.

Implementation
    public function get sceneTransform():MatrixAway3D
screenXOffsetproperty 
public var screenXOffset:Number

Defines an additional offset to the x coordinate used on mesh elements or objects with ownCanvas set to true

screenYOffsetproperty 
public var screenYOffset:Number

Defines an additional offset to the y coordinate used on mesh elements or objects with ownCanvas set to true

screenZOffsetproperty 
public var screenZOffset:Number

Defines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true

_sessionproperty 
arcane var _session:AbstractRenderSession
sessionproperty 
session:AbstractRenderSession  [read-only]

The render session used by the 3d object

Implementation
    public function get session():AbstractRenderSession
_sessionDirtyproperty 
arcane var _sessionDirty:Boolean
transformproperty 
transform:MatrixAway3D  [read-write]

Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get transform():MatrixAway3D
    public function set transform(value:MatrixAway3D):void
useHandCursorproperty 
public var useHandCursor:Boolean = false

Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.

visibleproperty 
visible:Boolean  [read-write]

Defines whether the 3d object is visible in the scene

Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
xproperty 
x:Number  [read-write]

Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.

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

Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.

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

Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get z():Number
    public function set z(value:Number):void
Method detail
addOnDimensionsChange()method
public function addOnDimensionsChange(listener:Function):void

Default method for adding a dimensionschanged event listener

Parameters
listener:Function — The listener function
addOnMouseDown()method 
public function addOnMouseDown(listener:Function):void

Default method for adding a mouseDown3D event listener

Parameters
listener:Function — The listener function
addOnMouseMove()method 
public function addOnMouseMove(listener:Function):void

Default method for adding a mouseMove3D event listener

Parameters
listener:Function — The listener function
addOnMouseOut()method 
public function addOnMouseOut(listener:Function):void

Default method for adding a mouseOut3D event listener

Parameters
listener:Function — The listener function
addOnMouseOver()method 
public function addOnMouseOver(listener:Function):void

Default method for adding a mouseOver3D event listener

Parameters
listener:Function — The listener function
addOnMouseUp()method 
public function addOnMouseUp(listener:Function):void

Default method for adding a mouseUp3D event listener

Parameters
listener:Function — The listener function
addOnParentUpdate()method 
public function addOnParentUpdate(listener:Function):void

Default method for adding a parentupdated event listener

Parameters
listener:Function — The listener function
addOnRollOut()method 
public function addOnRollOut(listener:Function):void

Default method for adding a rollOut3D event listener

Parameters
listener:Function — The listener function
addOnRollOver()method 
public function addOnRollOver(listener:Function):void

Default method for adding a rollOver3D event listener

Parameters
listener:Function — The listener function
addOnSceneChange()method 
public function addOnSceneChange(listener:Function):void

Default method for adding a scenechanged event listener

Parameters
listener:Function — The listener function
addOnSceneTransformChange()method 
public function addOnSceneTransformChange(listener:Function):void

Default method for adding a scenetransformchanged event listener

Parameters
listener:Function — The listener function
addOnSessionChange()method 
public function addOnSessionChange(listener:Function):void

Default method for adding a sessionchanged event listener

Parameters
listener:Function — The listener function
addOnTransformChange()method 
public function addOnTransformChange(listener:Function):void

Default method for adding a transformchanged event listener

Parameters
listener:Function — The listener function
applyPosition()method 
public function applyPosition(dx:Number, dy:Number, dz:Number):void

Apply 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():void

Apply the local rotations to the object without altering the apperance of child objects

centerPivot()method 
public function centerPivot():void

Adjusts 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

Returns
Object3D — The new object instance with duplicated properties applied
distanceTo()method 
public function distanceTo(obj:Object3D):Number

Calulates 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

Returns
Number — The scalar distance between objects

See also

lookAt()method 
public function lookAt(target:Number3D, upAxis:Number3D = null):void

Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.

Parameters
target:Number3D — The vector defining the point to be looked at
 
upAxis:Number3D (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
removeOnDimensionsChange()method 
public function removeOnDimensionsChange(listener:Function):void

Default method for removing a dimensionschanged event listener

Parameters
listener:Function — The listener function
removeOnMouseDown()method 
public function removeOnMouseDown(listener:Function):void

Default method for removing a mouseDown3D event listener

Parameters
listener:Function — The listener function
removeOnMouseMove()method 
public function removeOnMouseMove(listener:Function):void

Default method for removing a mouseMove3D event listener

Parameters
listener:Function — The listener function
removeOnMouseOut()method 
public function removeOnMouseOut(listener:Function):void

Default method for removing a mouseOut3D event listener

Parameters
listener:Function — The listener function
removeOnMouseOver()method 
public function removeOnMouseOver(listener:Function):void

Default method for removing a mouseOver3D event listener

Parameters
listener:Function — The listener function
removeOnMouseUp()method 
public function removeOnMouseUp(listener:Function):void

Default method for removing a mouseUp3D event listener

Parameters
listener:Function — The listener function
removeOnParentUpdate()method 
public function removeOnParentUpdate(listener:Function):void

Default method for removing a parentupdated event listener

Parameters
listener:Function — The listener function
removeOnRollOut()method 
public function removeOnRollOut(listener:Function):void

Default method for removing a rollOut3D event listener

Parameters
listener:Function — The listener function
removeOnRollOver()method 
public function removeOnRollOver(listener:Function):void

Default method for removing a rollOver3D event listener

Parameters
listener:Function — The listener function
removeOnSceneChange()method 
public function removeOnSceneChange(listener:Function):void

Default method for removing a scenechanged event listener

Parameters
listener:Function — The listener function
removeOnSceneTransformChange()method 
public function removeOnSceneTransformChange(listener:Function):void

Default method for removing a scenetransformchanged event listener

Parameters
listener:Function — The listener function
removeOnSessionChange()method 
public function removeOnSessionChange(listener:Function):void

Default method for removing a sessionchanged event listener

Parameters
listener:Function — The listener function
removeOnTransformChange()method 
public function removeOnTransformChange(listener:Function):void

Default method for removing a transformchanged event listener

Parameters
listener:Function — The listener function
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:Number3D, angle:Number):void

Rotates the 3d object around an axis by a defined angle

Parameters
axis:Number3D — 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(scale:Number):void

Scales 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 
public override function toString():String

Used to trace the values of a 3d object.

Returns
String — A string representation of the 3d object.
translate()method 
public function translate(axis:Number3D, distance:Number):void

Moves the 3d object along a vector by a defined length

Parameters
axis:Number3D — The vector defining the axis of movement
 
distance:Number — The length of the movement
traverse()method 
public function traverse(traverser:Traverser):void

Used when traversing the scenegraph

Parameters
traverser:Traverser — The traverser object

See also

updateDimensions()method 
protected function updateDimensions():void
updateObject()method 
public function updateObject():void
updateSession()method 
public function updateSession():void
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
Event detail
dimensionsChangedevent 
Event object type: away3d.events.Object3DEvent

Dispatched when the bounding dimensions of the 3d object changes.

See also

mouseDownevent  
Event object type: away3d.events.MouseEvent3D

Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.

mouseMoveevent  
Event object type: away3d.events.MouseEvent3D

Dispatched when a user moves the cursor while it is over the 3d object.

mouseOutevent  
Event object type: away3d.events.MouseEvent3D

Dispatched when a user moves the cursor away from the 3d object.

mouseOverevent  
Event object type: away3d.events.MouseEvent3D

Dispatched when a user moves the cursor over the 3d object.

mouseUpevent  
Event object type: away3d.events.MouseEvent3D

Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.

rollOutevent  
Event object type: away3d.events.MouseEvent3D

Dispatched when a user rolls out of the 3d object.

rollOverevent  
Event object type: away3d.events.MouseEvent3D

Dispatched when a user rolls over the 3d object.

sceneChangedevent  
Event object type: away3d.events.Object3DEvent

Dispatched when the parent scene of the 3d object changes.

See also

scenetransformChangedevent  
Event object type: away3d.events.Object3DEvent

Dispatched when the scene transform matrix of the 3d object changes.

See also

sessionChangedevent  
Event object type: away3d.events.Object3DEvent

Dispatched when the render session property of the 3d object changes.

See also

sessionUpdatedevent  
Event object type: away3d.events.Object3DEvent

Dispatched when the render session property of the 3d object updates its contents.

See also

transformChangedevent  
Event object type: away3d.events.Object3DEvent

Dispatched when the local transform matrix of the 3d object changes.

See also

Wiki link
Click to go to the wiki page for 'away3d.core.base.Object3D'

Code examples

Comments