View source

class WireframePlane

package away3d.primitives

extends WireframePrimitiveBase › SegmentSet › Entity › ObjectContainer3D › Object3D › NamedAssetBase

Available on all platforms

A WireframePlane primitive mesh.

Static variables

@:value("xy")staticinlineread onlyORIENTATION_XY:String = "xy"

@:value("xz")staticinlineread onlyORIENTATION_XZ:String = "xz"

@:value("yz")staticinlineread onlyORIENTATION_YZ:String = "yz"

Constructor

@:value({ orientation : "yz", thickness : 1, color : 0xFFFFFF, segmentsH : 10, segmentsW : 10 })new(width:Float, height:Float, segmentsW:Int = 10, segmentsH:Int = 10, color:Int = 0xFFFFFF, thickness:Float = 1, orientation:String = "yz")

Creates a new WireframePlane object.

Parameters:

width

The size of the cube along its X-axis.

height

The size of the cube along its Y-axis.

segmentsW

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

segmentsH

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

color

The colour of the wireframe lines

thickness

The thickness of the wireframe lines

orientation

The orientaion in which the plane lies.

Variables

height:Float

orientation:String

segmentsH:Int

segmentsW:Int

width:Float

Inherited Variables

Defined by WireframePrimitiveBase

color:Int

thickness:Float

Defined by SegmentSet

read onlyUVData:Vector<Float>

read onlyanimator:IAnimator

read onlycastsShadows:Bool

read onlyindexData:Vector<UInt>

material:MaterialBase

read onlynumTriangles:Int

read onlynumVertices:Int

read onlysegmentCount:Int

read onlysourceEntity:Entity

read onlyuvTransform:Matrix

read onlyuvTransform2:Matrix

read onlyvertexData:Vector<Float>

read onlyvertexNormalData:Vector<Float>

read onlyvertexNormalOffset:Int

read onlyvertexOffset:Int

read onlyvertexStride:Int

read onlyvertexTangentData:Vector<Float>

read onlyvertexTangentOffset:Int

Defined by Entity

Defined by ObjectContainer3D

read onlyassetType:String

ignoreTransform:Bool

read onlyinverseSceneTransform:Matrix3D

read onlymaxX:Float

read onlymaxY:Float

read onlymaxZ:Float

read onlyminX:Float

read onlyminY:Float

read onlyminZ:Float

mouseChildren:Bool

mouseEnabled:Bool

read onlynumChildren:Int

read onlyparent:ObjectContainer3D

partition:Partition3D

scene:Scene3D

read onlyscenePosition:Vector3D

read onlysceneTransform:Matrix3D

visible:Bool

Defined by Object3D

read onlybackVector:Vector3D

read onlydownVector:Vector3D

eulers:Vector3D

extra:Dynamic

An object that can contain any extra data.

read onlyforwardVector:Vector3D

read onlyleftVector:Vector3D

pivotPoint:Vector3D

position:Vector3D

read onlyrightVector:Vector3D

rotationX:Float

rotationY:Float

rotationZ:Float

scaleX:Float

scaleY:Float

scaleZ:Float

transform:Matrix3D

read onlyupVector:Vector3D

x:Float

y:Float

z:Float

zOffset:Int

Defined by NamedAssetBase

read onlyassetFullPath:Array<Dynamic>

read onlyassetNamespace:String

id:String

name:String

read onlyoriginalName:String

Inherited Methods

Defined by WireframePrimitiveBase

Defined by SegmentSet

activateSecondaryUVBuffer(index:Int, stage3DProxy:Stage3DProxy):Void

activateUVBuffer(index:Int, stage3DProxy:Stage3DProxy):Void

activateVertexBuffer(index:Int, stage3DProxy:Stage3DProxy):Void

activateVertexNormalBuffer(index:Int, stage3DProxy:Stage3DProxy):Void

activateVertexTangentBuffer(index:Int, stage3DProxy:Stage3DProxy):Void

addSegment(segment:Segment):Void

Adds a new segment to the SegmentSet.

Parameters:

segment

the segment to add

dispose():Void

@inheritDoc

getIndexBuffer(stage3DProxy:Stage3DProxy):IndexBuffer3D

getRenderSceneTransform(camera:Camera3D):Matrix3D

getSegment(index:Int):Segment

Returns:

a segment object from a given index.

@:value({ dispose : false })removeSegment(segment:Segment, dispose:Bool = false):Void

Removes a segment from the SegmentSet.

Parameters:

segment

The segment to remove

dispose

If the segment must be disposed as well. Default is false;

@:value({ dispose : false })removeSegmentByIndex(index:Int, dispose:Bool = false):Void

Removes a segment from the SegmentSet by its index in the set.

Parameters:

index

The index of the segment to remove

dispose

If the segment must be disposed as well. Default is false; Removing a Segment by an index when segment is unknown index of the segment is relative to the order it was added to the segmentSet. If a segment was removed from or added to the segmentSet, a segment index may have changed. The index of each Segment is updated when one is added or removed. If 2 segments are added, segment #1 has index 0, segment #2 has index 1 if segment #1 is removed, segment#2 will get index 0 instead of 1.

Defined by Entity

getEntityPartitionNode():EntityNode

Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance

internalUpdate():Void

isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Bool

Defined by ObjectContainer3D

addChild(child:ObjectContainer3D):ObjectContainer3D

Adds a child ObjectContainer3D to the current object. The child's transformation will become relative to the current object's transformation.

Parameters:

child

The object to be added as a child.

Returns:

A reference to the added child object.

addChildren(childarray:Vector<ObjectContainer3D>):Void

Adds an array of 3d objects to the scene as children of the container

Parameters:

...childarray

An array of 3d objects to be added

clone():Object3D

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.)

contains(child:ObjectContainer3D):Bool

dispatchEvent(event:Event):Bool

@inheritDoc

disposeWithChildren():Void

Disposes the current ObjectContainer3D including all of its children. This is a merely a convenience method.

getChildAt(index:Int):ObjectContainer3D

Retrieves the child object at the given index.

Parameters:

index

The index of the object to be retrieved.

Returns:

The child object at the given index.

@:value({ upAxis : null })lookAt(target:Vector3D, ?upAxis:Vector3D):Void

@inheritDoc

removeChild(child:ObjectContainer3D):Void

Removes a 3d object from the child array of the container

Parameters:

child

The 3d object to be removed

Throws:

Error

ObjectContainer3D.removeChild(null)

removeChildAt(index:Int):Void

Removes a 3d object from the child array of the container

Parameters:

index

Index of 3d object to be removed

updateImplicitVisibility():Void

Defined by Object3D

disposeAsset():Void

@inheritDoc

@:value({ v : null })getPosition(?v:Vector3D):Vector3D

Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. @return

Parameters:

v

the destination Vector3D

moveBackward(distance:Float):Void

Moves the 3d object backwards along it's local z axis

Parameters:

distance

The length of the movement

moveDown(distance:Float):Void

Moves the 3d object backwards along it's local y axis

Parameters:

distance

The length of the movement

moveForward(distance:Float):Void

Moves the 3d object forwards along it's local z axis

Parameters:

distance

The length of the movement

moveLeft(distance:Float):Void

Moves the 3d object backwards along it's local x axis

Parameters:

distance

The length of the movement

movePivot(dx:Float, dy:Float, dz:Float):Void

Moves the local point around which the object rotates.

Parameters:

dx

The amount of movement along the local x axis.

dy

The amount of movement along the local y axis.

dz

The amount of movement along the local z axis.

moveRight(distance:Float):Void

Moves the 3d object forwards along it's local x axis

Parameters:

distance

The length of the movement

moveTo(dx:Float, dy:Float, dz:Float):Void

Moves the 3d object directly to a point in space

Parameters:

dx

The amount of movement along the local x axis.

dy

The amount of movement along the local y axis.

dz

The amount of movement along the local z axis.

moveUp(distance:Float):Void

Moves the 3d object forwards along it's local y axis

Parameters:

distance

The length of the movement

pitch(angle:Float):Void

Rotates the 3d object around it's local x-axis

Parameters:

angle

The amount of rotation in degrees

roll(angle:Float):Void

Rotates the 3d object around it's local z-axis

Parameters:

angle

The amount of rotation in degrees

rotateTo(ax:Float, ay:Float, az:Float):Void

Rotates the 3d object directly to a euler angle

Parameters:

ax

The angle in degrees of the rotation around the x axis.

ay

The angle in degrees of the rotation around the y axis.

az

The angle in degrees of the rotation around the z axis.

scale(value:Float):Void

Appends a uniform scale to the current transformation.

Parameters:

value

The amount by which to scale.

translate(axis:Vector3D, distance:Float):Void

Moves the 3d object along a vector by a defined length

Parameters:

axis

The vector defining the axis of movement

distance

The length of the movement

yaw(angle:Float):Void

Rotates the 3d object around it's local y-axis

Parameters:

angle

The amount of rotation in degrees

Defined by NamedAssetBase

assetPathEquals(name:String, ns:String):Bool

@:value({ overrideOriginal : true, ns : null })resetAssetPath(name:String, ?ns:String, overrideOriginal:Bool = true):Void