Packageaway3d.core.base
Classpublic class Element
InheritanceElement Inheritance flash.events.EventDispatcher
SubclassesFace, Segment, Sprite3D

Basic 3d element object Not intended for direct use - use Segment or Face.

Public Properties
 PropertyDefined by
  commands : Array
[read-only] Returns an array of drawing command strings that make up the 3d element.
Element
  extra : Object
An optional untyped object that can contain used-defined properties.
Element
  maxX : Number
[read-only] Returns the maximum x value of the 3d element
Element
  maxY : Number
[read-only] Returns the maximum y value of the 3d element
Element
  maxZ : Number
[read-only] Returns the maximum z value of the 3d element
Element
  minX : Number
[read-only] Returns the minimum x value of the 3d element
Element
  minY : Number
[read-only] Returns the minimum y value of the 3d element
Element
  minZ : Number
[read-only] Returns the minimum z value of the 3d element
Element
  parent : Geometry
Defines the parent 3d object of the segment.
Element
  pathCommands : Array
[read-only] Returns an array of drawing command objects that are used by the face.
Element
  radius2 : Number
[read-only] Returns the squared bounding radius of the 3d element
Element
  vertexDirty : Boolean
Element
  vertices : Array
[read-only] Returns an array of vertex objects that make up the 3d element.
Element
  visible : Boolean
Determines whether the 3d element is visible in the scene.
Element
Protected Properties
 PropertyDefined by
  _commands : Array
Element
  _index : int
Element
  _lastAddedVertex : Vertex
Element
  _pathCommands : Array
Element
  _vertices : Array
Element
Public Methods
 MethodDefined by
  
addOnMappingChange(listener:Function):void
Default method for adding a mappingchanged event listener
Element
  
addOnVertexChange(listener:Function):void
Default method for adding a vertexchanged event listener
Element
  
addOnVertexValueChange(listener:Function):void
Default method for adding a vertexvaluechanged event listener
Element
  
addOnVisibleChange(listener:Function):void
Default method for adding a visiblechanged event listener
Element
  
offset(x:Number, y:Number, z:Number):void
Offsets the vertices of the face by given amounts in x, y and z.
Element
  
removeOnMappingChange(listener:Function):void
Default method for removing a mappingchanged event listener
Element
  
removeOnVertexChange(listener:Function):void
Default method for removing a vertexchanged event listener
Element
  
removeOnVertexValueChange(listener:Function):void
Default method for removing a vertexvaluechanged event listener
Element
  
removeOnVisibleChange(listener:Function):void
Default method for removing a visiblechanged event listener
Element
Events
 EventSummaryDefined by
   Dispatched when the vertex of a 3d element changes.Element
   Dispatched when the vertex value of a 3d element changes.Element
   Dispatched when the visiblity of a 3d element changes.Element
Property detail
_commandsproperty
protected var _commands:Array
commandsproperty 
commands:Array  [read-only]

Returns an array of drawing command strings that make up the 3d element.

Implementation
    public function get commands():Array
extraproperty 
public var extra:Object

An optional untyped object that can contain used-defined properties.

_indexproperty 
protected var _index:int
_lastAddedVertexproperty 
protected var _lastAddedVertex:Vertex
maxXproperty 
maxX:Number  [read-only]

Returns the maximum x value of the 3d element

Implementation
    public function get maxX():Number
maxYproperty 
maxY:Number  [read-only]

Returns the maximum y value of the 3d element

Implementation
    public function get maxY():Number
maxZproperty 
maxZ:Number  [read-only]

Returns the maximum z value of the 3d element

Implementation
    public function get maxZ():Number
minXproperty 
minX:Number  [read-only]

Returns the minimum x value of the 3d element

Implementation
    public function get minX():Number
minYproperty 
minY:Number  [read-only]

Returns the minimum y value of the 3d element

Implementation
    public function get minY():Number
minZproperty 
minZ:Number  [read-only]

Returns the minimum z value of the 3d element

Implementation
    public function get minZ():Number
parentproperty 
public var parent:Geometry

Defines the parent 3d object of the segment.

_pathCommandsproperty 
protected var _pathCommands:Array
pathCommandsproperty 
pathCommands:Array  [read-only]

Returns an array of drawing command objects that are used by the face.

Implementation
    public function get pathCommands():Array
radius2property 
radius2:Number  [read-only]

Returns the squared bounding radius of the 3d element

Implementation
    public function get radius2():Number
vertexDirtyproperty 
public var vertexDirty:Boolean
_verticesproperty 
protected var _vertices:Array
verticesproperty 
vertices:Array  [read-only]

Returns an array of vertex objects that make up the 3d element.

Implementation
    public function get vertices():Array
visibleproperty 
visible:Boolean  [read-write]

Determines whether the 3d element is visible in the scene.

Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Method detail
addOnMappingChange()method
public function addOnMappingChange(listener:Function):void

Default method for adding a mappingchanged event listener

Parameters
listener:Function — The listener function
addOnVertexChange()method 
public function addOnVertexChange(listener:Function):void

Default method for adding a vertexchanged event listener

Parameters
listener:Function — The listener function
addOnVertexValueChange()method 
public function addOnVertexValueChange(listener:Function):void

Default method for adding a vertexvaluechanged event listener

Parameters
listener:Function — The listener function
addOnVisibleChange()method 
public function addOnVisibleChange(listener:Function):void

Default method for adding a visiblechanged event listener

Parameters
listener:Function — The listener function
offset()method 
public function offset(x:Number, y:Number, z:Number):void

Offsets the vertices of the face by given amounts in x, y and z.

Parameters
x:Number — [Number] Offset in x.
 
y:Number — [Number] Offset in y.
 
z:Number — [Number] Offset in z.
removeOnMappingChange()method 
public function removeOnMappingChange(listener:Function):void

Default method for removing a mappingchanged event listener

Parameters
listener:Function — The listener function
removeOnVertexChange()method 
public function removeOnVertexChange(listener:Function):void

Default method for removing a vertexchanged event listener

Parameters
listener:Function — The listener function
removeOnVertexValueChange()method 
public function removeOnVertexValueChange(listener:Function):void

Default method for removing a vertexvaluechanged event listener

Parameters
listener:Function — The listener function
removeOnVisibleChange()method 
public function removeOnVisibleChange(listener:Function):void

Default method for removing a visiblechanged event listener

Parameters
listener:Function — The listener function
Event detail
vertexChangedevent 
Event object type: away3d.events.ElementEvent

Dispatched when the vertex of a 3d element changes.

vertexvalueChangedevent  
Event object type: away3d.events.ElementEvent

Dispatched when the vertex value of a 3d element changes.

visibleChangedevent  
Event object type: away3d.events.ElementEvent

Dispatched when the visiblity of a 3d element changes.

Wiki link
Click to go to the wiki page for 'away3d.core.base.Element'

Code examples

Comments