Package | away3d.sprites |
Class | public class DirSprite2D |
Inheritance | DirSprite2D Object3D flash.events.EventDispatcher |
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 | ||
bitmaps : Dictionary [read-only]
| DirSprite2D | ||
blendMode : String
An optional blend mode that can be applied to the 3d object.
| Object3D | ||
boundingRadius : Number
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 | Object3D | ||
debugBoundingSphere : WireSphere | Object3D | ||
debugbs : Boolean
Indicates whether a debug bounding sphere should be rendered around the 3d object.
| Object3D | ||
deltaZ : Number
An optional offset value added to the z depth used to sort the sprite
| DirSprite2D | ||
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 | Object3D | ||
inverseSceneTransform : MatrixAway3D
Returns the inverse of sceneTransform.
| Object3D | ||
lightarray : ILightConsumer
returns the array of lights contained inside the container.
| Object3D | ||
materialLibrary : MaterialLibrary
Reference container for all materials used in the container.
| Object3D | ||
maxX : Number
Returns the maximum x value of the 3d object
| Object3D | ||
maxY : Number
Returns the maximum y value of the 3d object
| Object3D | ||
maxZ : Number
Returns the maximum z value of the 3d object
| Object3D | ||
minX : Number
Returns the minimum x value of the 3d object
| Object3D | ||
minY : Number
Returns the minimum y value of the 3d object
| Object3D | ||
minZ : Number
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
Boundary depth of the 3d object
return The depth of the mesh
| Object3D | ||
objectHeight : Number
Boundary height of the 3d object
return The height of the mesh
| Object3D | ||
objectWidth : Number
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 | 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 | ||
rotation : Number
Defines the overall 2d rotation of the sprite object
| DirSprite2D | ||
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 | ||
scaling : Number
Defines the overall scaling of the sprite object
| DirSprite2D | ||
scene : Scene3D
Returns the parent scene of the 3d object
| Object3D | ||
scenePivotPoint : Number3D | Object3D | ||
scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the
Scene3D object. | Object3D | ||
sceneTransform : MatrixAway3D
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
The render session used by the 3d object
| Object3D | ||
smooth : Boolean
Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen
| DirSprite2D | ||
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 | ||
vertices : Array [read-only]
| DirSprite2D | ||
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 |
Method | Defined by | ||
---|---|---|---|
DirSprite2D
(init:Object = null)
Creates a new
DirSprite2D object. | DirSprite2D | ||
add(x:Number, y:Number, z:Number, bitmap:BitmapData):void
Adds a new bitmap definition to the array of directional textures.
| DirSprite2D | ||
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 | ||
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 | ||
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
| Object3D | ||
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 | ||
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 | ||
Moves the 3d object along a vector by a defined length
| Object3D | ||
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 |
bitmaps | property |
bitmaps:Dictionary
[read-only]Implementation
public function get bitmaps():Dictionary
deltaZ | property |
public var deltaZ:Number
An optional offset value added to the z depth used to sort the sprite
rotation | property |
public var rotation:Number
Defines the overall 2d rotation of the sprite object
scaling | property |
public var scaling:Number
Defines the overall scaling of the sprite object
smooth | property |
public var smooth:Boolean
Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen
vertices | property |
vertices:Array
[read-only]Implementation
public function get vertices():Array
DirSprite2D | () | constructor |
public function DirSprite2D(init:Object = null)
Parameters
init:Object (default = null ) — [optional] An initialisation object for specifying default instance properties.
|
scaling:Number (default = 1, min:0) | |
rotation:Number (default = 0) | |
smooth:Boolean (default = false) | |
deltaZ:Number (default = 0) | |
bitmaps:Array |
add | () | method |
public function add(x:Number, y:Number, z:Number, bitmap:BitmapData):void
Adds a new bitmap definition to the array of directional textures.
Parametersx:Number — x The x coordinate of the directional texture.
|
|
y:Number — y The y coordinate of the directional texture.
|
|
z:Number — z The z coordinate of the directional texture.
|
|
bitmap:BitmapData — bitmap The bitmapData object to be used as the directional texture.
|