View source

class PathExtrude

package away3d.extrusions

extends Mesh › Entity › ObjectContainer3D › Object3D › NamedAssetBase

Available on all platforms

Constructor

@:value({ keepExtremes : false, distributeU : true, distribute : false, smoothSurface : true, rotations : null, smoothScale : true, scales : null, materials : null, closePath : false, flip : false, mapFit : false, centerMesh : false, alignToPath : true, coverSegment : false, coverAll : true, subdivision : 2, profile : null, path : null, material : null })new(?material:MaterialBase, ?path:IPath, ?profile:Vector<Vector3D>, subdivision:Int = 2, coverAll:Bool = true, coverSegment:Bool = false, alignToPath:Bool = true, centerMesh:Bool = false, mapFit:Bool = false, flip:Bool = false, closePath:Bool = false, ?materials:Vector<MaterialBase>, ?scales:Vector<Vector3D>, smoothScale:Bool = true, ?rotations:Vector<Vector3D>, smoothSurface:Bool = true, distribute:Bool = false, distributeU:Bool = true, keepExtremes:Bool = false)

Creates a new PathExtrude

Parameters:

material

[optional] MaterialBase. The PathExtrude (Mesh) material. Optional in constructor, material must be set before PathExtrude object is rendered. Required for the class to work.

path

[optional] Path. Defines the Path object representing path to extrude along. Required for the class to work.

profile

[optional] Vector.<Vector3D>. Defines an Vector.<Vector3D> of Vector3D objects representing the profile information to be projected along the Path object. Required for the class to work.

subdivision

[optional] uint. Howmany steps between each PathSegment. If the path holds curves, the higher this value, the higher the curve fidelity. Default and minimum is 2;

coverall

[optional] Boolean. Defines the uv mapping, when true a unique material is stretched along the entire path/shape. Default is true.

coverSegment

[optional] Boolean. Defines the uv mapping, when true and coverall is false a unique material is stretched along one PathSegment. Default is false.

alignToPath

[optional] Boolean. If the profile must follow the path or keep its original orientation.

centerMesh

[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.

mapFit

[optional] Boolean. The UV mapping is percentually spreaded over the width of the path, making texture looking nicer and edits for applications such as a race track, road, more easy. Affects the uv's u values and set distributeU to false. Default is false.

flip

[optional] Boolean. If the faces must be reversed depending on Vector3D's orientation. Default is false.

closePath

[optional] Boolean. If the last PathSegment entered must be welded back to first one. Executed in a straight manner, its recommanded to pass the first entry to the Path again, as last entry if curves are involved.

materials

[optional] Vector.<MaterialBase>. An optional Vector.<MaterialBase> of different materials that can be alternated along the path if coverAll is false.

scales

[optional] An optional Vector.<Vector3D> of Vector3D objects that defines a series of scales to be set on each PathSegment.

smoothScale

[optional] Boolean. Defines if the scale must be interpolated between values or keep their full aspect on each PathSegment.

rotations

[optional] An optional Vector.<Vector3D> of Vector3D objects that defines a series of rotations to be set on each PathSegment.

smoothSurface

[optional] An optional Boolean. Defines if the surface of the mesh must be smoothed or not. Default is true.

distribute

[optional] Boolean. If the mesh subdivision is evenly spreaded over the entire mesh. Depending on path definition, segments are possibly not having the same amount of subdivision.

distributeU

[optional] Boolean. If the mesh uv' u value is procentually spreaded over the entire mesh surface. Prevents the source map to be stretched. Default is true.

keepExtremes

[optional] Boolean. If the the first and last profile coordinates must be kept accessible, in order to feed classes such as DelaunayMesh. Default is false;

Variables

write onlyalignToPath:Bool

read onlyaligntoPath:Bool

centerMesh:Bool

closePath:Bool

coverAll:Bool

coverSegment:Bool

distribute:Bool

distributeU:Bool

read onlyendProfile:Vector<Vector3D>

flip:Bool

keepExtremes:Bool

mapFit:Bool

materials:Vector<MaterialBase>

path:IPath

profile:Vector<Vector3D>

rotations:Vector<Vector3D>

scales:Vector<Vector3D>

smoothScale:Bool

smoothSurface:Bool

read onlystartProfile:Vector<Vector3D>

subdivision:Int

upAxis:Vector3D

Inherited Variables

Defined by Mesh

Defined by Entity

Defined by ObjectContainer3D

read onlyassetType:String

ignoreTransform:Bool

read onlyinverseSceneTransform:Matrix3D

read onlymaxX:Float

read onlymaxY:Float

read onlymaxZ:Float

read onlyminX:Float

read onlyminY:Float

read onlyminZ:Float

mouseChildren:Bool

mouseEnabled:Bool

read onlynumChildren:Int

read onlyparent:ObjectContainer3D

partition:Partition3D

scene:Scene3D

read onlyscenePosition:Vector3D

read onlysceneTransform:Matrix3D

visible:Bool

Defined by Object3D

read onlybackVector:Vector3D

read onlydownVector:Vector3D

eulers:Vector3D

extra:Dynamic

An object that can contain any extra data.

read onlyforwardVector:Vector3D

read onlyleftVector:Vector3D

pivotPoint:Vector3D

position:Vector3D

read onlyrightVector:Vector3D

rotationX:Float

rotationY:Float

rotationZ:Float

scaleX:Float

scaleY:Float

scaleZ:Float

transform:Matrix3D

read onlyupVector:Vector3D

x:Float

y:Float

z:Float

zOffset:Int

Defined by NamedAssetBase

read onlyassetFullPath:Array<Dynamic>

read onlyassetNamespace:String

id:String

name:String

read onlyoriginalName:String

Inherited Methods

Defined by Mesh

bakeTransformations():Void

clearAnimationGeometry():Void

Clears the animation geometry of this mesh. It will cause animation to generate a new animation geometry. Work only when shareAnimationGeometry is false.

clone():Mesh

Clones this Mesh instance along with all it's children, while re-using the same material, geometry and animation set. The returned result will be a copy of this mesh, containing copies of all of it's children.

Properties that are re-used (i.e. not cloned) by the new copy include name, geometry, and material. Properties that are cloned or created anew for the copy include subMeshes, children of the mesh, and the animator.

If you want to copy just the mesh, reusing it's geometry and material while not cloning it's children, the simplest way is to create a new mesh manually:

var clone : Mesh = new Mesh(original.geometry, original.material);

dispose():Void

@inheritDoc

disposeWithAnimatorAndChildren():Void

Disposes mesh including the animator and children. This is a merely a convenience method. @return

getSubMeshForSubGeometry(subGeometry:ISubGeometry):SubMesh

Defined by Entity

getEntityPartitionNode():EntityNode

Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance

internalUpdate():Void

isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Bool

Defined by ObjectContainer3D

addChild(child:ObjectContainer3D):ObjectContainer3D

Adds a child ObjectContainer3D to the current object. The child's transformation will become relative to the current object's transformation.

Parameters:

child

The object to be added as a child.

Returns:

A reference to the added child object.

addChildren(childarray:Vector<ObjectContainer3D>):Void

Adds an array of 3d objects to the scene as children of the container

Parameters:

...childarray

An array of 3d objects to be added

contains(child:ObjectContainer3D):Bool

dispatchEvent(event:Event):Bool

@inheritDoc

disposeWithChildren():Void

Disposes the current ObjectContainer3D including all of its children. This is a merely a convenience method.

getChildAt(index:Int):ObjectContainer3D

Retrieves the child object at the given index.

Parameters:

index

The index of the object to be retrieved.

Returns:

The child object at the given index.

@:value({ upAxis : null })lookAt(target:Vector3D, ?upAxis:Vector3D):Void

@inheritDoc

removeChild(child:ObjectContainer3D):Void

Removes a 3d object from the child array of the container

Parameters:

child

The 3d object to be removed

Throws:

Error

ObjectContainer3D.removeChild(null)

removeChildAt(index:Int):Void

Removes a 3d object from the child array of the container

Parameters:

index

Index of 3d object to be removed

updateImplicitVisibility():Void

Defined by Object3D

disposeAsset():Void

@inheritDoc

@:value({ v : null })getPosition(?v:Vector3D):Vector3D

Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. @return

Parameters:

v

the destination Vector3D

moveBackward(distance:Float):Void

Moves the 3d object backwards along it's local z axis

Parameters:

distance

The length of the movement

moveDown(distance:Float):Void

Moves the 3d object backwards along it's local y axis

Parameters:

distance

The length of the movement

moveForward(distance:Float):Void

Moves the 3d object forwards along it's local z axis

Parameters:

distance

The length of the movement

moveLeft(distance:Float):Void

Moves the 3d object backwards along it's local x axis

Parameters:

distance

The length of the movement

movePivot(dx:Float, dy:Float, dz:Float):Void

Moves the local point around which the object rotates.

Parameters:

dx

The amount of movement along the local x axis.

dy

The amount of movement along the local y axis.

dz

The amount of movement along the local z axis.

moveRight(distance:Float):Void

Moves the 3d object forwards along it's local x axis

Parameters:

distance

The length of the movement

moveTo(dx:Float, dy:Float, dz:Float):Void

Moves the 3d object directly to a point in space

Parameters:

dx

The amount of movement along the local x axis.

dy

The amount of movement along the local y axis.

dz

The amount of movement along the local z axis.

moveUp(distance:Float):Void

Moves the 3d object forwards along it's local y axis

Parameters:

distance

The length of the movement

pitch(angle:Float):Void

Rotates the 3d object around it's local x-axis

Parameters:

angle

The amount of rotation in degrees

roll(angle:Float):Void

Rotates the 3d object around it's local z-axis

Parameters:

angle

The amount of rotation in degrees

rotateTo(ax:Float, ay:Float, az:Float):Void

Rotates the 3d object directly to a euler angle

Parameters:

ax

The angle in degrees of the rotation around the x axis.

ay

The angle in degrees of the rotation around the y axis.

az

The angle in degrees of the rotation around the z axis.

scale(value:Float):Void

Appends a uniform scale to the current transformation.

Parameters:

value

The amount by which to scale.

translate(axis:Vector3D, distance:Float):Void

Moves the 3d object along a vector by a defined length

Parameters:

axis

The vector defining the axis of movement

distance

The length of the movement

yaw(angle:Float):Void

Rotates the 3d object around it's local y-axis

Parameters:

angle

The amount of rotation in degrees

Defined by NamedAssetBase

assetPathEquals(name:String, ns:String):Bool

@:value({ overrideOriginal : true, ns : null })resetAssetPath(name:String, ?ns:String, overrideOriginal:Bool = true):Void