| Package | away3d.extrusions |
| Class | public class Elevation |
| Inheritance | Elevation  Mesh Entity ObjectContainer3D Object3D flash.events.EventDispatcher |
| Package | away3d.extrusions |
| Class | public class Elevation |
| Inheritance | Elevation Mesh Entity ObjectContainer3D Object3D flash.events.EventDispatcher |
| Property | Defined by | ||
|---|---|---|---|
 | animation : AnimationBase
The type of animation used to influence the geometry.
| Mesh | |
| animationController : AnimatorBase
The animation controller that will update the mesh's animation state.
| Mesh | |
| animationState : AnimationStateBase
The animation state of the mesh, defining how the animation should influence the mesh's geometry.
| Mesh | |
| 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 | ||
| 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 | |
| geometry : Geometry
The geometry used by the mesh that provides it with its shape.
| Mesh | |
| height : Number | Elevation | ||
| inverseSceneTransform : Matrix3D
The inverse scene transform object that transforms from world to model space.
| ObjectContainer3D | |
| material : MaterialBase
The material with which to render the Mesh.
| Mesh | |
| maxElevation : uint | Elevation | ||
| maxX : Number
The maximum extremum of the object along the X-axis.
| Entity | |
| maxY : Number
The maximum extremum of the object along the Y-axis.
| Entity | |
| maxZ : Number
The maximum extremum of the object along the Z-axis.
| Entity | |
| minElevation : uint | Elevation | ||
| minX : Number
The minimum extremum of the object along the X-axis.
| Entity | |
| minY : Number
The minimum extremum of the object along the Y-axis.
| Entity | |
| minZ : Number
The minimum extremum of the object along the Z-axis.
| Entity | |
| modelViewProjection : Matrix3D
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 | |
| mouseDetails : Boolean
Indicates whether or not mouse events contain UV and position coordinates.
| Mesh | |
| mouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
| Entity | |
| name : String
The name of the object.
| Object3D | |
| numChildren : uint
The amount of child objects of the ObjectContainer3D.
| ObjectContainer3D | |
| parent : ObjectContainer3D
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 | |
| 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 | |
| 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 | |
| scenePosition : Vector3D
The global position of the ObjectContainer3D in the scene.
| ObjectContainer3D | |
| sceneTransform : Matrix3D
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 | ||
| smoothedHeightMap : BitmapData [read-only]
| Elevation | ||
| subMeshes : Vector
The SubMeshes out of which the Mesh consists.
| Mesh | |
| transform : Matrix3D
The local transformation matrix that transforms to the parent object's space.
| 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 | |
| zIndex : Number
The distance of the IRenderable object to the view, used to sort per object.
| Entity | |
| Property | Defined by | ||
|---|---|---|---|
| _bounds : BoundingVolumeBase | Entity | |
| _boundsInvalid : Boolean = true | Entity | |
| _explicitPartition : Partition3D | ObjectContainer3D | |
| _geomDirty : Boolean = true | Elevation | ||
| _geometry : Geometry | Mesh | |
| _implicitPartition : Partition3D | ObjectContainer3D | |
| _mvpIndex : int = -1 | Entity | |
| _mvpTransformStack : Vector | Entity | |
| _parent : ObjectContainer3D | ObjectContainer3D | |
| _pivotPoint : Vector3D | Object3D | |
| _pivotZero : Boolean = true | Object3D | |
| _pos : Vector3D
A calculation placeholder.
| 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 | |
| _uvDirty : Boolean = true | Elevation | ||
| _x : Number = 0 | Object3D | |
| _y : Number = 0 | Object3D | |
| _z : Number = 0 | Object3D | |
| _zIndices : Vector | Entity | |
| 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 | ||
|
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 | |
|
| Mesh | |
|
dispose(deep:Boolean):void
Cleans up any resources used by the current object.
| Mesh | |
|
Retrieves the child object at the given index.
| ObjectContainer3D | |
|
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 | ||
|
lookAt(target:Vector3D, upAxis:Vector3D = null):void
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 | |
|
Updates the model-view-projection (MVP) matrix used to transform from model to homogeneous projection space
and places it on the stack.
| Entity | |
|
Removes a 3d object from the child array of the container
| ObjectContainer3D | |
|
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | |
|
rotate(axis:Vector3D, angle:Number):void
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(value:Number):void
Appends a uniform scale to the current transformation.
| Object3D | |
|
smoothHeightMap():void
Generates a smoother representation of the geometry using the original heightmap and subdivision settings.
| Elevation | ||
|
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
| Object3D | |
|
translateLocal(axis:Vector3D, distance:Number):void
| ObjectContainer3D | |
|
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D | |
| Method | Defined by | ||
|---|---|---|---|
|
Factory method that returns the current partition node.
| Mesh | |
|
Creates the default bounding box to be used by this type of Entity.
| Entity | |
|
initGeometry():void
Initialises the SubMesh objects to map unto the Geometry's SubGeometry objects.
| Mesh | |
|
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
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
| Entity | |
|
invalidateTransform():void
Invalidates the transformation matrix, causing it to be updated upon the next request
| ObjectContainer3D | |
|
invalidateUVs():void
Invalidates the primitive's uv coordinates, causing them to be updated when requested.
| Elevation | ||
|
updateBounds():void
Updates the bounding volume for the object.
| Mesh | |
|
updateSceneTransform():void
Updates the scene transformation matrix.
| ObjectContainer3D | |
|
updateTransform():void
| Object3D | |
| depth | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesdepth:Number [read-write]The depth of the terrain plane.
Implementation public function get depth():Number
public function set depth(value:Number):void
| _geomDirty | property |
protected var _geomDirty:Boolean = true
| height | property |
height:Number [read-write]Implementation
public function get height():Number
public function set height(value:Number):void
| maxElevation | property |
maxElevation:uint [read-write]Implementation
public function get maxElevation():uint
public function set maxElevation(value:uint):void
| minElevation | property |
minElevation:uint [read-write]Implementation
public function get minElevation():uint
public function set minElevation(value:uint):void
| segmentsH | property |
segmentsH:uint [read-write]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
| _uvDirty | property |
protected var _uvDirty:Boolean = true
| width | property |
width:Number [read-write]The width of the terrain plane.
Implementation public function get width():Number
public function set width(value:Number):void
| 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)Parameters
material:MaterialBase — MaterialBase. The Mesh (Elevation) material
|
|
heightMap:BitmapData — BitmapData. The heightmap to generate the mesh from
|
|
width:Number (default = 1000) |
|
height:Number (default = 100) |
|
depth:Number (default = 1000) |
|
segmentsW:uint (default = 30) |
|
segmentsH:uint (default = 30) |
|
maxElevation:uint (default = 255) |
|
minElevation:uint (default = 0) |
|
smoothMap:Boolean (default = false) |
| getHeightAt | () | method |
public function getHeightAt(x:Number, z:Number):Number
Reading the terrain height from a given x z position for surface tracking purposes
Parametersx:Number |
|
z:Number |
Number |
See also
| invalidateGeometry | () | method |
protected function invalidateGeometry():void
Invalidates the primitive's geometry, causing it to be updated when requested.
| invalidateUVs | () | method |
protected function invalidateUVs():void
Invalidates the primitive's uv coordinates, causing them to be updated when requested.
| smoothHeightMap | () | method |
public function smoothHeightMap():void
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.
See also