Packageaway3d.primitives
Classpublic class PlaneGeometry
InheritancePlaneGeometry Inheritance PrimitiveBase Inheritance Geometry Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

A Plane primitive mesh.



Public Properties
 PropertyDefined By
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
 InheritedassetType : String
[read-only]
Geometry
  doubleSided : Boolean
Defines whether the plane will be visible from both sides, with correct vertex normals (as opposed to bothSides on Material).
PlaneGeometry
  height : Number
The height of the plane.
PlaneGeometry
 Inheritedname : String
NamedAssetBase
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
  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.
PlaneGeometry
  segmentsW : uint
The number of segments that make up the plane along the X-axis.
PlaneGeometry
 InheritedsubGeometries : Vector.<ISubGeometry>
[override] [read-only] A collection of SubGeometry objects, each of which contain geometrical data such as vertices, normals, etc.
PrimitiveBase
  width : Number
The width of the plane.
PlaneGeometry
  yUp : Boolean
Defines whether the normal vector of the plane should point along the Y-axis (true) or Z-axis (false).
PlaneGeometry
Protected Properties
 PropertyDefined By
 Inherited_geomDirty : Boolean = true
PrimitiveBase
 Inherited_uvDirty : Boolean = true
PrimitiveBase
Public Methods
 MethodDefined By
  
PlaneGeometry(width:Number = 100, height:Number = 100, segmentsW:uint = 1, segmentsH:uint = 1, yUp:Boolean = true, doubleSided:Boolean = false)
Creates a new Plane object.
PlaneGeometry
 Inherited
addSubGeometry(subGeometry:ISubGeometry):void
Adds a new SubGeometry object to the list.
Geometry
 Inherited
applyTransformation(transform:Matrix3D):void
[override]
PrimitiveBase
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
 Inherited
[override] Clones the geometry.
PrimitiveBase
 Inherited
Updates the SubGeometries so all vertex data is represented in different buffers.
Geometry
 Inherited
dispose():void
Clears all resources used by the Geometry object, including SubGeometries.
Geometry
 Inherited
Removes a new SubGeometry object from the list.
Geometry
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
 Inherited
scale(scale:Number):void
[override] Scales the geometry.
PrimitiveBase
 Inherited
scaleUV(scaleU:Number = 1, scaleV:Number = 1):void
[override] Scales the uv coordinates (tiling)
PrimitiveBase
Protected Methods
 MethodDefined By
  
[override] Builds the primitive's geometry when invalid.
PlaneGeometry
  
[override] Builds the primitive's uv coordinates when invalid.
PlaneGeometry
 Inherited
Invalidates the primitive's geometry, causing it to be updated when requested.
PrimitiveBase
 Inherited
Invalidates the primitive's uv coordinates, causing them to be updated when requested.
PrimitiveBase
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Property Detail
doubleSidedproperty
doubleSided:Boolean

Defines whether the plane will be visible from both sides, with correct vertex normals (as opposed to bothSides on Material). Defaults to false.


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

The height of the plane.


Implementation
    public function get height():Number
    public function set height(value:Number):void
segmentsHproperty 
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
segmentsWproperty 
segmentsW:uint

The number of segments that make up the plane along the X-axis. Defaults to 1.


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

The width of the plane.


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

Defines whether the normal vector of the plane should point along the Y-axis (true) or Z-axis (false). Defaults to true.


Implementation
    public function get yUp():Boolean
    public function set yUp(value:Boolean):void
Constructor Detail
PlaneGeometry()Constructor
public function PlaneGeometry(width:Number = 100, height:Number = 100, segmentsW:uint = 1, segmentsH:uint = 1, yUp:Boolean = true, doubleSided:Boolean = false)

Creates a new Plane object.

Parameters
width:Number (default = 100) — The width of the plane.
 
height:Number (default = 100) — The height of the plane.
 
segmentsW:uint (default = 1) — The number of segments that make up the plane along the X-axis.
 
segmentsH:uint (default = 1) — The number of segments that make up the plane along the Y or Z-axis.
 
yUp:Boolean (default = true) — Defines whether the normal vector of the plane should point along the Y-axis (true) or Z-axis (false).
 
doubleSided:Boolean (default = false) — Defines whether the plane will be visible from both sides, with correct vertex normals.
Method Detail
buildGeometry()method
override protected function buildGeometry(target:CompactSubGeometry):void

Builds the primitive's geometry when invalid. This method should not be called directly. The calling should be triggered by the invalidateGeometry method (and in turn by updateGeometry).

Parameters

target:CompactSubGeometry

buildUVs()method 
override protected function buildUVs(target:CompactSubGeometry):void

Builds the primitive's uv coordinates when invalid. This method should not be called directly. The calling should be triggered by the invalidateUVs method (and in turn by updateUVs).

Parameters

target:CompactSubGeometry