Package | away3d.entities |
Class | public class Mesh |
Inheritance | Mesh Entity ObjectContainer3D Object3D NamedAssetBase flash.events.EventDispatcher |
Implements | IMaterialOwner, IAsset |
Subclasses | DelaunayMesh, Elevation, LatheExtrude, LinearExtrude, PathExtrude, SkinExtrude, Trident |
Property | Defined By | ||
---|---|---|---|
animator : IAnimator
Defines the animator of the mesh. | Mesh | ||
assetFullPath : Array [read-only] | NamedAssetBase | ||
assetNamespace : String [read-only] | NamedAssetBase | ||
assetType : String [override] [read-only] | Mesh | ||
backVector : Vector3D [read-only]
| Object3D | ||
bounds : BoundingVolumeBase
The bounding volume approximating the volume occupied by the Entity. | Entity | ||
castsShadows : Boolean
Indicates whether or not the Mesh can cast shadows. | Mesh | ||
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 | ||
geometry : Geometry
The geometry used by the mesh that provides it with its shape. | Mesh | ||
id : String | NamedAssetBase | ||
ignoreTransform : Boolean [override] | Entity | ||
inverseSceneTransform : Matrix3D [read-only]
The inverse scene transform object that transforms from world to model space. | ObjectContainer3D | ||
leftVector : Vector3D [read-only]
| Object3D | ||
material : MaterialBase
The material with which to render the Mesh. | Mesh | ||
maxX : Number [override] [read-only]
The maximum extremum of the object along the X-axis. | Entity | ||
maxY : Number [override] [read-only]
The maximum extremum of the object along the Y-axis. | Entity | ||
maxZ : Number [override] [read-only]
The maximum extremum of the object along the Z-axis. | Entity | ||
minX : Number [override] [read-only]
The minimum extremum of the object along the X-axis. | Entity | ||
minY : Number [override] [read-only]
The minimum extremum of the object along the Y-axis. | Entity | ||
minZ : Number [override] [read-only]
The minimum extremum of the object along the Z-axis. | Entity | ||
mouseChildren : Boolean | ObjectContainer3D | ||
mouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing. | ObjectContainer3D | ||
name : String | NamedAssetBase | ||
numChildren : uint [read-only]
The amount of child objects of the ObjectContainer3D. | ObjectContainer3D | ||
originalName : String [read-only]
The original name used for this asset in the resource (e.g. | NamedAssetBase | ||
parent : ObjectContainer3D [read-only]
The parent ObjectContainer3D to which this object's transformation is relative. | ObjectContainer3D | ||
partition : Partition3D
The space partition to be used by the object container and all its recursive children, unless it has its own
space partition assigned. | ObjectContainer3D | ||
pickingCollider : IPickingCollider
Used by the raycast-based picking system to determine how the geometric contents of an entity are processed
in order to offer more details for the picking collision object, including local position, normal vector and uv value. | Entity | ||
pickingCollisionVO : PickingCollisionVO [read-only]
Returns a unique picking collision value object for the entity. | Entity | ||
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 | ||
scene : Scene3D [override]
A reference to the Scene3D object to which this object belongs. | Entity | ||
scenePosition : Vector3D [read-only]
The global position of the ObjectContainer3D in the scene. | ObjectContainer3D | ||
sceneTransform : Matrix3D [read-only]
The transformation matrix that transforms from model to world space. | ObjectContainer3D | ||
shaderPickingDetails : Boolean
Used by the shader-based picking system to determine whether a separate render pass is made in order
to offer more details for the picking collision object, including local position, normal vector and uv value. | Entity | ||
shareAnimationGeometry : Boolean
Indicates whether or not the mesh share the same animation geometry. | Mesh | ||
showBounds : Boolean | Entity | ||
staticNode : Boolean
Defines whether or not the object will be moved or animated at runtime. | Entity | ||
subMeshes : Vector.<SubMesh> [read-only]
The SubMeshes out of which the Mesh consists. | Mesh | ||
transform : Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
upVector : Vector3D [read-only]
| Object3D | ||
visible : Boolean | ObjectContainer3D | ||
worldBounds : BoundingVolumeBase [read-only] | Entity | ||
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 | ||
zOffset : int | Object3D |
Property | Defined By | ||
---|---|---|---|
_bounds : BoundingVolumeBase | Entity | ||
_boundsInvalid : Boolean = true | Entity | ||
_explicitPartition : Partition3D | ObjectContainer3D | ||
_geometry : Geometry | Mesh | ||
_ignoreTransform : Boolean = false | ObjectContainer3D | ||
_implicitPartition : Partition3D | ObjectContainer3D | ||
_mouseEnabled : Boolean | ObjectContainer3D | ||
_parent : ObjectContainer3D | ObjectContainer3D | ||
_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 | ||
_scene : Scene3D | ObjectContainer3D | ||
_sceneTransform : Matrix3D | ObjectContainer3D | ||
_sceneTransformDirty : Boolean = true | ObjectContainer3D | ||
_transform : Matrix3D | Object3D | ||
_transformComponents : Vector.<Vector3D> | Object3D | ||
_x : Number = 0 | Object3D | ||
_y : Number = 0 | Object3D | ||
_z : Number = 0 | Object3D | ||
_zOffset : int = 0 | Object3D |
Method | Defined By | ||
---|---|---|---|
Create a new Mesh object. | Mesh | ||
Adds a child ObjectContainer3D to the current object. | ObjectContainer3D | ||
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
| ObjectContainer3D | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override] | ObjectContainer3D | ||
assetPathEquals(name:String, ns:String):Boolean | NamedAssetBase | ||
bakeTransformations():void | Mesh | ||
clearAnimationGeometry():void
Clears the animation geometry of this mesh. | Mesh | ||
[override]
Clones this Mesh instance along with all it's children, while re-using the same
material, geometry and animation set. | Mesh | ||
contains(child:ObjectContainer3D):Boolean | ObjectContainer3D | ||
dispatchEvent(event:Event):Boolean [override]
| ObjectContainer3D | ||
dispose():void [override]
Cleans up resources used by this asset. | Mesh | ||
disposeAsset():void | Object3D | ||
Disposes mesh including the animator and children. | Mesh | ||
disposeWithChildren():void
Disposes the current ObjectContainer3D including all of its children. | ObjectContainer3D | ||
getChildAt(index:uint):ObjectContainer3D
Retrieves the child object at the given index. | ObjectContainer3D | ||
Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
| Entity | ||
Mesh | |||
isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Boolean | Entity | ||
lookAt(target:Vector3D, upAxis:Vector3D = null):void [override]
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D. | ObjectContainer3D | ||
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 | ||
removeChild(child:ObjectContainer3D):void
Removes a 3d object from the child array of the container
| ObjectContainer3D | ||
removeChildAt(index:uint):void
Removes a 3d object from the child array of the container
| ObjectContainer3D | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override] | ObjectContainer3D | ||
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 [override] | ObjectContainer3D | ||
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 [override] | ObjectContainer3D | ||
updateImplicitVisibility():void | ObjectContainer3D | ||
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
Method | Defined By | ||
---|---|---|---|
[override]
Factory method that returns the current partition node. | Mesh | ||
Creates the default bounding box to be used by this type of Entity. | Entity | ||
invalidateBounds():void
Invalidates the bounding volume, causing to be updated when requested. | Entity | ||
invalidateSceneTransform():void [override]
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested. | Entity | ||
updateBounds():void [override]
Updates the bounding volume for the object. | Mesh | ||
updateMouseChildren():void [override] | Entity | ||
updateSceneTransform():void
Updates the scene transformation matrix. | ObjectContainer3D | ||
updateTransform():void | Object3D |
_geometry | property |
protected var _geometry:Geometry
animator | property |
animator:IAnimator
Defines the animator of the mesh. Act on the mesh's geometry. Default value is null
.
public function get animator():IAnimator
public function set animator(value:IAnimator):void
assetType | property |
assetType:String
[read-only] [override] public function get assetType():String
castsShadows | property |
castsShadows:Boolean
Indicates whether or not the Mesh can cast shadows. Default value is true
.
public function get castsShadows():Boolean
public function set castsShadows(value:Boolean):void
geometry | property |
geometry:Geometry
The geometry used by the mesh that provides it with its shape.
public function get geometry():Geometry
public function set geometry(value:Geometry):void
material | property |
material:MaterialBase
The material with which to render the Mesh.
public function get material():MaterialBase
public function set material(value:MaterialBase):void
shareAnimationGeometry | property |
shareAnimationGeometry:Boolean
Indicates whether or not the mesh share the same animation geometry.
public function get shareAnimationGeometry():Boolean
public function set shareAnimationGeometry(value:Boolean):void
subMeshes | property |
subMeshes:Vector.<SubMesh>
[read-only] The SubMeshes out of which the Mesh consists. Every SubMesh can be assigned a material to override the Mesh's material.
public function get subMeshes():Vector.<SubMesh>
Mesh | () | Constructor |
public function Mesh(geometry:Geometry, material:MaterialBase = null)
Create a new Mesh object.
Parametersgeometry:Geometry — The geometry used by the mesh that provides it with its shape.
| |
material:MaterialBase (default = null ) — [optional] The material with which to render the Mesh.
|
bakeTransformations | () | method |
public function bakeTransformations():void
clearAnimationGeometry | () | method |
public function clearAnimationGeometry():void
Clears the animation geometry of this mesh. It will cause animation to generate a new animation geometry. Work only when shareAnimationGeometry is false.
clone | () | method |
override public function clone():Object3D
Clones this Mesh instance along with all it's children, while re-using the same
material, geometry and animation set. The returned result will be a copy of this mesh,
containing copies of all of it's children.
Properties that are re-used (i.e. not cloned) by the new copy include name,
geometry, and material. Properties that are cloned or created anew for the copy
include subMeshes, children of the mesh, and the animator.
If you want to copy just the mesh, reusing it's geometry and material while not
cloning it's children, the simplest way is to create a new mesh manually:
var clone : Mesh = new Mesh(original.geometry, original.material);
Object3D |
collidesBefore | () | method |
override arcane function collidesBefore(shortestCollisionDistance:Number, findClosest:Boolean):Boolean
Parameters
shortestCollisionDistance:Number | |
findClosest:Boolean |
Boolean |
createEntityPartitionNode | () | method |
override protected function createEntityPartitionNode():EntityNode
Factory method that returns the current partition node. Needs to be overridden by concrete subclasses such as Mesh to return the correct concrete subtype of EntityPartition3DNode (for Mesh = MeshPartition3DNode, most IRenderables (particles fe) would return RenderablePartition3DNode, I suppose)
ReturnsEntityNode |
dispose | () | method |
override public function dispose():void
Cleans up resources used by this asset.
disposeWithAnimatorAndChildren | () | method |
public function disposeWithAnimatorAndChildren():void
Disposes mesh including the animator and children. This is a merely a convenience method.
getSubMeshForSubGeometry | () | method |
public function getSubMeshForSubGeometry(subGeometry:SubGeometry):SubMesh
Parameters
subGeometry:SubGeometry |
SubMesh |
updateBounds | () | method |
override protected function updateBounds():void
Updates the bounding volume for the object. Overriding methods need to set invalid flag to false!