| Package | away3d.primitives |
| Class | public class PlaneGeometry |
| Inheritance | PlaneGeometry  PrimitiveBase Geometry NamedAssetBase flash.events.EventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
 | assetFullPath : Array [read-only] | NamedAssetBase | |
| assetNamespace : String [read-only] | NamedAssetBase | |
| assetType : 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 | ||
| name : String | NamedAssetBase | |
| originalName : 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 | ||
| subGeometries : 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 | ||
| Method | Defined 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 | ||
| addSubGeometry(subGeometry:ISubGeometry):void
Adds a new SubGeometry object to the list. | Geometry | |
| applyTransformation(transform:Matrix3D):void [override]
| PrimitiveBase | |
| assetPathEquals(name:String, ns:String):Boolean | NamedAssetBase | |
| [override]
Clones the geometry. | PrimitiveBase | |
| convertToSeparateBuffers():void
Updates the SubGeometries so all vertex data is represented in different buffers. | Geometry | |
| dispose():void
Clears all resources used by the Geometry object, including SubGeometries. | Geometry | |
| removeSubGeometry(subGeometry:ISubGeometry):void
Removes a new SubGeometry object from the list. | Geometry | |
| resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void | NamedAssetBase | |
| scale(scale:Number):void [override]
Scales the geometry. | PrimitiveBase | |
| scaleUV(scaleU:Number = 1, scaleV:Number = 1):void [override]
Scales the uv coordinates (tiling)
| PrimitiveBase | |
| Method | Defined By | ||
|---|---|---|---|
buildGeometry(target:CompactSubGeometry):void [override]
Builds the primitive's geometry when invalid. | PlaneGeometry | ||
buildUVs(target:CompactSubGeometry):void [override]
Builds the primitive's uv coordinates when invalid. | PlaneGeometry | ||
| invalidateGeometry():void
Invalidates the primitive's geometry, causing it to be updated when requested. | PrimitiveBase | |
| invalidateUVs():void
Invalidates the primitive's uv coordinates, causing them to be updated when requested. | PrimitiveBase | |
| doubleSided | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesdoubleSided:BooleanDefines whether the plane will be visible from both sides, with correct vertex normals (as opposed to bothSides on Material). Defaults to false.
public function get doubleSided():Boolean public function set doubleSided(value:Boolean):void| height | property |
height:NumberThe height of the plane.
public function get height():Number public function set height(value:Number):void| segmentsH | property |
segmentsH:uintThe 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.
public function get segmentsH():uint public function set segmentsH(value:uint):void| segmentsW | property |
segmentsW:uintThe number of segments that make up the plane along the X-axis. Defaults to 1.
public function get segmentsW():uint public function set segmentsW(value:uint):void| width | property |
width:NumberThe width of the plane.
public function get width():Number public function set width(value:Number):void| yUp | property |
yUp:BooleanDefines whether the normal vector of the plane should point along the Y-axis (true) or Z-axis (false). Defaults to true.
public function get yUp():Boolean public function set yUp(value:Boolean):void| 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.
Parameterswidth:Number (default = 100) | |
height:Number (default = 100) | |
segmentsW:uint (default = 1) | |
segmentsH:uint (default = 1) | |
yUp:Boolean (default = true) | |
doubleSided:Boolean (default = false) |
| buildGeometry | () | method |
override protected function buildGeometry(target:CompactSubGeometry):voidBuilds 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):voidBuilds 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 |