away3d.core.base.Mesh

Public Properties

	Property		Defined by
		alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
		animationLibrary : AnimationLibrary Reference container for all animations used in the container.	Object3D
		back : Material Defines a triangle material to be used for the backface of all faces in the 3d object.	Mesh
		blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
		bothsides : Boolean Indicates whether both the front and reverse sides of a face should be rendered.	Mesh
		boundingRadius : Number Returns the bounding radius of the 3d object	Object3D
		center : Array	Object3D
		collider : Boolean Indicates whether this object is used for collision detection.	Object3D
		commands : Array [read-only] Returns an array of the commands contained in the mesh object.	Mesh
		debugbb : Boolean Indicates whether a debug bounding box should be rendered around the 3d object.	Object3D
		debugBoundingBox : WireCube	Object3D
		debugBoundingSphere : WireSphere	Object3D
		debugbs : Boolean Indicates whether a debug bounding sphere should be rendered around the 3d object.	Object3D
		elements : Array [read-only] Returns an array of all elements contained in the mesh object.	Mesh
		eulers : Number3D Defines the rotation of the 3d object as a `Number3D` object containing euler angles for rotation around x, y and z axis.	Object3D
		extra : Object An optional untyped object that can contain used-defined properties	Object3D
		faces : Array [read-only] Returns an array of the faces contained in the mesh object.	Mesh
		faceVOs : Array [read-only] Returns an array of the faceVOs contained in the mesh object.	Mesh
		filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
		geometry : Geometry Defines the geometry object used for the mesh.	Mesh
		geometryLibrary : GeometryLibrary Reference container for all geometries used in the container.	Object3D
		id : int	Object3D
		indexes : Array Placeholder for md2 frame indexes	Mesh
		indices : Array [read-only] Returns an array of the indices contained in the mesh object.	Mesh
		inverseSceneTransform : MatrixAway3D Returns the inverse of sceneTransform.	Object3D
		lightarray : ILightConsumer returns the array of lights contained inside the container.	Object3D
		material : Material Defines the material used to render the faces, segments or 3d sprites in the geometry object.	Mesh
		materialLibrary : MaterialLibrary Reference container for all materials used in the container.	Object3D
		maxX : Number Returns the maximum x value of the 3d object	Object3D
		maxY : Number Returns the maximum y value of the 3d object	Object3D
		maxZ : Number Returns the maximum z value of the 3d object	Object3D
		minX : Number Returns the minimum x value of the 3d object	Object3D
		minY : Number Returns the minimum y value of the 3d object	Object3D
		minZ : Number Returns the minimum z value of the 3d object	Object3D
		mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
		name : String An optional name string for the 3d object.	Object3D
		objectDepth : Number Boundary depth of the 3d object return The depth of the mesh	Object3D
		objectHeight : Number Boundary height of the 3d object return The height of the mesh	Object3D
		objectWidth : Number Boundary width of the 3d object return The width of the object	Object3D
		outline : Material Defines a segment material to be used for outlining the 3d object.	Mesh
		ownCanvas : Boolean Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
		ownLights : Boolean Defines whether the children of the container are rendered using it's own lights.	Object3D
		ownSession : AbstractRenderSession Defines a unique render session for the 3d object.	Object3D
		parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
		pivotPoint : Number3D Defines the local point around which the object rotates.	Object3D
		pivotZero : Boolean	Object3D
		position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		projectorType : String	Object3D
		pushback : Boolean Elements use their furthest point from the camera when z-sorting	Object3D
		pushfront : Boolean Elements use their nearest point to the camera when z-sorting	Object3D
		renderer : IPrimitiveConsumer An optional renderer object that can be used to render the contents of the object.	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 Returns the parent scene of the 3d object	Object3D
		scenePivotPoint : Number3D	Object3D
		scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
		sceneTransform : MatrixAway3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
		screenXOffset : Number Defines an additional offset to the x coordinate used on mesh elements or objects with ownCanvas set to true	Object3D
		screenYOffset : Number Defines an additional offset to the y coordinate used on mesh elements or objects with ownCanvas set to true	Object3D
		screenZOffset : Number Defines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true	Object3D
		segments : Array [read-only] Returns an array of the segments contained in the mesh object.	Mesh
		segmentVOs : Array [read-only] Returns an array of the segmentVOs contained in the mesh object.	Mesh
		session : AbstractRenderSession The render session used by the 3d object	Object3D
		sprites : Array [read-only] Returns an array of the 3d sprites contained in the mesh object.	Mesh
		spriteVOs : Array [read-only] Returns an array of the spriteVOs contained in the mesh object.	Mesh
		startIndices : Array [read-only] Returns an array of the start indices contained in the mesh object.	Mesh
		transform : MatrixAway3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		type : String = "mesh" String defining the type of class used to generate the mesh.	Mesh
		url : String String defining the source of the mesh.	Mesh
		useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
		vertices : Array Returns an array of the vertices contained in the mesh object.	Mesh
		visible : Boolean Defines whether the 3d object is visible in the scene	Object3D
		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
		ini : Init Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.	Object3D
		_pivotPoint : Number3D	Object3D

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		Mesh (init:Object = null) Creates a new `BaseMesh` object.	Mesh
		addFace(face:Face):void Adds a face object to the mesh object.	Mesh
		addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
		addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
		addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
		addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
		addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
		addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
		addOnParentUpdate(listener:Function):void Default method for adding a parentupdated event listener	Object3D
		addOnRollOut(listener:Function):void Default method for adding a rollOut3D event listener	Object3D
		addOnRollOver(listener:Function):void Default method for adding a rollOver3D event listener	Object3D
		addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
		addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
		addOnSessionChange(listener:Function):void Default method for adding a sessionchanged event listener	Object3D
		addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
		addSegment(segment:Segment):void Adds a segment object to the mesh object.	Mesh
		addSprite(sprite3d:Sprite3D):void Adds a sprite3d object to the mesh object.	Mesh
		applyPosition(dx:Number, dy:Number, dz:Number):void Apply the given position to the geometry without altering the appearance of the mesh	Mesh
		applyRotations():void Apply the local rotations to the geometry without altering the appearance of the mesh	Mesh
		asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.	Mesh
		asXML():XML Returns an xml representation of the mesh	Mesh
		centerPivot():void Adjusts the pivot point of the object so that it lies at the center of it's geoemtry.	Object3D
		clone(object:Object3D = null):Object3D Duplicates the mesh properties to another 3d object.	Mesh
		cloneAll(object:Object3D = null):Object3D Duplicates the mesh properties to another 3d object, including geometry.	Mesh
		distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
		invertFaces():void Inverts the geometry of all face objects.	Mesh
		lookAt(target:Number3D, upAxis:Number3D = null):void Rotates the 3d object around to face a point defined relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		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
		quarterFace(face:Face):void Divides a face object into 4 equal sized face objects.	Mesh
		quarterFaces():void Divides all faces objects of a Mesh into 4 equal sized face objects.	Mesh
		removeFace(face:Face):void Removes a face object from the mesh object.	Mesh
		removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
		removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
		removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
		removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
		removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
		removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
		removeOnParentUpdate(listener:Function):void Default method for removing a parentupdated event listener	Object3D
		removeOnRollOut(listener:Function):void Default method for removing a rollOut3D event listener	Object3D
		removeOnRollOver(listener:Function):void Default method for removing a rollOver3D event listener	Object3D
		removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
		removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
		removeOnSessionChange(listener:Function):void Default method for removing a sessionchanged event listener	Object3D
		removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
		removeSegment(segment:Segment):void Removes a segment object from the mesh object.	Mesh
		removeSprite(sprite3d:Sprite3D):void Removes a 3d sprite object from the mesh object.	Mesh
		roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
		rotate(axis:Number3D, 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(scale:Number):void Scales the contents of the 3d object.	Object3D
		splitFace(face:Face, side:int = 0):void Divides a face object into 2 face objects.	Mesh
		splitFaces(side:int = 0):void Divides all faces objects of a Mesh into 2 face objects.	Mesh
		tick(time:int):void Called by the `TickTraverser`.	Object3D
		toString():String Used to trace the values of a 3d object.	Object3D
		translate(axis:Number3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
		traverse(traverser:Traverser):void Used when traversing the scenegraph	Object3D
		triFace(face:Face):void Divides a face object into 3 face objects.	Mesh
		triFaces():void Divides all faces objects of a Mesh into 3 face objects.	Mesh
		updateMaterials(source:Object3D, view:View3D):void Updates the materials in the mesh object	Mesh
		updateObject():void	Object3D
		updateSession():void	Object3D
		updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void update vertex information.	Mesh
		yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

	Method	Defined by
		updateDimensions():void	Mesh
		updateTransform():void	Object3D

Summary	Defined by
dimensionsChanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
mouseDown	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	Object3D
mouseMove	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
mouseOut	Dispatched when a user moves the cursor away from the 3d object.	Object3D
mouseOver	Dispatched when a user moves the cursor over the 3d object.	Object3D
mouseUp	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	Object3D
rollOut	Dispatched when a user rolls out of the 3d object.	Object3D
rollOver	Dispatched when a user rolls over the 3d object.	Object3D
sceneChanged	Dispatched when the parent scene of the 3d object changes.	Object3D
scenetransformChanged	Dispatched when the scene transform matrix of the 3d object changes.	Object3D
sessionChanged	Dispatched when the render session property of the 3d object changes.	Object3D
sessionUpdated	Dispatched when the render session property of the 3d object updates its contents.	Object3D
transformChanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

Property detail

back

property

back:Material [read-write]

Defines a triangle material to be used for the backface of all faces in the 3d object.

Implementation
public function get back():Material
public function set back(value:Material):void

bothsides

property

public var bothsides:Boolean

Indicates whether both the front and reverse sides of a face should be rendered.

commands

property

commands:Array [read-only]

Returns an array of the commands contained in the mesh object.

Implementation
public function get commands():Array

elements

property

elements:Array [read-only]

Returns an array of all elements contained in the mesh object.

Implementation
public function get elements():Array

faces

property

faces:Array [read-only]

Returns an array of the faces contained in the mesh object.

Implementation
public function get faces():Array

faceVOs

property

faceVOs:Array [read-only]

Returns an array of the faceVOs contained in the mesh object.

Implementation
public function get faceVOs():Array

geometry

property

geometry:Geometry [read-write]

Defines the geometry object used for the mesh.

Implementation
public function get geometry():Geometry
public function set geometry(value:Geometry):void

indexes

property

public var indexes:Array

Placeholder for md2 frame indexes

indices

property

indices:Array [read-only]

Returns an array of the indices contained in the mesh object.

Implementation
public function get indices():Array

material

property

material:Material [read-write]

Defines the material used to render the faces, segments or 3d sprites in the geometry object. Individual material settings on faces, segments and 3d sprites will override this setting.

Implementation
public function get material():Material
public function set material(value:Material):void

See also

away3d.core.base.Face.material

outline

property

public var outline:Material

Defines a segment material to be used for outlining the 3d object.

segments

property

segments:Array [read-only]

Returns an array of the segments contained in the mesh object.

Implementation
public function get segments():Array

segmentVOs

property

segmentVOs:Array [read-only]

Returns an array of the segmentVOs contained in the mesh object.

Implementation
public function get segmentVOs():Array

sprites

property

sprites:Array [read-only]

Returns an array of the 3d sprites contained in the mesh object.

Implementation
public function get sprites():Array

spriteVOs

property

spriteVOs:Array [read-only]

Returns an array of the spriteVOs contained in the mesh object.

Implementation
public function get spriteVOs():Array

startIndices

property

startIndices:Array [read-only]

Returns an array of the start indices contained in the mesh object.

Implementation
public function get startIndices():Array

type

property

public var type:String = "mesh"

String defining the type of class used to generate the mesh. Used to display information in the stats panel

See also

away3d.core.stats.Stats

url

property

public var url:String

String defining the source of the mesh. If the mesh has been created internally, the string is used to display the package name of the creating object. Used to display information in the stats panel

See also

away3d.core.stats.Stats

vertices

property

vertices:Array [read-write]

Returns an array of the vertices contained in the mesh object.

Implementation
public function get vertices():Array
public function set vertices(value:Array):void

Constructor detail

Mesh

()

constructor

public function Mesh(init:Object = null)Parameters

init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.

Init Parameters

	`outline:Material`
	`material:Material`
	`back:Material`
	`bothsides:Boolean` (default = false)

Method detail

addFace

()

method

public function addFace(face:Face):void

Adds a face object to the mesh object.

Parameters

face:Face — The face object to be added.

addSegment

()

method

public function addSegment(segment:Segment):void

Adds a segment object to the mesh object.

Parameters

segment:Segment — The segment object to be added.

addSprite

()

method

public function addSprite(sprite3d:Sprite3D):void

Adds a sprite3d object to the mesh object.

Parameters

sprite3d:Sprite3D — The sprite3d object to be added.

applyPosition

()

method

public override function applyPosition(dx:Number, dy:Number, dz:Number):void

Apply the given position to the geometry without altering the appearance of the mesh

Parameters

	`dx:Number`

	`dy:Number`

	`dz:Number`

applyRotations

()

method

public override function applyRotations():void

Apply the local rotations to the geometry without altering the appearance of the mesh

asAS3Class

()

method

public function asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String

Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.

Parameters

	`classname:String` (default = `null`) — [optional] Defines the class name used in the output string. Defaults to `Away3DObject`.

	`packagename:String` (default = "") — [optional] Defines the package name used in the output string. Defaults to no package.

	`round:Boolean` (default = `false`) — [optional] Rounds all values to 4 decimal places. Defaults to false.

	`animated:Boolean` (default = `false`) — [optional] Defines whether animation data should be saved. Defaults to false.

Returns

String — A string to be pasted into a new .as file

asXML

()

method

public function asXML():XML

Returns an xml representation of the mesh

Returns

XML — An xml object containing mesh information

clone

()

method

public override function clone(object:Object3D = null):Object3D

Duplicates the mesh properties to another 3d object. Usage: existingObject = objectToClone.clone( existingObject ) as Mesh;

Parameters

object:Object3D (default = null) — [optional] The new object instance into which all properties are copied. The default is Mesh.

Returns

Object3D — The new object instance with duplicated properties applied.

cloneAll

()

method

public function cloneAll(object:Object3D = null):Object3D

Duplicates the mesh properties to another 3d object, including geometry. Usage: var newObject:Mesh = oldObject.cloneAll( newObject ) as Mesh;

Parameters

object:Object3D (default = null) — [optional] The new object instance into which all properties are copied. The default is Mesh.

Returns

Object3D — The new object instance with duplicated properties applied.

invertFaces

()

method

public function invertFaces():void

Inverts the geometry of all face objects.

See also

away3d.code.base.Face.invert()

quarterFace

()

method

public function quarterFace(face:Face):void

Divides a face object into 4 equal sized face objects.

Parameters

face:Face — The face to split in 4 equal faces.

quarterFaces

()

method

public function quarterFaces():void

Divides all faces objects of a Mesh into 4 equal sized face objects. Used to segment a geometry in order to reduce affine persepective distortion.

See also

away3d.primitives.SkyBox

removeFace

()

method

public function removeFace(face:Face):void

Removes a face object from the mesh object.

Parameters

face:Face — The face object to be removed.

removeSegment

()

method

public function removeSegment(segment:Segment):void

Removes a segment object from the mesh object.

Parameters

segment:Segment — The segment object to be removed.

removeSprite

()

method

public function removeSprite(sprite3d:Sprite3D):void

Removes a 3d sprite object from the mesh object.

Parameters

sprite3d:Sprite3D — The 3d sprite object to be removed.

splitFace

()

method

public function splitFace(face:Face, side:int = 0):void

Divides a face object into 2 face objects.

Parameters

	`face:Face` — The face to split in 2 faces.

	`side:int` (default = `0`) — The side of the face to split in two. 0 , 1 or 2. (clockwize).

splitFaces

()

method

public function splitFaces(side:int = 0):void

Divides all faces objects of a Mesh into 2 face objects.

Parameters

side:int (default = 0) — The side of the faces to split in two. 0 , 1 or 2. (clockwize).

triFace

()

method

public function triFace(face:Face):void

Divides a face object into 3 face objects.

Parameters

face:Face — The face to split 3 faces.

triFaces

()

method

public function triFaces():void

Divides all faces objects of a Mesh into 3 face objects.

updateDimensions

()

method

protected override function updateDimensions():void

updateMaterials

()

method

public function updateMaterials(source:Object3D, view:View3D):void

Updates the materials in the mesh object

Parameters

	`source:Object3D`

	`view:View3D`

updateVertex

()

method

public function updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void

update vertex information.

Parameters

	`v:Vertex` — v The vertex object to update

	`x:Number` — x The new x value for the vertex

	`y:Number` — y The new y value for the vertex

	`z:Number` — z The new z value for the vertex

	`refreshNormals:Boolean` (default = `false`) — refreshNormals [optional] Defines whether normals should be recalculated

Wiki link

Click to go to the wiki page for 'away3d.core.base.Mesh'

Code examples

Comments

Away3D FP10 V3.5.0 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class Mesh		Properties \| Methods \| Events

Package	away3d.core.base
Class	public class Mesh
Inheritance	Mesh Object3D flash.events.EventDispatcher
Subclasses	AbstractPrimitive, BezierPatch, CurveLineSegment, LinearExtrusion, LineSegment, ObjectContainer3D, PathDuplicator, SeaTurtle, SkinExtrude, Skybox, Skybox6, TextExtrusion, Triangle