away3d.primitives.WireframePlane

Public Properties

	Property		Defined By
		animator : IAnimator [read-only]	SegmentSet
		assetFullPath : Array [read-only]	NamedAssetBase
		assetNamespace : String [read-only]	NamedAssetBase
		assetType : String [override] [read-only]	Entity
		backVector : Vector3D [read-only]	Object3D
		bounds : BoundingVolumeBase [override]	WireframePrimitiveBase
		castsShadows : Boolean [read-only]	SegmentSet
		color : uint	WireframePrimitiveBase
		downVector : Vector3D [read-only]	Object3D
		eulers : Vector3D Defines the rotation of the 3d object as a Vector3D object containing euler angles for rotation around x, y and z axis.	Object3D
		extra : Object An object that can contain any extra data.	Object3D
		forwardVector : Vector3D [read-only]	Object3D
		height : Number The size of the cube along its Y-axis.	WireframePlane
		indexData : Vector.<uint> [read-only]	SegmentSet
		inverseSceneTransform : Matrix3D [read-only] The inverse scene transform object that transforms from world to model space.	ObjectContainer3D
		leftVector : Vector3D [read-only]	Object3D
		material : MaterialBase	SegmentSet
		maxX : Number [override] [read-only] The maximum extremum of the object along the X-axis.	Entity
		maxY : Number [override] [read-only] The maximum extremum of the object along the Y-axis.	Entity
		maxZ : Number [override] [read-only] The maximum extremum of the object along the Z-axis.	Entity
		minX : Number [override] [read-only] The minimum extremum of the object along the X-axis.	Entity
		minY : Number [override] [read-only] The minimum extremum of the object along the Y-axis.	Entity
		minZ : Number [override] [read-only] The minimum extremum of the object along the Z-axis.	Entity
		modelViewProjection : Matrix3D [read-only] The current model-view-projection (MVP) matrix - the one on the top of the stack - used to transform from model to homogeneous projection space.	Entity
		mouseChildren : Boolean	ObjectContainer3D
		mouseEnabled : Boolean [override]	SegmentSet
		name : String	NamedAssetBase
		normalBufferOffset : int [read-only]	SegmentSet
		numChildren : uint [read-only] The amount of child objects of the ObjectContainer3D.	ObjectContainer3D
		numTriangles : uint [read-only]	SegmentSet
		orientation : String The orientaion in which the plane lies.	WireframePlane
		originalName : String [read-only] The original name used for this asset in the resource (e.g.	NamedAssetBase
		parent : ObjectContainer3D [read-only] The parent ObjectContainer3D to which this object's transformation is relative.	ObjectContainer3D
		partition : Partition3D The space partition to be used by the object container and all its recursive children, unless it has its own space partition assigned.	ObjectContainer3D
		pickingCollider : IPickingCollider Used by the raycast-based picking system to determine how the geometric contents of an entity are processed in order to offer more details for the picking collision object, including local position, normal vector and uv value.	Entity
		pickingCollisionVO : PickingCollisionVO [read-only] Returns a unique picking collision value object for the entity.	Entity
		pivotPoint : Vector3D Defines the local point around which the object rotates.	Object3D
		position : Vector3D Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		rightVector : Vector3D [read-only]	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 [override] A reference to the Scene3D object to which this object belongs.	Entity
		scenePosition : Vector3D [read-only] The global position of the ObjectContainer3D in the scene.	ObjectContainer3D
		sceneTransform : Matrix3D [read-only] The transformation matrix that transforms from model to world space.	ObjectContainer3D
		secondaryUVBufferOffset : int [read-only]	SegmentSet
		segmentsH : int The number of segments that make up the plane along the Y-axis.	WireframePlane
		segmentsW : int The number of segments that make up the plane along the X-axis.	WireframePlane
		shaderPickingDetails : Boolean Used by the shader-based picking system to determine whether a separate render pass is made in order to offer more details for the picking collision object, including local position, normal vector and uv value.	Entity
		showBounds : Boolean	Entity
		sourceEntity : Entity [read-only]	SegmentSet
		tangentBufferOffset : int [read-only]	SegmentSet
		thickness : Number	WireframePrimitiveBase
		transform : Matrix3D The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		upVector : Vector3D [read-only]	Object3D
		UVBufferOffset : int [read-only]	SegmentSet
		UVData : Vector.<Number> [read-only]	SegmentSet
		uvTransform : Matrix [read-only]	SegmentSet
		vertexBufferOffset : int [read-only]	SegmentSet
		vertexData : Vector.<Number> [read-only]	SegmentSet
		visible : Boolean	ObjectContainer3D
		width : Number The size of the cube along its X-axis.	WireframePlane
		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
		_bounds : BoundingVolumeBase	Entity
		_boundsInvalid : Boolean = true	Entity
		_explicitPartition : Partition3D	ObjectContainer3D
		_implicitPartition : Partition3D	ObjectContainer3D
		_mouseEnabled : Boolean	ObjectContainer3D
		_mvpIndex : int = -1	Entity
		_mvpTransformStack : Vector.<Matrix3D>	Entity
		_parent : ObjectContainer3D	ObjectContainer3D
		_pivotPoint : Vector3D	Object3D
		_pivotZero : Boolean = true	Object3D
		_pos : Vector3D	Object3D
		_rot : Vector3D	Object3D
		_sca : Vector3D	Object3D
		_scaleX : Number = 1	Object3D
		_scaleY : Number = 1	Object3D
		_scaleZ : Number = 1	Object3D
		_scene : Scene3D	ObjectContainer3D
		_sceneTransform : Matrix3D	ObjectContainer3D
		_sceneTransformDirty : Boolean = true	ObjectContainer3D
		_segments : Vector.<Segment>	SegmentSet
		_stackLen : uint	Entity
		_transform : Matrix3D	Object3D
		_transformComponents : Vector.<Vector3D>	Object3D
		_x : Number = 0	Object3D
		_y : Number = 0	Object3D
		_z : Number = 0	Object3D
		_zIndices : Vector.<Number>	Entity

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		WireframePlane(width:Number, height:Number, segmentsW:int = 10, segmentsH:int = 10, color:uint = 0xFFFFFF, thickness:Number = 1, orientation:String = yz) Creates a new WireframePlane object.	WireframePlane
		addChild(child:ObjectContainer3D):ObjectContainer3D Adds a child ObjectContainer3D to the current object.	ObjectContainer3D
		addChildren(... childarray):void Adds an array of 3d objects to the scene as children of the container	ObjectContainer3D
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]	ObjectContainer3D
		addSegment(segment:Segment):void	SegmentSet
		assetPathEquals(name:String, ns:String):Boolean	NamedAssetBase
		clone():Object3D [override] Clones this ObjectContainer3D instance along with all it's children, and returns the result (which will be a copy of this container, containing copies of all it's children.)	ObjectContainer3D
		contains(child:ObjectContainer3D):Boolean	ObjectContainer3D
		dispatchEvent(event:Event):Boolean [override]	ObjectContainer3D
		dispose():void [override]	SegmentSet
		disposeAsset():void	Object3D
		getChildAt(index:uint):ObjectContainer3D Retrieves the child object at the given index.	ObjectContainer3D
		getCustomBuffer(stage3DProxy:Stage3DProxy):VertexBuffer3D	SegmentSet
		getEntityPartitionNode():EntityNode Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance	Entity
		getIndexBuffer(stage3DProxy:Stage3DProxy):IndexBuffer3D	SegmentSet
		getSecondaryUVBuffer(stage3DProxy:Stage3DProxy):VertexBuffer3D	SegmentSet
		getSegment(index:uint):Segment	SegmentSet
		getUVBuffer(stage3DProxy:Stage3DProxy):VertexBuffer3D	SegmentSet
		getVertexBuffer(stage3DProxy:Stage3DProxy):VertexBuffer3D	SegmentSet
		getVertexNormalBuffer(stage3DProxy:Stage3DProxy):VertexBuffer3D	SegmentSet
		getVertexTangentBuffer(stage3DProxy:Stage3DProxy):VertexBuffer3D	SegmentSet
		lookAt(target:Vector3D, upAxis:Vector3D = null):void [override] Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.	ObjectContainer3D
		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
		popModelViewProjection():void Removes a model view projection matrix from the stack, used when leaving a render.	Entity
		pushModelViewProjection(camera:Camera3D):void [override]	WireframePrimitiveBase
		removeAllSegments():void [override]	WireframePrimitiveBase
		removeChild(child:ObjectContainer3D):void Removes a 3d object from the child array of the container	ObjectContainer3D
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]	ObjectContainer3D
		removeSegment(segment:Segment):void	SegmentSet
		resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void	NamedAssetBase
		roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
		rotate(axis:Vector3D, angle:Number):void [override]	ObjectContainer3D
		rotateTo(ax:Number, ay:Number, az:Number):void Rotates the 3d object directly to a euler angle	Object3D
		scale(value:Number):void Appends a uniform scale to the current transformation.	Object3D
		translate(axis:Vector3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
		translateLocal(axis:Vector3D, distance:Number):void [override]	ObjectContainer3D
		updateImplicitVisibility():void	ObjectContainer3D
		yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

	Method	Defined By
		buildGeometry():void [override]	WireframePlane
		createEntityPartitionNode():EntityNode [override]	SegmentSet
		getDefaultBoundingVolume():BoundingVolumeBase [override]	SegmentSet
		invalidateBounds():void Invalidates the bounding volume, causing to be updated when requested.	Entity
		invalidateGeometry():void	WireframePrimitiveBase
		invalidateSceneTransform():void [override] Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.	Entity
		updateBounds():void [override]	SegmentSet
		updateMouseChildren():void [override]	WireframePrimitiveBase
		updateOrAddSegment(index:uint, v0:Vector3D, v1:Vector3D):void	WireframePrimitiveBase
		updateSceneTransform():void Updates the scene transformation matrix.	ObjectContainer3D
		updateTransform():void	Object3D

Summary	Defined By
mouseDown3d	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	ObjectContainer3D
mouseMove3d	Dispatched when a user moves the cursor while it is over the 3d object.	ObjectContainer3D
mouseOut3d	Dispatched when a user moves the cursor away from the 3d object.	ObjectContainer3D
mouseOver3d	Dispatched when a user moves the cursor over the 3d object.	ObjectContainer3D
mouseUp3d	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	ObjectContainer3D
positionChanged	Dispatched when the position of the 3d object changes.	Object3D
rotationChanged	Dispatched when the rotation of the 3d object changes.	Object3D
scaleChanged	Dispatched when the scale of the 3d object changes.	Object3D
sceneChanged	Dispatched when the parent scene of the 3d object changes.	ObjectContainer3D
scenetransformChanged	Dispatched when the scene transform matrix of the 3d object changes.	ObjectContainer3D

	Constant	Defined By
		DEFAULT_NAMESPACE : String = default [static]	NamedAssetBase
		ORIENTATION_XY : String = xy [static]	WireframePlane
		ORIENTATION_XZ : String = xz [static]	WireframePlane
		ORIENTATION_YZ : String = yz [static]	WireframePlane

Property Detail

height

property

height:Number

The size of the cube along its Y-axis.

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

orientation

property

orientation:String

The orientaion in which the plane lies.

Implementation
public function get orientation():String
public function set orientation(value:String):void

segmentsH

property

segmentsH:int

The number of segments that make up the plane along the Y-axis.

Implementation
public function get segmentsH():int
public function set segmentsH(value:int):void

segmentsW

property

segmentsW:int

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

Implementation
public function get segmentsW():int
public function set segmentsW(value:int):void

width

property

width:Number

The size of the cube along its X-axis.

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

Constructor Detail

WireframePlane

()

Constructor

public function WireframePlane(width:Number, height:Number, segmentsW:int = 10, segmentsH:int = 10, color:uint = 0xFFFFFF, thickness:Number = 1, orientation:String = yz)

Creates a new WireframePlane object.

Parameters

	`width:Number` — The size of the cube along its X-axis.

	`height:Number` — The size of the cube along its Y-axis.

	`segmentsW:int` (default = `10`) — The number of segments that make up the cube along the X-axis.

	`segmentsH:int` (default = `10`) — The number of segments that make up the cube along the Y-axis.

	`color:uint` (default = `0xFFFFFF`) — The colour of the wireframe lines

	`thickness:Number` (default = `1`) — The thickness of the wireframe lines

	`orientation:String` (default = `yz`) — The orientaion in which the plane lies.

Method Detail

buildGeometry

()

method

override protected function buildGeometry():void

Constant Detail

ORIENTATION_XY

Constant

public static const ORIENTATION_XY:String = xy

ORIENTATION_XZ

Constant

public static const ORIENTATION_XZ:String = xz

ORIENTATION_YZ

Constant

public static const ORIENTATION_YZ:String = yz

Tue Jul 17 2012, 10:37 AM +01:00

Away3D Documentation	All Packages \| All Classes \| Index \| Frames No Frames
WireframePlane	Properties \| Methods \| Events \| Constants

Package	away3d.primitives
Class	public class WireframePlane
Inheritance	WireframePlane WireframePrimitiveBase SegmentSet Entity ObjectContainer3D Object3D NamedAssetBase flash.events.EventDispatcher