Packageaway3dlite.primitives
Classpublic class Plane
InheritancePlane Inheritance AbstractPrimitive Inheritance Mesh Inheritance Object3D Inheritance flash.display.Sprite

Creates a 3d plane primitive.

Public Properties
 PropertyDefined by
 InheritedanimationLibrary : AnimationLibrary
Used in the loaders to store all parsed animation data contained in the model.
Object3D
 Inheritedbothsides : Boolean
Determines whether the faces in teh mesh are visible on both sides (true) or just the front side (false).
Mesh
 Inheritedfaces : Vector
Returns the faces used in the mesh.
AbstractPrimitive
 InheritedgeometryLibrary : GeometryLibrary
Used in loaders to store all parsed geometry data contained in the model.
Object3D
  height : Number
Defines the height of the plane.
Plane
 Inheritedlayer : Sprite
An optional layer sprite used to draw into inseatd of the default view.
Object3D
 Inheritedmaterial : Material
Determines the global material used on the faces in the mesh.
Mesh
 InheritedmaterialLibrary : MaterialLibrary
Used in loaders to store all parsed materials contained in the model.
Object3D
 Inheritedposition : Vector3D
Returns a 3d vector representing the local position of the 3d object.
Object3D
 Inheritedscene : Scene3D
Returns the scene to which the 3d object belongs
Object3D
 InheritedsceneMatrix3D : Matrix3D
Returns a 3d matrix representing the absolute transformation of the 3d object in the scene.
Object3D
 InheritedscreenZ : Number
Returns the z-sorting position of the 3d object.
Object3D
  segmentsH : int
Defines the number of vertical segments that make up the plane.
Plane
  segmentsW : int
Defines the number of horizontal segments that make up the plane.
Plane
 InheritedsortFaces : Boolean = true
Determines if the faces in the mesh are sorted.
Mesh
 InheritedsortType : String
Determines by which mechanism vertices are sorted.
Mesh
 Inheritedtype : String
Returns the type of 3d object.
Object3D
 Inheritedurl : String
Returns the source url of the 3d object, or the name of the family of generative geometry objects if not loaded from an external source.
Object3D
 Inheritedvertices : Vector
Returns the 3d vertices used in the mesh.
AbstractPrimitive
 InheritedviewMatrix3D : Matrix3D
Returns a 3d matrix representing the absolute transformation of the 3d object in the view.
Object3D
  width : Number
Defines the width of the plane.
Plane
  yUp : Boolean
Defines whether the coordinates of the plane points use a yUp orientation (true) or a zUp orientation (false).
Plane
Protected Properties
 PropertyDefined by
 Inherited_vertexNormals : Vector
Mesh
Public Methods
 MethodDefined by
  
Plane
(material:Material = null, width:Number = 100, height:Number = 100, segmentsW:int = 1, segmentsH:int = 1, yUp:Boolean = true)
Creates a new Plane object.
Plane
  
clone(object:Object3D = null):Object3D
Duplicates the plane properties to another Plane object.
Plane
 Inherited
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.
Object3D
Protected Methods
 MethodDefined by
  
Builds the vertex, face and uv objects that make up the 3d primitive.
Plane
 Inherited
copyMatrix3D(m1:Matrix3D, m2:Matrix3D):void
Object3D
 Inherited
AbstractPrimitive
Events
 EventSummaryDefined by
 Inherited Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor while it is over the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor away from the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor over the 3d object.Object3D
 Inherited Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when a user rolls out of the 3d object.Object3D
 Inherited Dispatched when a user rolls over the 3d object.Object3D
Property detail
heightproperty
height:Number  [read-write]

Defines the height of the plane. Defaults to 100.

Implementation
    public function get height():Number
    public function set height(value:Number):void
segmentsHproperty 
segmentsH:int  [read-write]

Defines the number of vertical segments that make up the plane. Defaults to 1.

Implementation
    public function get segmentsH():int
    public function set segmentsH(value:int):void
segmentsWproperty 
segmentsW:int  [read-write]

Defines the number of horizontal segments that make up the plane. Defaults to 1.

Implementation
    public function get segmentsW():int
    public function set segmentsW(value:int):void
widthproperty 
width:Number  [read-write]

Defines the width of the plane. Defaults to 100.

Implementation
    public function get width():Number
    public function set width(value:Number):void
yUpproperty 
yUp:Boolean  [read-write]

Defines whether the coordinates of the plane points use a yUp orientation (true) or a zUp orientation (false). Defaults to true.

Implementation
    public function get yUp():Boolean
    public function set yUp(value:Boolean):void
Constructor detail
Plane()constructor
public function Plane(material:Material = null, width:Number = 100, height:Number = 100, segmentsW:int = 1, segmentsH:int = 1, yUp:Boolean = true)Parameters
material:Material (default = null) — Defines the global material used on the faces in the plane.
 
width:Number (default = 100) — Defines the width of the plane.
 
height:Number (default = 100) — Defines the height of the plane.
 
segmentsW:int (default = 1) — Defines the number of horizontal segments that make up the plane.
 
segmentsH:int (default = 1) — Defines the number of vertical segments that make up the plane.
 
yUp:Boolean (default = true) — Defines whether the coordinates of the plane points use a yUp orientation (true) or a zUp orientation (false).
Init Parameters
Method detail
buildPrimitive()method
protected override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

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

Duplicates the plane properties to another Plane object.

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

Returns
Object3D — The new object instance with duplicated properties applied.
Wiki link
Click to go to the wiki page for 'away3dlite.primitives.Plane'

Code examples

Comments