away3d.extrusions.Elevation

Public Properties

	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
		backVector : Vector3D [read-only]	Object3D
		bounds : BoundingVolumeBase The bounding volume approximating the volume occupied by the Entity.	Entity
		castsShadows : Boolean Indicates whether or not the Mesh can cast shadows	Mesh
		depth : Number The depth of the terrain plane.	Elevation
		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
		forwardVector : Vector3D [read-only]	Object3D
		geometry : Geometry The geometry used by the mesh that provides it with its shape.	Mesh
		height : Number	Elevation
		ignoreTransform : Boolean [override]	Entity
		inverseSceneTransform : Matrix3D [read-only] The inverse scene transform object that transforms from world to model space.	ObjectContainer3D
		leftVector : Vector3D [read-only]	Object3D
		material : MaterialBase The material with which to render the Mesh.	Mesh
		maxElevation : uint Locks elevation factor above this color reading level.	Elevation
		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
		minElevation : uint Locks elevation factor beneath this color reading level.	Elevation
		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
		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
		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
		segmentsH : uint The number of segments that make up the plane along the Y or Z-axis, depending on whether yUp is true or false, respectively.	Elevation
		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
		smoothedHeightMap : BitmapData [read-only]	Elevation
		staticNode : Boolean Defines whether or not the object will be moved or animated at runtime.	Entity
		subMeshes : Vector.<SubMesh> [read-only] The SubMeshes out of which the Mesh consists.	Mesh
		transform : Matrix3D The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		upVector : Vector3D [read-only]	Object3D
		visible : Boolean	ObjectContainer3D
		width : Number The width of the terrain plane.	Elevation
		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

	Property	Defined By
		_bounds : BoundingVolumeBase	Entity
		_boundsInvalid : Boolean = true	Entity
		_explicitPartition : Partition3D	ObjectContainer3D
		_geomDirty : Boolean = true	Elevation
		_geometry : Geometry	Mesh
		_ignoreTransform : Boolean = false	ObjectContainer3D
		_implicitPartition : Partition3D	ObjectContainer3D
		_mouseEnabled : Boolean	ObjectContainer3D
		_mvpIndex : int = -1	Entity
		_mvpTransformStack : Vector.<Matrix3D>	Entity
		_parent : ObjectContainer3D	ObjectContainer3D
		_pivotPoint : Vector3D	Object3D
		_pivotZero : Boolean = true	Object3D
		_pos : Vector3D	Object3D
		_rot : Vector3D	Object3D
		_sca : Vector3D	Object3D
		_scaleX : Number = 1	Object3D
		_scaleY : Number = 1	Object3D
		_scaleZ : Number = 1	Object3D
		_scene : Scene3D	ObjectContainer3D
		_sceneTransform : Matrix3D	ObjectContainer3D
		_sceneTransformDirty : Boolean = true	ObjectContainer3D
		_stackLen : uint	Entity
		_transform : Matrix3D	Object3D
		_transformComponents : Vector.<Vector3D>	Object3D
		_uvDirty : Boolean = true	Elevation
		_x : Number = 0	Object3D
		_y : Number = 0	Object3D
		_z : Number = 0	Object3D
		_zIndices : Vector.<Number>	Entity

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Elevation(material:MaterialBase, heightMap:BitmapData, width:Number = 1000, height:Number = 100, depth:Number = 1000, segmentsW:uint = 30, segmentsH:uint = 30, maxElevation:uint = 255, minElevation:uint = 0, smoothMap:Boolean = false) Class Elevation generates (and becomes) a mesh from an heightmap.	Elevation
		addChild(child:ObjectContainer3D):ObjectContainer3D 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
		clone():Object3D [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
		generateSmoothedHeightMap():BitmapData Generates a smoother representation of the geometry using the original heightmap and subdivision settings.	Elevation
		getChildAt(index:uint):ObjectContainer3D Retrieves the child object at the given index.	ObjectContainer3D
		getEntityPartitionNode():EntityNode Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance	Entity
		getHeightAt(x:Number, z:Number):Number Reading the terrain height from a given x z position for surface tracking purposes	Elevation
		getSubMeshForSubGeometry(subGeometry:SubGeometry):SubMesh	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, updateZIndex:Boolean = true):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

	Method	Defined By
		createEntityPartitionNode():EntityNode [override] Factory method that returns the current partition node.	Mesh
		getDefaultBoundingVolume():BoundingVolumeBase Creates the default bounding box to be used by this type of Entity.	Entity
		invalidateBounds():void Invalidates the bounding volume, causing to be updated when requested.	Entity
		invalidateGeometry():void Invalidates the primitive's geometry, causing it to be updated when requested.	Elevation
		invalidateSceneTransform():void [override] Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.	Entity
		invalidateUVs():void Invalidates the primitive's uv coordinates, causing them to be updated when requested.	Elevation
		updateBounds():void [override] Updates the bounding volume for the object.	Mesh
		updateMouseChildren():void [override]	Entity
		updateSceneTransform():void Updates the scene transformation matrix.	ObjectContainer3D
		updateTransform():void	Object3D

Summary	Defined By
mouseDown3d	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	ObjectContainer3D
mouseMove3d	Dispatched when a user moves the cursor while it is over the 3d object.	ObjectContainer3D
mouseOut3d	Dispatched when a user moves the cursor away from the 3d object.	ObjectContainer3D
mouseOver3d	Dispatched when a user moves the cursor over the 3d object.	ObjectContainer3D
mouseUp3d	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	ObjectContainer3D
positionChanged	Dispatched when the position of the 3d object changes.	Object3D
rotationChanged	Dispatched when the rotation of the 3d object changes.	Object3D
scaleChanged	Dispatched when the scale of the 3d object changes.	Object3D
sceneChanged	Dispatched when the parent scene of the 3d object changes.	ObjectContainer3D
scenetransformChanged	Dispatched when the scene transform matrix of the 3d object changes.	ObjectContainer3D

	Constant	Defined By
		DEFAULT_NAMESPACE : String = default [static]	NamedAssetBase

Property Detail

_geomDirty

property

protected var _geomDirty:Boolean = true

_uvDirty

property

protected var _uvDirty:Boolean = true

depth

property

depth:Number

The depth of the terrain plane.

Implementation
public function get depth():Number
public function set depth(value:Number):void

height

property

height:Number

Implementation
public function get height():Number
public function set height(value:Number):void

maxElevation

property

maxElevation:uint

Locks elevation factor above this color reading level. Default is 255; Allows to build "canyon" like landscapes with no additional work on heightmap source.

Implementation
public function get maxElevation():uint
public function set maxElevation(value:uint):void

minElevation

property

minElevation:uint

Locks elevation factor beneath this color reading level. Default is 0;

Implementation
public function get minElevation():uint
public function set minElevation(value:uint):void

segmentsH

property

segmentsH:uint

The number of segments that make up the plane along the Y or Z-axis, depending on whether yUp is true or false, respectively. Defaults to 1.

Implementation
public function get segmentsH():uint
public function set segmentsH(value:uint):void

smoothedHeightMap

property

smoothedHeightMap:BitmapData [read-only]

Implementation
public function get smoothedHeightMap():BitmapData

width

property

width:Number

The width of the terrain plane.

Implementation
public function get width():Number
public function set width(value:Number):void

Constructor Detail

Elevation

()

Constructor

public function Elevation(material:MaterialBase, heightMap:BitmapData, width:Number = 1000, height:Number = 100, depth:Number = 1000, segmentsW:uint = 30, segmentsH:uint = 30, maxElevation:uint = 255, minElevation:uint = 0, smoothMap:Boolean = false)

Class Elevation generates (and becomes) a mesh from an heightmap. Elevation

Parameters

	`material:MaterialBase` — MaterialBase. The Mesh (Elevation) material

	`heightMap:BitmapData` — BitmapData. The heightmap to generate the mesh from

	`width:Number` (default = `1000`) — [optional] Number. The width of the mesh. Default is 1000.

	`height:Number` (default = `100`) — [optional] Number. The height of the mesh. Default is 100.

	`depth:Number` (default = `1000`) — [optional] Number. The depth of the mesh. Default is 1000.

	`segmentsW:uint` (default = `30`) — [optional] uint. The subdivision of the mesh along the x axis. Default is 30.

	`segmentsH:uint` (default = `30`) — [optional] uint. The subdivision of the mesh along the y axis. Default is 30.

	`maxElevation:uint` (default = `255`) — [optional] uint. The maximum color value to be used. Allows canyon like elevations instead of mountainious. Default is 255.

	`minElevation:uint` (default = `0`) — [optional] uint. The minimum color value to be used. Default is 0.

	`smoothMap:Boolean` (default = `false`) — [optional] Boolean. If surface tracking is used, an internal smoothed version of the map is generated, prevents irregular height readings if original map is blowed up or is having noise. Default is false.

Method Detail

generateSmoothedHeightMap

()

method

public function generateSmoothedHeightMap():BitmapData

Generates a smoother representation of the geometry using the original heightmap and subdivision settings. Allows smoother readings for surface tracking if original heightmap has noise, causing choppy camera movement.

Returns

BitmapData

Away3D Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Elevation	Properties \| Methods \| Events \| Constants

Package	away3d.extrusions
Class	public class Elevation
Inheritance	Elevation Mesh Entity ObjectContainer3D Object3D NamedAssetBase flash.events.EventDispatcher

	`x:Number`

	`z:Number`