| Package | away3d.extrusions |
| Class | public class PathExtrude |
| Inheritance | PathExtrude  Mesh Entity ObjectContainer3D Object3D NamedAssetBase flash.events.EventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
| aligntoPath : Boolean [read-only]
Defines if the array of profile points should be orientated on path or not. | PathExtrude | ||
| alignToPath : Boolean [write-only] | PathExtrude | ||
 | 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 | |
| backVector : Vector3D [read-only]
| Object3D | |
| bounds : BoundingVolumeBase [override]
The bounding volume approximating the volume occupied by the Entity. | PathExtrude | ||
| castsShadows : Boolean
Indicates whether or not the Mesh can cast shadows. | Mesh | |
| centerMesh : Boolean
Defines whether the mesh is recentered of not after generation
| PathExtrude | ||
| closePath : Boolean
Defines if the last PathSegment should join the first one and close the loop. | PathExtrude | ||
| coverAll : Boolean
Defines if the texture(s) should be stretched to cover the entire mesh or per step between segments. | PathExtrude | ||
| coverSegment : Boolean
Defines if the texture(s) should applied per segment. | PathExtrude | ||
| distribute : Boolean
Defines if the mesh subdivision is spread evenly over the entire geometry. | PathExtrude | ||
| distributeU : Boolean
Defines the uv's u values are spreaded procentually over the entire surface to prevent the maps to be stretched. | PathExtrude | ||
| downVector : Vector3D [read-only]
| Object3D | |
| endProfile : Vector.<Vector3D> [read-only]
returns a vector of vector3d's representing the transformed profile coordinates at the end of the extrude shape
null if "keepExtremes" is false or if the extrusion has not been builded yet. | PathExtrude | ||
| 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. | PathExtrude | ||
| forwardVector : Vector3D [read-only]
| Object3D | |
| geometry : Geometry [override]
The geometry used by the mesh that provides it with its shape. | PathExtrude | ||
| ignoreTransform : Boolean [override] | Entity | |
| inverseSceneTransform : Matrix3D [read-only]
The inverse scene transform object that transforms from world to model space. | ObjectContainer3D | |
| keepExtremes : Boolean
Defines if the first and last transformed vector3d's of the profile are kept. | PathExtrude | ||
| leftVector : Vector3D [read-only]
| Object3D | |
| mapFit : Boolean
Defines if the texture(s) should be projected on the geometry evenly spreaded over the source bitmapdata or using distance/percent. | PathExtrude | ||
| material : MaterialBase
The material with which to render the Mesh. | Mesh | |
| materials : Vector.<MaterialBase>
An optional Vector.<MaterialBase>. | PathExtrude | ||
| 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 | |
| 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 | |
| path : IPath
Defines the Path object representing path to extrude along. | PathExtrude | ||
| 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 | |
| profile : Vector.<Vector3D>
Defines a Vector.<Vector3D> of Vector3D objects representing the profile information to be projected along the Path object. | PathExtrude | ||
| rightVector : Vector3D [read-only]
| Object3D | |
| rotations : Vector.<Vector3D>
An optional Vector.<Vector3D> of Vector3D objects that defines a series of rotations to be set on each PathSegment. | PathExtrude | ||
| 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 | |
| scales : Vector.<Vector3D>
An optional Vector.<Vector3D> of Vector3D objects that defines a series of scales to be set on each PathSegment. | PathExtrude | ||
| 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 | |
| shareAnimationGeometry : Boolean
Indicates whether or not the mesh share the same animation geometry. | Mesh | |
| showBounds : Boolean | Entity | |
| smoothScale : Boolean
Defines if a scaling of a PathSegment defined from the scales array of Vector3D objects should affect the whole PathSegment evenly or be smoothly interpolated from previous PathSegment scale. | PathExtrude | ||
| smoothSurface : Boolean
Defines if the surface of the mesh must be smoothed or not. | PathExtrude | ||
| startProfile : Vector.<Vector3D> [read-only]
returns a vector of vector3d's representing the transformed profile coordinates at the start of the extrude shape
null if "keepExtremes" is false or if the extrusion has not been builded yet. | PathExtrude | ||
| staticNode : Boolean
Defines whether or not the object will be moved or animated at runtime. | Entity | |
| subdivision : int
Defines the subdivisions created in the mesh for each PathSegment. | PathExtrude | ||
| subMeshes : Vector.<SubMesh> [override] [read-only]
The SubMeshes out of which the Mesh consists. | PathExtrude | ||
| transform : Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | |
| upAxis : Vector3D | PathExtrude | ||
| upVector : Vector3D [read-only]
| Object3D | |
| visible : Boolean | ObjectContainer3D | |
| worldBounds : BoundingVolumeBase [read-only] | Entity | |
| 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 | |
| zOffset : int | Object3D | |
| Method | Defined By | ||
|---|---|---|---|
PathExtrude(material:MaterialBase = null, path:IPath = null, profile:Vector.<Vector3D> = null, subdivision:uint = 2, coverAll:Boolean = true, coverSegment:Boolean = false, alignToPath:Boolean = true, centerMesh:Boolean = false, mapFit:Boolean = false, flip:Boolean = false, closePath:Boolean = false, materials:Vector.<MaterialBase> = null, scales:Vector.<Vector3D> = null, smoothScale:Boolean = true, rotations:Vector.<Vector3D> = null, smoothSurface:Boolean = true, distribute:Boolean = false, distributeU:Boolean = true, keepExtremes:Boolean = false)
Creates a new PathExtrude
| PathExtrude | ||
|
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 | |
| clearAnimationGeometry():void
Clears the animation geometry of this mesh. | Mesh | |
| [override]
Clones this Mesh instance along with all it's children, while re-using the same
material, geometry and animation set. | 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 | ||
| isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Boolean | 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 | |
| removeChild(child:ObjectContainer3D):void
Removes a 3d object from the child array of the container
| ObjectContainer3D | |
| removeChildAt(index:uint):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 | |
| aligntoPath | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesaligntoPath:Boolean [read-only] Defines if the array of profile points should be orientated on path or not. Default true. Note that Path object's worldaxis property might need to be changed. default = 0,1,0.
public function get aligntoPath():BooleanSee also
| alignToPath | property |
alignToPath:Boolean [write-only] public function set alignToPath(value:Boolean):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:BooleanDefines whether the mesh is recentered of not after generation
public function get centerMesh():Boolean public function set centerMesh(value:Boolean):void| closePath | property |
closePath:BooleanDefines if the last PathSegment should join the first one and close the loop. Defaults to false.
public function get closePath():Boolean public function set closePath(value:Boolean):void| coverAll | property |
coverAll:BooleanDefines 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| coverSegment | property |
coverSegment:BooleanDefines if the texture(s) should applied per segment. Default false.
public function get coverSegment():Boolean public function set coverSegment(value:Boolean):void| distribute | property |
distribute:BooleanDefines if the mesh subdivision is spread evenly over the entire geometry. Possibly resulting in uneven subdivision per segments. Uv mapping is less distorted on complex shapes once applied. Depending on Path length, extra construct time might be significant. Defaults to false.
public function get distribute():Boolean public function set distribute(value:Boolean):void| distributeU | property |
distributeU:BooleanDefines the uv's u values are spreaded procentually over the entire surface to prevent the maps to be stretched.
public function get distributeU():Boolean public function set distributeU(value:Boolean):void| endProfile | property |
endProfile:Vector.<Vector3D> [read-only] returns a vector of vector3d's representing the transformed profile coordinates at the end of the extrude shape null if "keepExtremes" is false or if the extrusion has not been builded yet.
public function get endProfile():Vector.<Vector3D>| flip | property |
flip:BooleanDefines 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| keepExtremes | property |
keepExtremes:BooleanDefines if the first and last transformed vector3d's of the profile are kept. For instance to be able to pass these coordinates to DelaunayMesh class, to close the extrude, if it was a tube.
public function get keepExtremes():Boolean public function set keepExtremes(value:Boolean):voidSee also
| mapFit | property |
mapFit:BooleanDefines if the texture(s) should be projected on the geometry evenly spreaded over the source bitmapdata or using distance/percent. Default is false. The mapping considers first and last profile points are the most distant from each other. Most left and most right on the map. Note that it is NOT suitable for most cases. It is helpfull for roads definition, usually seen from above with simple profile. It prevents then distorts and eases map designs.
public function get mapFit():Boolean public function set mapFit(value:Boolean):void| materials | property |
materials:Vector.<MaterialBase>An optional Vector.<MaterialBase>. It defines a series of materials to be set on each PathSegment if coverAll is set to false.
public function get materials():Vector.<MaterialBase> public function set materials(value:Vector.<MaterialBase>):void| path | property |
path:IPath
Defines the Path object representing path to extrude along. Required.
public function get path():IPath public function set path(value:IPath):void| profile | property |
profile:Vector.<Vector3D>Defines a Vector.<Vector3D> of Vector3D objects representing the profile information to be projected along the Path object. Required.
public function get profile():Vector.<Vector3D> public function set profile(value:Vector.<Vector3D>):void| rotations | property |
rotations:Vector.<Vector3D>
An optional Vector.<Vector3D> of Vector3D objects that defines a series of rotations to be set on each PathSegment.
public function get rotations():Vector.<Vector3D> public function set rotations(value:Vector.<Vector3D>):void| scales | property |
scales:Vector.<Vector3D>
An optional Vector.<Vector3D> of Vector3D objects that defines a series of scales to be set on each PathSegment.
public function get scales():Vector.<Vector3D> public function set scales(value:Vector.<Vector3D>):void| smoothScale | property |
smoothScale:Boolean
Defines if a scaling of a PathSegment defined from the scales array of Vector3D objects should affect the whole PathSegment evenly or be smoothly interpolated from previous PathSegment scale. Defaults to true.
public function get smoothScale():Boolean public function set smoothScale(value:Boolean):void| smoothSurface | property |
smoothSurface:BooleanDefines if the surface of the mesh must be smoothed or not.
public function get smoothSurface():Boolean public function set smoothSurface(value:Boolean):void| startProfile | property |
startProfile:Vector.<Vector3D> [read-only] returns a vector of vector3d's representing the transformed profile coordinates at the start of the extrude shape null if "keepExtremes" is false or if the extrusion has not been builded yet.
public function get startProfile():Vector.<Vector3D>| subdivision | property |
subdivision:intDefines the subdivisions created in the mesh for each PathSegment. Defaults to 2, minimum 2.
public function get subdivision():int public function set subdivision(value:int):void| 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>| upAxis | property |
upAxis:Vector3D public function get upAxis():Vector3D public function set upAxis(value:Vector3D):void| PathExtrude | () | Constructor |
public function PathExtrude(material:MaterialBase = null, path:IPath = null, profile:Vector.<Vector3D> = null, subdivision:uint = 2, coverAll:Boolean = true, coverSegment:Boolean = false, alignToPath:Boolean = true, centerMesh:Boolean = false, mapFit:Boolean = false, flip:Boolean = false, closePath:Boolean = false, materials:Vector.<MaterialBase> = null, scales:Vector.<Vector3D> = null, smoothScale:Boolean = true, rotations:Vector.<Vector3D> = null, smoothSurface:Boolean = true, distribute:Boolean = false, distributeU:Boolean = true, keepExtremes:Boolean = false)
Creates a new PathExtrude
material:MaterialBase (default = null) | |
path:IPath (default = null)Path object representing path to extrude along. Required for the class to work.
| |
profile:Vector.<Vector3D> (default = null) | |
subdivision:uint (default = 2) | |
coverAll:Boolean (default = true) | |
coverSegment:Boolean (default = false) | |
alignToPath:Boolean (default = true) | |
centerMesh:Boolean (default = false) | |
mapFit:Boolean (default = false) | |
flip:Boolean (default = false) | |
closePath:Boolean (default = false) | |
materials:Vector.<MaterialBase> (default = null) | |
scales:Vector.<Vector3D> (default = null)Vector3D objects that defines a series of scales to be set on each PathSegment.
| |
smoothScale:Boolean (default = true) | |
rotations:Vector.<Vector3D> (default = null)Vector3D objects that defines a series of rotations to be set on each PathSegment.
| |
smoothSurface:Boolean (default = true) | |
distribute:Boolean (default = false) | |
distributeU:Boolean (default = true) | |
keepExtremes:Boolean (default = false) |