Package | away3d.primitives |
Class | public class GridPlane |
Inheritance | GridPlane ![]() ![]() ![]() ![]() |
Property | Defined by | ||
---|---|---|---|
![]() | activePrefix : String
return the prefix of the animation actually started.
| Mesh | |
![]() | 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 | |
![]() | back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
| Mesh | |
![]() | billboardMaterial : IBillboardMaterial | Mesh | |
![]() | billboards : Array
Returns an array of the billboards contained in the mesh object.
| Mesh | |
![]() | blendMode : String
An optional blend mode that can be applied to the 3d object.
| Object3D | |
![]() | bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
| Mesh | |
![]() | boundingRadius : Number
Returns the bounding radius of the 3d object
| Object3D | |
![]() | center : Vertex | 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 | |
![]() | elements : Array
Returns an array of all elements contained in the mesh object.
| Mesh | |
![]() | 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 | |
![]() | faceMaterial : ITriangleMaterial | Mesh | |
![]() | faces : Array
Returns an array of the faces contained in the mesh object.
| Mesh | |
![]() | filters : Array
An optional array of filters that can be applied to the 3d object.
| Object3D | |
![]() | fps : int
Determines the frames per second at which the animation will run.
| Mesh | |
![]() | frame : int
Indicates the current frame of animation
| Mesh | |
![]() | geometry : Geometry
Defines the geometry object used for the mesh.
| Mesh | |
![]() | geometryLibrary : GeometryLibrary
Reference container for all geometries used in the container.
| Object3D | |
![]() | hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
| Mesh | |
![]() | hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
| Mesh | |
height : Number
Defines the height of the grid.
| GridPlane | ||
![]() | indexes : Array
Placeholder for md2 frame indexes
| Mesh | |
![]() | inverseSceneTransform : MatrixAway3D
Returns the inverse of sceneTransform.
| Object3D | |
![]() | isRunning : Boolean
Indicates whether the animation is currently running.
| Mesh | |
![]() | lightarray : ILightConsumer
returns the array of lights contained inside the container.
| Object3D | |
![]() | loop : Boolean
Determines whether the animation will loop.
| Mesh | |
![]() | material : IMaterial
Defines the material used to render the faces, segments or billboards in the geometry object.
| Mesh | |
![]() | 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 | |
![]() | outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
| Mesh | |
![]() | 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 | |
![]() | 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
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 | |
![]() | screenZOffset : Number
Defines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true
| Object3D | |
![]() | segmentMaterial : ISegmentMaterial | Mesh | |
![]() | segments : Array
Returns an array of the segments contained in the mesh object.
| Mesh | |
segmentsH : Number
Defines the number of vertical segments that make up the grid.
| GridPlane | ||
segmentsW : Number
Defines the number of horizontal segments that make up the grid.
| GridPlane | ||
![]() | session : AbstractRenderSession
The render session used by the 3d object
| Object3D | |
![]() | smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
| Mesh | |
![]() | transform : MatrixAway3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | transitionValue : Number | Mesh | |
![]() | type : String = "mesh"
String defining the type of class used to generate the mesh.
| Mesh | |
![]() | url : String
String defining the source of the mesh.
| Mesh | |
![]() | useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
| Object3D | |
![]() | vertices : Array
Returns an array of the vertices contained in the mesh object.
| Mesh | |
![]() | visible : Boolean
Defines whether the 3d object is visible in the scene
| Object3D | |
width : Number
Defines the width of the grid.
| GridPlane | ||
![]() | 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 | |
yUp : Boolean
Defines whether the coordinates of the grid points use a yUp orientation (true) or a zUp orientation (false).
| GridPlane | ||
![]() | z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D |
Method | Defined by | ||
---|---|---|---|
GridPlane
(init:Object = null)
Creates a new
GridPlane object. | GridPlane | ||
![]() |
Adds a billboard object to the mesh object.
| Mesh | |
![]() |
Adds a face object to the mesh object.
| Mesh | |
![]() |
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
| Mesh | |
![]() |
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 | |
![]() |
addOnSequenceDone(listener:Function):void
Default method for adding a sequenceDone event listener
| Mesh | |
![]() |
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 | |
![]() |
Adds a segment object to the mesh object.
| Mesh | |
![]() |
applyPosition(dx:Number, dy:Number, dz:Number):void
Apply the given position to the geometry without altering the appearance of the mesh
| Mesh | |
![]() |
applyRotations():void
Apply the local rotations to the geometry without altering the appearance of the mesh
| Mesh | |
![]() |
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
| Mesh | |
![]() |
asXML():XML
Returns an xml representation of the mesh
| Mesh | |
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
| GridPlane | ||
![]() |
centerPivot():void
| Object3D | |
![]() |
Duplicates the mesh properties to another 3d object
| Mesh | |
![]() |
Duplicates the mesh properties to another 3d object, including geometry
| Mesh | |
![]() |
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
| Object3D | |
![]() |
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
| Mesh | |
![]() |
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
| Mesh | |
![]() |
invertFaces():void
Inverts the geometry of all face objects.
| Mesh | |
![]() |
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 | |
![]() |
Plays a sequence of frames
| Mesh | |
![]() |
playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void
Plays a sequence of frames.
| Mesh | |
![]() |
Divides a face object into 4 equal sized face objects.
| Mesh | |
![]() |
quarterFaces():void
Divides all faces objects of a Mesh into 4 equal sized face objects.
| Mesh | |
![]() |
Removes a billboard object from the mesh object.
| Mesh | |
![]() |
Removes a face object from the mesh object.
| Mesh | |
![]() |
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
| Mesh | |
![]() |
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 | |
![]() |
removeOnSequenceDone(listener:Function):void
Default method for removing a sequenceDone event listener
| Mesh | |
![]() |
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 | |
![]() |
Removes a segment object from the mesh object.
| Mesh | |
![]() |
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 | |
![]() |
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
| Mesh | |
![]() |
Divides a face object into 2 face objects.
| Mesh | |
![]() |
splitFaces(side:int = 0):void
Divides all faces objects of a Mesh into 2 face objects.
| Mesh | |
![]() |
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 | |
![]() |
Divides a face object into 3 face objects.
| Mesh | |
![]() |
triFaces():void
Divides all faces objects of a Mesh into 3 face objects.
| Mesh | |
![]() |
Updates the materials in the mesh object
| Mesh | |
![]() |
updateObject():void
| AbstractWirePrimitive | |
![]() |
updateSession():void
| Object3D | |
![]() |
update vertex information.
| Mesh | |
![]() |
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
height | property |
height:Number
[read-write]Defines the height of the grid. Defaults to 100.
Implementation public function get height():Number
public function set height(value:Number):void
segmentsH | property |
segmentsH:Number
[read-write]Defines the number of vertical segments that make up the grid. Defaults to 1.
Implementation public function get segmentsH():Number
public function set segmentsH(value:Number):void
segmentsW | property |
segmentsW:Number
[read-write]Defines the number of horizontal segments that make up the grid. Defaults to 1.
Implementation public function get segmentsW():Number
public function set segmentsW(value:Number):void
width | property |
width:Number
[read-write]Defines the width of the grid. Defaults to 100.
Implementation public function get width():Number
public function set width(value:Number):void
yUp | property |
yUp:Boolean
[read-write]Defines whether the coordinates of the grid points use a yUp orientation (true) or a zUp orientation (false). Defaults to true.
Implementation public function get yUp():Boolean
public function set yUp(value:Boolean):void
GridPlane | () | constructor |
public function GridPlane(init:Object = null)
Parameters
init:Object (default = null ) — [optional] An initialisation object for specifying default instance properties.
|
width:Number (default = 100, min:0) | |
height:Number (default = 100, min:0) | |
segments:Int (default = 1, min:1) | |
segmentsW:Int (default = segments, min:1) | |
segmentsH:Int (default = segments, min:1) | |
yUp:Boolean (default = true) |
buildPrimitive | () | method |
public override function buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.