Package | away3d.primitives |
Class | public class Cylinder |
Inheritance | Cylinder AbstractPrimitive Mesh 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 | ||
back : Material
Defines a triangle material to be used for the backface of all faces in the 3d 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
| AbstractPrimitive | ||
center : Array | Object3D | ||
collider : Boolean
Indicates whether this object is used for collision detection.
| Object3D | ||
commands : Array
Returns an array of the commands contained in the mesh object.
| Mesh | ||
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.
| AbstractPrimitive | ||
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 | ||
faces : Array
Returns an array of the faces contained in the mesh object.
| AbstractPrimitive | ||
faceVOs : Array
Returns an array of the faceVOs contained in the mesh object.
| Mesh | ||
filters : Array
An optional array of filters that can be applied to the 3d object.
| Object3D | ||
geometry : Geometry
Defines the geometry object used for the mesh.
| AbstractPrimitive | ||
geometryLibrary : GeometryLibrary
Reference container for all geometries used in the container.
| Object3D | ||
height : Number
Defines the height of the cylinder.
| Cylinder | ||
id : int | Object3D | ||
indexes : Array
Placeholder for md2 frame indexes
| Mesh | ||
indices : Array
Returns an array of the indices contained in the mesh object.
| Mesh | ||
inverseSceneTransform : MatrixAway3D
Returns the inverse of sceneTransform.
| Object3D | ||
lightarray : ILightConsumer
returns the array of lights contained inside the container.
| Object3D | ||
material : Material
Defines the material used to render the faces, segments or 3d sprites 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
| AbstractPrimitive | ||
maxY : Number
Returns the maximum y value of the 3d object
| AbstractPrimitive | ||
maxZ : Number
Returns the maximum z value of the 3d object
| AbstractPrimitive | ||
minX : Number
Returns the minimum x value of the 3d object
| AbstractPrimitive | ||
minY : Number
Returns the minimum y value of the 3d object
| AbstractPrimitive | ||
minZ : Number
Returns the minimum z value of the 3d object
| AbstractPrimitive | ||
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
| AbstractPrimitive | ||
objectHeight : Number
Boundary height of the 3d object
return The height of the mesh
| AbstractPrimitive | ||
objectWidth : Number
Boundary width of the 3d object
return The width of the object
| AbstractPrimitive | ||
openEnded : Boolean
Defines whether the ends of the cylinder are left open (true) or closed (false).
| Cylinder | ||
outline : Material
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 | ||
radius : Number
Defines the radius of the cylinder.
| Cylinder | ||
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 | ||
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 | ||
segments : Array
Returns an array of the segments contained in the mesh object.
| AbstractPrimitive | ||
segmentsH : Number
Defines the number of vertical segments that make up the cylinder.
| Cylinder | ||
segmentsW : Number
Defines the number of horizontal segments that make up the cylinder.
| Cylinder | ||
segmentVOs : Array
Returns an array of the segmentVOs contained in the mesh object.
| Mesh | ||
session : AbstractRenderSession
The render session used by the 3d object
| Object3D | ||
sprites : Array
Returns an array of the 3d sprites contained in the mesh object.
| AbstractPrimitive | ||
spriteVOs : Array
Returns an array of the spriteVOs contained in the mesh object.
| Mesh | ||
startIndices : Array
Returns an array of the start indices contained in the mesh object.
| Mesh | ||
transform : MatrixAway3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | ||
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.
| AbstractPrimitive | ||
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 | ||
yUp : Boolean
Defines whether the coordinates of the cylinder points use a yUp orientation (true) or a zUp orientation (false).
| Cylinder | ||
z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D |
Method | Defined by | ||
---|---|---|---|
Cylinder
(init:Object = null)
Creates a new
Cylinder object. | Cylinder | ||
Adds a face object to the mesh object.
| 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 | ||
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 | ||
Adds a sprite3d 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 | ||
centerPivot():void
Adjusts the pivot point of the object so that it lies at the center of it's geoemtry.
| 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 | ||
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 | ||
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 face object from the mesh object.
| 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 | ||
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 | ||
Removes a 3d sprite 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 | ||
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
| AbstractPrimitive | ||
updateSession():void
| Object3D | ||
update vertex information.
| Mesh | ||
Returns the vertex object specified by the grid position of the mesh.
| Cylinder | ||
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
Method | Defined by | ||
---|---|---|---|
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
| Cylinder | ||
updateDimensions():void
| Mesh | ||
updatePrimitive():void
| AbstractPrimitive | ||
updateTransform():void
| Object3D |
height | property |
height:Number
[read-write]Defines the height of the cylinder. Defaults to 200.
Implementation public function get height():Number
public function set height(value:Number):void
openEnded | property |
openEnded:Boolean
[read-write]Defines whether the ends of the cylinder are left open (true) or closed (false). Defaults to false.
Implementation public function get openEnded():Boolean
public function set openEnded(value:Boolean):void
radius | property |
radius:Number
[read-write]Defines the radius of the cylinder. Defaults to 100.
Implementation public function get radius():Number
public function set radius(value:Number):void
segmentsH | property |
segmentsH:Number
[read-write]Defines the number of vertical segments that make up the cylinder. 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 cylinder. Defaults to 8.
Implementation public function get segmentsW():Number
public function set segmentsW(value:Number):void
yUp | property |
yUp:Boolean
[read-write]Defines whether the coordinates of the cylinder 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
Cylinder | () | constructor |
public function Cylinder(init:Object = null)
Parameters
init:Object (default = null ) — [optional] An initialisation object for specifying default instance properties.
|
radius:Number (default = 100, min:0) | |
height:Number (default = 200, min:0) | |
segmentsW:Int (default = 8, min:3) | |
segmentsH:Int (default = 1, min:1) | |
openEnded:Boolean (default = false) | |
yUp:Boolean (default = true) |
buildPrimitive | () | method |
protected override function buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
vertex | () | method |
public function vertex(w:int, h:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
Parametersw:int — The horizontal position on the primitive mesh.
|
|
h:int — The vertical position on the primitive mesh.
|
Vertex |