Packageorg.papervision3d.objects.parsers
Classpublic class DAE
InheritanceDAE Inheritance DisplayObject3D Inheritance DisplayObjectContainer3D Inheritance flash.events.EventDispatcher
ImplementsIAnimatable, IAnimationDataProvider



Public Properties
 PropertyDefined by
 Inheritedalpha : Number = 1
DisplayObject3D
 InheritedautoCalcScreenCoords : Boolean
DisplayObject3D
  baseUrl : String
DAE
 InheritedblendMode : String = "normal"
DisplayObject3D
 Inheritedchildren : Object
Returns the children object.
DisplayObjectContainer3D
  COLLADA : XML
DAE
 Inheritedcontainer : ViewportLayer
DisplayObject3D
 Inheritedculled : Boolean
[internal use] Is this object culled by camera frustum?
DisplayObject3D
  DEFAULT_LINE_COLOR : uint = 0xffff00
[static] Default line color for splines.
DAE
  DEFAULT_LINE_WIDTH : Number = 0
[static] Default line width for splines
DAE
  DEFAULT_TGA_ALTERNATIVE : String = "png"
[static] Alternative file-extension for TGA images.
DAE
  document : DaeDocument
DAE
 Inheritedextra : Object
An object that contains user defined properties.
DisplayObject3D
 InheritedfaceLevelMode : Boolean
[static] This allows objects faces to have their own containers.
DisplayObject3D
 Inheritedfaces : Array
[internal-use]
DisplayObject3D
  filename : String
DAE
  fileTitle : String
DAE
 Inheritedfilters : Array
DisplayObject3D
 InheritedflipLightDirection : Boolean = false
DisplayObject3D
  fps : uint
[read-only] Gets the default FPS.
DAE
 InheritedfrustumTestMethod : int = 0
DisplayObject3D
 Inheritedgeometry : GeometryObject3D
The GeometryObject3D object that contains the 3D definition of this instance.
DisplayObject3D
 Inheritedid : int
[read-only] Unique id of this instance.
DisplayObject3D
 InheritedlocalRotationX : Number
DisplayObject3D
 InheritedlocalRotationY : Number
DisplayObject3D
 InheritedlocalRotationZ : Number
DisplayObject3D
 Inheritedmaterial : MaterialObject3D
DisplayObject3D
 Inheritedmaterials : MaterialsList
The list of materials for this instance.
DisplayObject3D
 InheritedmeshSort : uint = 1
tells Mesh3D's render() method to compare the measurement choice of the user for a triangle's sorting
DisplayObject3D
 Inheritedname : String
An optional object name.
DisplayObject3D
 InheritednumChildren : int
Returns the number of children of this object.
DisplayObjectContainer3D
 Inheritedparent : DisplayObjectContainer3D
[read-only] Indicates the DisplayObjectContainer3D object that contains this display object.
DisplayObject3D
 InheritedparentContainer : DisplayObject3D
DisplayObject3D
  parser : DaeReader
DAE
 Inheritedroot : DisplayObjectContainer3D
[read-only] [read-only] The scene, which is the top-most displayObjectContainer3D in the tree structure.
DisplayObjectContainer3D
 InheritedrotationX : Number
Specifies the rotation around the X axis from its original orientation.
DisplayObject3D
 InheritedrotationY : Number
Specifies the rotation around the Y axis from its original orientation.
DisplayObject3D
 InheritedrotationZ : Number
Specifies the rotation around the Z axis from its original orientation.
DisplayObject3D
 Inheritedscale : Number
Sets the 3D scale as applied from the registration point of the object.
DisplayObject3D
 InheritedscaleX : Number
Sets the scale along the local X axis as applied from the registration point of the object.
DisplayObject3D
 InheritedscaleY : Number
Sets the scale along the local Y axis as applied from the registration point of the object.
DisplayObject3D
 InheritedscaleZ : Number
Sets the scale along the local Z axis as applied from the registration point of the object.
DisplayObject3D
 Inheritedscene : SceneObject3D
DisplayObject3D
 InheritedsceneX : Number
The X coordinate of a object relative to the scene coordinate system.
DisplayObject3D
 InheritedsceneY : Number
The Y coordinate of a object relative to the scene coordinate system.
DisplayObject3D
 InheritedsceneZ : Number
The Z coordinate of a object relative to the scene coordinate system.
DisplayObject3D
 Inheritedscreen : Number3D
[read-only] The coordinate of the object on screen.
DisplayObject3D
 InheritedscreenZ : Number
[internal-use] The average depth of the object faces center.
DisplayObject3D
 InheritedsortedArray : Array
[static]
DisplayObject3D
  texturePath : String
Path where the textures should be loaded from.
DAE
 Inheritedtransform : Matrix3D
A Matrix3D object containing values that affect the scaling, rotation, and translation of the display object.
DisplayObject3D
 InheriteduseOwnContainer : Boolean
DisplayObject3D
 InheriteduserData : UserData
DisplayObject3D
 Inheritedview : Matrix3D
[internal-use] A camera transformed Matrix3D object.
DisplayObject3D
 Inheritedvisible : Boolean
Whether or not the display object is visible.
DisplayObject3D
 Inheritedworld : Matrix3D
World transformation.
DisplayObject3D
 Inheritedx : Number
An Number that sets the X coordinate of a object relative to the origin of its parent.
DisplayObject3D
 Inheritedy : Number
An Number that sets the Y coordinate of a object relative to the origin of its parent.
DisplayObject3D
  yUp : Boolean
[read-only]
DAE
 Inheritedz : Number
An Number that sets the Z coordinate of a object relative to the origin of its parent.
DisplayObject3D
 InheritedZERO : DisplayObject3D
[static] Returns an empty DiplayObject3D object positioned in the center of the 3D coordinate system (0, 0 ,0).
DisplayObject3D
Protected Properties
 PropertyDefined by
 Inherited_children : Dictionary
[internal-use] Names indexed by children.
DisplayObjectContainer3D
 Inherited_childrenByName : Object
[internal-use] Children indexed by name.
DisplayObjectContainer3D
 Inherited_scene : SceneObject3D = null
The scene where the object belongs.
DisplayObject3D
 Inherited_sorted : Array
DisplayObject3D
 Inherited_transformDirty : Boolean = false
[internal-use]
DisplayObject3D
 Inherited_useOwnContainer : Boolean = false
DisplayObject3D
 Inherited_userData : UserData
DisplayObject3D
Public Methods
 MethodDefined by
  
DAE(autoPlay:Boolean = true, name:String = null)
Constructor.
DAE
 Inherited
addChild(child:DisplayObject3D, name:String = null):DisplayObject3D
Adds a child DisplayObject3D instance to this DisplayObjectContainer instance.
DisplayObject3D
 Inherited
Adds all the children of a DisplayObject3D instance to this DisplayObjectContainer instance.
DisplayObjectContainer3D
 Inherited
DisplayObject3D
 Inherited
addGeometry(geometry:GeometryObject3D = null):void
Adds a geometry definition to the instance.
DisplayObject3D
 Inherited
DisplayObject3D
 Inherited
childrenList():String
Returns a string value with the list of objects.
DisplayObjectContainer3D
 Inherited
Clones this object.
DisplayObject3D
 Inherited
copyPosition(reference:*):void
Copies the position information (x, y and z coordinates) from another object or Matrix3D.
DisplayObject3D
 Inherited
copyTransform(reference:*):void
Copies the transformation information (position, rotation and scale) from another object or Matrix3D.
DisplayObject3D
 Inherited
createViewportLayer(viewport:Viewport3D, recurse:Boolean = true):ViewportLayer
DisplayObject3D
 Inherited
Gets the distance to the position of the given object.
DisplayObject3D
  
Gets a animation channel by its name.
DAE
  
Gets all animation channels for a target.
DAE
  
getAnimationChannelsByClip(name:String):Array
Gets animation channels by clip name.
DAE
 Inherited
getChildByName(name:String, recursive:Boolean = false):DisplayObject3D
Returns the child display object that exists with the specified name.
DisplayObjectContainer3D
 Inherited
Returns the material that exists with the specified name in the materials list.
DisplayObject3D
 Inherited
hitTestObject(obj:DisplayObject3D, multiplier:Number = 1):Boolean
Evaluates the display object to see if it overlaps or intersects with the obj display object.
DisplayObject3D
 Inherited
hitTestPoint(x:Number, y:Number, z:Number):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x, y and z parameters.
DisplayObject3D
  
load(asset:*, materials:MaterialsList = null):void
Loads the COLLADA.
DAE
 Inherited
lookAt(targetObject:DisplayObject3D, upAxis:Number3D = null):void
Make the object look at a specific position.
DisplayObject3D
 Inherited
materialsList():String
Returns a string value with the list of material names of the materials list.
DisplayObject3D
 Inherited
moveBackward(distance:Number):void
Translate the display object in the opposite direction it is facing, i.e.
DisplayObject3D
 Inherited
moveDown(distance:Number):void
Translate the display object downwards, with respect to the direction it is facing, i.e.
DisplayObject3D
 Inherited
moveForward(distance:Number):void
Translate the display object in the direction it is facing, i.e.
DisplayObject3D
 Inherited
moveLeft(distance:Number):void
Translate the display object lateraly, to the left of the direction it is facing, i.e.
DisplayObject3D
 Inherited
moveRight(distance:Number):void
Translate the display object lateraly, to the right of the direction it is facing, i.e.
DisplayObject3D
 Inherited
moveUp(distance:Number):void
Translate the display object upwards, with respect to the direction it is facing, i.e.
DisplayObject3D
 Inherited
pitch(angle:Number):void
Rotate the display object around its lateral or transverse axis —an axis running from the pilot's left to right in piloted aircraft, and parallel to the wings of a winged aircraft; thus the nose pitches up and the tail down, or vice-versa.
DisplayObject3D
  
play(clip:String = null):void
Plays the animation.
DAE
  
project(parent:DisplayObject3D, renderSessionData:RenderSessionData):Number
Project.
DAE
  
Removes a child.
DAE
 Inherited
Removes the child DisplayObject3D instance that exists with the specified name, from the child list of the DisplayObjectContainer3D instance.
DisplayObjectContainer3D
  
replaceMaterialByName(material:MaterialObject3D, name:String):void
Replaces a material by its name.
DAE
 Inherited
roll(angle:Number):void
Rotate the display object around the longitudinal axis —an axis drawn through the body of the vehicle from tail to nose in the normal direction of flight, or the direction the object is facing.
DisplayObject3D
  
setChildMaterial(child:DisplayObject3D, material:MaterialObject3D, existingMaterial:MaterialObject3D = null):void
Sets the material for a child DisplayObject3D.
DAE
  
setChildMaterialByName(childName:String, material:MaterialObject3D):void
Sets the material for a child DisplayObject3D by the child's name.
DAE
  
stop():void
Stops the animation.
DAE
 Inherited
toString():String
Returns a string value representing the three-dimensional position values of the display object instance.
DisplayObject3D
 Inherited
translate(distance:Number, axis:Number3D):void
Move the object along a given direction.
DisplayObject3D
 Inherited
[internal-use] Updates the transform Matrix3D with the current rotation and scale values.
DisplayObject3D
 Inherited
yaw(angle:Number):void
Rotate the display object around about the vertical axis —an axis drawn from top to bottom.
DisplayObject3D
Protected Methods
 MethodDefined by
 Inherited
setParentContainer(parent:DisplayObject3D, assign:Boolean = true):void
DisplayObject3D
Public Constants
 ConstantDefined by
 InheritedMESH_SORT_CENTER : uint = 1
[static] tells Mesh3D's render() method to sort by measuring from the center of a triangle
DisplayObject3D
 InheritedMESH_SORT_CLOSE : uint = 3
[static] tells Mesh3D's render() method to sort by measuring from the closest point of a triangle
DisplayObject3D
 InheritedMESH_SORT_FAR : uint = 2
[static] tells Mesh3D's render() method to sort by measuring from the farthest point of a triangle
DisplayObject3D
Property detail
baseUrlproperty
public var baseUrl:String

COLLADAproperty 
public var COLLADA:XML

DEFAULT_LINE_COLORproperty 
public static var DEFAULT_LINE_COLOR:uint = 0xffff00

Default line color for splines.

DEFAULT_LINE_WIDTHproperty 
public static var DEFAULT_LINE_WIDTH:Number = 0

Default line width for splines

DEFAULT_TGA_ALTERNATIVEproperty 
public static var DEFAULT_TGA_ALTERNATIVE:String = "png"

Alternative file-extension for TGA images. Default is "png".

documentproperty 
public var document:DaeDocument

filenameproperty 
public var filename:String

fileTitleproperty 
public var fileTitle:String

fpsproperty 
fps:uint  [read-only]

Gets the default FPS.

Implementation
    public function get fps():uint
parserproperty 
public var parser:DaeReader

texturePathproperty 
public var texturePath:String

Path where the textures should be loaded from.

yUpproperty 
yUp:Boolean  [read-only]

Implementation
    public function get yUp():Boolean
Constructor detail
DAE()constructor
public function DAE(autoPlay:Boolean = true, name:String = null)

Constructor.

Parameters
autoPlay:Boolean (default = true) — Whether to start the animation automatically.
 
name:String (default = null) — Optional name for the DAE.
Method detail
getAnimationChannelByName()method
public function getAnimationChannelByName(name:String):AbstractChannel3D

Gets a animation channel by its name.

Parameters
name:String

Returns
AbstractChannel3D — the found channel.
getAnimationChannels()method 
public function getAnimationChannels(target:DisplayObject3D = null):Array

Gets all animation channels for a target.

NOTE: when target is null, all channels for this object are returned.

Parameters
target:DisplayObject3D (default = null) — The target to get the channels for.

Returns
Array — Array of AnimationChannel3D.
getAnimationChannelsByClip()method 
public function getAnimationChannelsByClip(name:String):Array

Gets animation channels by clip name.

Parameters
name:String — The clip name

Returns
Array — Array of AnimationChannel3D.
load()method 
public function load(asset:*, materials:MaterialsList = null):void

Loads the COLLADA.

Parameters
asset:* — The url, an XML object or a ByteArray specifying the COLLADA file.
 
materials:MaterialsList (default = null) — An optional materialsList.
play()method 
public function play(clip:String = null):void

Plays the animation.

Parameters
clip:String (default = null) — clip Optional clip name.
project()method 
public override function project(parent:DisplayObject3D, renderSessionData:RenderSessionData):Number

Project.

Parameters
parent:DisplayObject3D
 
renderSessionData:RenderSessionData

Returns
Number — Number
removeChild()method 
public override function removeChild(child:DisplayObject3D):DisplayObject3D

Removes a child.

Parameters
child:DisplayObject3D — The child to remove

Returns
DisplayObject3D — The removed child
replaceMaterialByName()method 
public function replaceMaterialByName(material:MaterialObject3D, name:String):void

Replaces a material by its name.

Parameters
material:MaterialObject3D
 
name:String
setChildMaterial()method 
public function setChildMaterial(child:DisplayObject3D, material:MaterialObject3D, existingMaterial:MaterialObject3D = null):void

Sets the material for a child DisplayObject3D.

Parameters
child:DisplayObject3D — A child DisplayObject3D of this DAE.
 
material:MaterialObject3D — The new material for the child.
 
existingMaterial:MaterialObject3D (default = null) — Optional existing material to be replaced.
setChildMaterialByName()method 
public function setChildMaterialByName(childName:String, material:MaterialObject3D):void

Sets the material for a child DisplayObject3D by the child's name.

Parameters
childName:String — The name of the DisplayObject3D.
 
material:MaterialObject3D — The new material for the child.
stop()method 
public function stop():void

Stops the animation.