| Package | away3d.entities |
| Class | public class Entity |
| Inheritance | Entity  ObjectContainer3D Object3D NamedAssetBase flash.events.EventDispatcher |
| Subclasses | Camera3D, LightBase, Mesh, SegmentSet, SkyBox, Sprite3D |
See also
| Property | Defined By | ||
|---|---|---|---|
 | assetFullPath : Array [read-only] | NamedAssetBase | |
| assetNamespace : String [read-only] | NamedAssetBase | |
| assetType : String [override] [read-only] | Entity | ||
| backVector : Vector3D [read-only]
| Object3D | |
| bounds : BoundingVolumeBase
The bounding volume approximating the volume occupied by the Entity. | Entity | ||
| 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 | |
| inverseSceneTransform : Matrix3D [read-only]
The inverse scene transform object that transforms from world to model space. | ObjectContainer3D | |
| leftVector : Vector3D [read-only]
| Object3D | |
| 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 | ||
| modelViewProjection : Matrix3D [read-only]
The current model-view-projection (MVP) matrix - the one on the top of the stack - used to transform from
model to homogeneous projection space. | 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 | ||
| showBounds : Boolean | Entity | ||
| 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 | |
| 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 | ||
|---|---|---|---|
| _bounds : BoundingVolumeBase | Entity | ||
| _boundsInvalid : Boolean = true | Entity | ||
| _explicitPartition : Partition3D | ObjectContainer3D | |
| _implicitPartition : Partition3D | ObjectContainer3D | |
| _mouseEnabled : Boolean | ObjectContainer3D | |
| _mvpIndex : int = -1 | Entity | ||
| _mvpTransformStack : Vector.<Matrix3D> | Entity | ||
| _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 | |
| _stackLen : uint | Entity | ||
| _transform : Matrix3D | Object3D | |
| _transformComponents : Vector.<Vector3D> | Object3D | |
| _x : Number = 0 | Object3D | |
| _y : Number = 0 | Object3D | |
| _z : Number = 0 | Object3D | |
| _zIndices : Vector.<Number> | Entity | ||
| Method | Defined By | ||
|---|---|---|---|
Entity()
Creates a new Entity object. | Entity | ||
|
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 | |
| [override]
Clones this ObjectContainer3D instance along with all it's children, and
returns the result (which will be a copy of this container, containing copies
of all it's children.)
| ObjectContainer3D | |
| contains(child:ObjectContainer3D):Boolean | ObjectContainer3D | |
| dispatchEvent(event:Event):Boolean [override]
| ObjectContainer3D | |
| dispose():void [override]
Cleans up resources used by this asset. | ObjectContainer3D | |
| disposeAsset():void | Object3D | |
| 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 | ||
| 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 | |
popModelViewProjection():void
Removes a model view projection matrix from the stack, used when leaving a render. | Entity | ||
pushModelViewProjection(camera:Camera3D):void
Updates the model-view-projection (MVP) matrix used to transform from model to homogeneous projection space
and places it on the stack. | Entity | ||
| removeChild(child:ObjectContainer3D):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 | ||
|---|---|---|---|
Factory method that returns the current partition node. | Entity | ||
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
Updates the bounding volume for the object. | Entity | ||
updateMouseChildren():void [override] | Entity | ||
| updateSceneTransform():void
Updates the scene transformation matrix. | ObjectContainer3D | |
| updateTransform():void | Object3D | |
| _bounds | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _bounds:BoundingVolumeBase| _boundsInvalid | property |
protected var _boundsInvalid:Boolean = true| _mvpIndex | property |
protected var _mvpIndex:int = -1| _mvpTransformStack | property |
protected var _mvpTransformStack:Vector.<Matrix3D>| _pickingCollider | property |
arcane var _pickingCollider:IPickingCollider| _pickingCollisionVO | property |
arcane var _pickingCollisionVO:PickingCollisionVO| _stackLen | property |
protected var _stackLen:uint| _zIndices | property |
protected var _zIndices:Vector.<Number>| assetType | property |
assetType:String [read-only] [override] public function get assetType():String| bounds | property |
bounds:BoundingVolumeBaseThe bounding volume approximating the volume occupied by the Entity.
public function get bounds():BoundingVolumeBase public function set bounds(value:BoundingVolumeBase):void| implicitPartition | property |
implicitPartition:Partition3D[override]
arcane function get implicitPartition():Partition3D arcane function set implicitPartition(value:Partition3D):void| maxX | property |
maxX:Number [read-only] [override] The maximum extremum of the object along the X-axis.
public function get maxX():Number| maxY | property |
maxY:Number [read-only] [override] The maximum extremum of the object along the Y-axis.
public function get maxY():Number| maxZ | property |
maxZ:Number [read-only] [override] The maximum extremum of the object along the Z-axis.
public function get maxZ():Number| minX | property |
minX:Number [read-only] [override] The minimum extremum of the object along the X-axis.
public function get minX():Number| minY | property |
minY:Number [read-only] [override] The minimum extremum of the object along the Y-axis.
public function get minY():Number| minZ | property |
minZ:Number [read-only] [override] The minimum extremum of the object along the Z-axis.
public function get minZ():Number| modelViewProjection | property |
modelViewProjection:Matrix3D [read-only] The current model-view-projection (MVP) matrix - the one on the top of the stack - used to transform from model to homogeneous projection space.
public function get modelViewProjection():Matrix3D| pickingCollider | property |
pickingCollider:IPickingColliderUsed 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. Defaults to null.
public function get pickingCollider():IPickingCollider public function set pickingCollider(value:IPickingCollider):voidSee also
| pickingCollisionVO | property |
pickingCollisionVO:PickingCollisionVO [read-only] Returns a unique picking collision value object for the entity.
public function get pickingCollisionVO():PickingCollisionVO| scene | property |
scene:Scene3D[override] A reference to the Scene3D object to which this object belongs.
public function get scene():Scene3D public function set scene(value:Scene3D):void| shaderPickingDetails | property |
shaderPickingDetails:BooleanUsed 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. Defaults to false.
public function get shaderPickingDetails():Boolean public function set shaderPickingDetails(value:Boolean):voidSee also
| showBounds | property |
showBounds:Boolean
public function get showBounds():Boolean public function set showBounds(value:Boolean):void| Entity | () | Constructor |
public function Entity()Creates a new Entity object.
| collidesBefore | () | method |
arcane function collidesBefore(shortestCollisionDistance:Number, findClosest:Boolean):BooleanTests if a collision occurs before shortestCollisionDistance, using the data stored in PickingCollisionVO.
Parameters
shortestCollisionDistance:Number | |
findClosest:Boolean |
Boolean — |
| createEntityPartitionNode | () | method |
protected function createEntityPartitionNode():EntityNodeFactory 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 |
| getDefaultBoundingVolume | () | method |
protected function getDefaultBoundingVolume():BoundingVolumeBaseCreates the default bounding box to be used by this type of Entity.
ReturnsBoundingVolumeBase — |
| getEntityPartitionNode | () | method |
public function getEntityPartitionNode():EntityNodeGets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
ReturnsEntityNode |
| internalUpdate | () | method |
arcane function internalUpdate():void| invalidateBounds | () | method |
protected function invalidateBounds():voidInvalidates the bounding volume, causing to be updated when requested.
| invalidateSceneTransform | () | method |
override protected function invalidateSceneTransform():voidInvalidates the scene transformation matrix, causing it to be updated the next time it's requested.
| popModelViewProjection | () | method |
public function popModelViewProjection():voidRemoves a model view projection matrix from the stack, used when leaving a render.
| pushModelViewProjection | () | method |
public function pushModelViewProjection(camera:Camera3D):voidUpdates the model-view-projection (MVP) matrix used to transform from model to homogeneous projection space and places it on the stack. The stack allows nested rendering while keeping the MVP intact.
Parameters
camera:Camera3D — The camera which will perform the view transformation and projection.
|
| updateBounds | () | method |
protected function updateBounds():voidUpdates the bounding volume for the object. Overriding methods need to set invalid flag to false!
| updateMouseChildren | () | method |
override protected function updateMouseChildren():void