Package | away3d.extrusions |
Class | public class LatheExtrude |
Inheritance | LatheExtrude Mesh Entity ObjectContainer3D Object3D NamedAssetBase flash.events.EventDispatcher |
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 | ||
axis : String
Defines the axis used for the lathe rotation. | LatheExtrude | ||
backVector : Vector3D [read-only]
| Object3D | ||
bounds : BoundingVolumeBase [override]
The bounding volume approximating the volume occupied by the Entity. | LatheExtrude | ||
castsShadows : Boolean
Indicates whether or not the Mesh can cast shadows
| Mesh | ||
centerMesh : Boolean
Defines whether the mesh is recentered of not after generation
| LatheExtrude | ||
coverAll : Boolean
Defines if the texture(s) should be stretched to cover the entire mesh or per step between segments. | LatheExtrude | ||
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 | ||
flip : Boolean
Defines if the generated faces should be inversed. | LatheExtrude | ||
forwardVector : Vector3D [read-only]
| Object3D | ||
geometry : Geometry [override]
The geometry used by the mesh that provides it with its shape. | LatheExtrude | ||
ignoreSides : String
Defines if the top, bottom, left, right, front or back of the the extrusion is left open. | LatheExtrude | ||
inverseSceneTransform : Matrix3D [read-only]
The inverse scene transform object that transforms from world to model space. | ObjectContainer3D | ||
keepLastProfile : Boolean
Defines if the last transformed profile values are saved or not. | LatheExtrude | ||
lastProfile : Vector.<Vector3D> [read-only]
returns the last rotated profile values, if keepLastProfile was true
| LatheExtrude | ||
leftVector : Vector3D [read-only]
| Object3D | ||
material : MaterialBase
The material with which to render the Mesh. | Mesh | ||
materials : MultipleMaterials
An optional object that defines left, right, front, back, top and bottom materials to be set on the resulting lathe extrusion. | LatheExtrude | ||
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 | ||
offsetRadius : Number
Defines an offset radius applied to the profile. | LatheExtrude | ||
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 | ||
preciseThickness : Boolean
Defines if thickness is greater than 0 if the thickness is equally distributed along the volume. | LatheExtrude | ||
profile : Vector.<Vector3D> | LatheExtrude | ||
revolutions : Number
Defines the number of revolutions performed by the lathe extrusion. | LatheExtrude | ||
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 | ||
smoothSurface : Boolean
Defines if the surface of the mesh must be smoothed or not. | LatheExtrude | ||
startRotationOffset : Number | LatheExtrude | ||
subdivision : uint
Defines the subdivisions created in the mesh for the total number of revolutions. | LatheExtrude | ||
subMeshes : Vector.<SubMesh> [override] [read-only]
The SubMeshes out of which the Mesh consists. | LatheExtrude | ||
thickness : Number
Defines the thickness of the resulting lathed geometry. | LatheExtrude | ||
transform : Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
tweek : Object
Allows the building of shapes such as springs. | LatheExtrude | ||
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 |
Method | Defined By | ||
---|---|---|---|
LatheExtrude(material:MaterialBase = null, profile:Vector.<Vector3D> = null, axis:String, revolutions:Number = 1, subdivision:uint = 10, coverall:Boolean = true, centerMesh:Boolean = false, flip:Boolean = false, thickness:Number = 0, preciseThickness:Boolean = true, offsetRadius:Number = 0, materials:MultipleMaterials = null, ignoreSides:String, tweek:Object = null, smoothSurface:Boolean = true)
Class LatheExtrude generates circular meshes such as donuts, pipes, pyramids etc.. | LatheExtrude | ||
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 | ||
[override]
Clones this Mesh instance along with all it's children, while re-using the same
material and geometry instance. | 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 | ||
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 | |||
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 |
Constant | Defined By | ||
---|---|---|---|
DEFAULT_NAMESPACE : String = default [static] | NamedAssetBase | ||
X_AXIS : String = x [static] | LatheExtrude | ||
Y_AXIS : String = y [static] | LatheExtrude | ||
Z_AXIS : String = z [static] | LatheExtrude |
axis | property |
axis:String
Defines the axis used for the lathe rotation. Defaults to "y".
public function get axis():String
public function set axis(value:String):void
bounds | property |
bounds:BoundingVolumeBase
[override] The bounding volume approximating the volume occupied by the Entity.
public function get bounds():BoundingVolumeBase
public function set bounds(value:BoundingVolumeBase):void
centerMesh | property |
centerMesh:Boolean
Defines whether the mesh is recentered of not after generation
public function get centerMesh():Boolean
public function set centerMesh(value:Boolean):void
coverAll | property |
coverAll:Boolean
Defines if the texture(s) should be stretched to cover the entire mesh or per step between segments. Defaults to true.
public function get coverAll():Boolean
public function set coverAll(value:Boolean):void
flip | property |
flip:Boolean
Defines if the generated faces should be inversed. Default false.
public function get flip():Boolean
public function set flip(value:Boolean):void
geometry | property |
geometry:Geometry
[override] The geometry used by the mesh that provides it with its shape.
public function get geometry():Geometry
public function set geometry(value:Geometry):void
ignoreSides | property |
ignoreSides:String
Defines if the top, bottom, left, right, front or back of the the extrusion is left open.
public function get ignoreSides():String
public function set ignoreSides(value:String):void
keepLastProfile | property |
keepLastProfile:Boolean
Defines if the last transformed profile values are saved or not. Useful in combo with rotations less than 1, to ease combinations with other extrusions classes such as SkinExtrude.
public function get keepLastProfile():Boolean
public function set keepLastProfile(value:Boolean):void
lastProfile | property |
lastProfile:Vector.<Vector3D>
[read-only] returns the last rotated profile values, if keepLastProfile was true
public function get lastProfile():Vector.<Vector3D>
materials | property |
materials:MultipleMaterials
An optional object that defines left, right, front, back, top and bottom materials to be set on the resulting lathe extrusion.
public function get materials():MultipleMaterials
public function set materials(value:MultipleMaterials):void
offsetRadius | property |
offsetRadius:Number
Defines an offset radius applied to the profile. Defaults to 0.
public function get offsetRadius():Number
public function set offsetRadius(value:Number):void
preciseThickness | property |
preciseThickness:Boolean
Defines if thickness is greater than 0 if the thickness is equally distributed along the volume. Default is false.
public function get preciseThickness():Boolean
public function set preciseThickness(value:Boolean):void
profile | property |
profile:Vector.<Vector3D>
public function get profile():Vector.<Vector3D>
public function set profile(value:Vector.<Vector3D>):void
revolutions | property |
revolutions:Number
Defines the number of revolutions performed by the lathe extrusion. Defaults to 1.
public function get revolutions():Number
public function set revolutions(value:Number):void
smoothSurface | property |
smoothSurface:Boolean
Defines if the surface of the mesh must be smoothed or not.
public function get smoothSurface():Boolean
public function set smoothSurface(value:Boolean):void
startRotationOffset | property |
startRotationOffset:Number
public function get startRotationOffset():Number
public function set startRotationOffset(value:Number):void
subdivision | property |
subdivision:uint
Defines the subdivisions created in the mesh for the total number of revolutions. Defaults to 2, minimum 2.
public function get subdivision():uint
public function set subdivision(value:uint):void
See also
subMeshes | property |
subMeshes:Vector.<SubMesh>
[read-only] [override] 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>
thickness | property |
thickness:Number
Defines the thickness of the resulting lathed geometry. Defaults to 0 (single face).
public function get thickness():Number
public function set thickness(value:Number):void
tweek | property |
tweek:Object
Allows the building of shapes such as springs. Rotation must be higher than 1 to have significant effect. Properties of the objects are x,y,z,radius and rotation
public function get tweek():Object
public function set tweek(value:Object):void
LatheExtrude | () | Constructor |
public function LatheExtrude(material:MaterialBase = null, profile:Vector.<Vector3D> = null, axis:String, revolutions:Number = 1, subdivision:uint = 10, coverall:Boolean = true, centerMesh:Boolean = false, flip:Boolean = false, thickness:Number = 0, preciseThickness:Boolean = true, offsetRadius:Number = 0, materials:MultipleMaterials = null, ignoreSides:String, tweek:Object = null, smoothSurface:Boolean = true)
Class LatheExtrude generates circular meshes such as donuts, pipes, pyramids etc.. from a series of Vector3D's param material [optional] MaterialBase. The LatheExtrude (Mesh) material. Optional in constructor, material must be set before LatheExtrude object is render.
Parametersmaterial:MaterialBase (default = null ) — [optional] Vector.<Vector3D>. A series of Vector3D's representing the profile information to be repeated/rotated around a given axis.
| |
profile:Vector.<Vector3D> (default = null ) — [optional] String. The axis to rotate around: X_AXIS, Y_AXIS or Z_AXIS. Default is LatheExtrude.Y_AXIS.
| |
axis:String (default = NaN ) — [optional] Number. The LatheExtrude object can have less than one revolution, like 0.6 for a piechart or greater than 1 if a tweek object is passed. Minimum is 0.01. Default is 1.
| |
revolutions:Number (default = 1 ) — [optional] uint. Howmany segments will compose the mesh in its rotational construction. Minimum is 3. Default is 10.
| |
subdivision:uint (default = 10 ) — [optional] Boolean. The way the uv mapping is spreaded across the shape. True covers an entire side of the geometry while false covers per segments. Default is true.
| |
coverall:Boolean (default = true ) — [optional] Boolean. If the faces must be reversed depending on Vector3D's orientation. Default is false.
| |
centerMesh:Boolean (default = false ) — [optional] Number. If the shape must simulate a thickness. Default is 0.
| |
flip:Boolean (default = false ) — [optional] Boolean. If the thickness must be repected along the entire volume profile. Default is true.
| |
thickness:Number (default = 0 ) — [optional] Boolean. If the geometry needs to be recentered in its own object space. If the position after generation is set to 0,0,0, the object would be centered in worldspace. Default is false.
| |
preciseThickness:Boolean (default = true ) — [optional] Number. An offset radius if the profile data is not to be updated but the radius expected to be different. Default is 0.
| |
offsetRadius:Number (default = 0 ) — [optional] MultipleMaterials. Allows multiple material support when thickness is set higher to 1. Default is null.
properties as MaterialBase are: bottom, top, left, right, front and back.
| |
materials:MultipleMaterials (default = null ) — [optional] String. To prevent the generation of sides if thickness is set higher than 0. To avoid the bottom ignoreSides = "bottom", avoiding both top and bottom: ignoreSides = "bottom, top". Strings options: bottom, top, left, right, front and back. Default is "".
| |
ignoreSides:String — [optional] Object. To build springs like shapes, rotation must be higher than 1. Properties of the tweek object are x,y,z, radius and rotation. Default is null.
| |
tweek:Object (default = null ) — [optional] An optional Boolean. Defines if the surface of the mesh must be smoothed or not.
| |
smoothSurface:Boolean (default = true )
|
X_AXIS | Constant |
public static const X_AXIS:String = x
Y_AXIS | Constant |
public static const Y_AXIS:String = y
Z_AXIS | Constant |
public static const Z_AXIS:String = z