Packagesandy.primitive
Classpublic class Plane3D
InheritancePlane3D Inheritance Shape3D Inheritance ATransformable Inheritance Node
ImplementsPrimitive3D

The Plane3D is used for creating a plane primitive


Example
To create a plane 100 by 100, with default number of faces, and the default quality and alignment here is the statement: 
      var plane:Plane3D = new Plane3D( "thePlane", 100, 100 );
To create the same plane aligned paralell to the zx-plane use: 
      var plane:Plane3D = new Plane3D( "thePlane", 100, 100, 1, 1, Plane3D.XY_ALIGNED );


Public Properties
 PropertyDefined by
 InheritedaPolygons : Array
The array of polygons building this object.
Shape3D
 Inheritedappearance : Appearance
The appearance of this object.
Shape3D
 InheritedboundingBox : BBox
The bounding box of this node IMPORTANT: Do not modify it unless you perfectly know what you are doing
Node
 InheritedboundingSphere : BSphere
The bounding sphere of this node IMPORTANT: Do not modify it unless you perfectly know what you are doing
Node
 Inheritedbroadcaster : BubbleEventBroadcaster
The broadcaster

The broadcaster is used to send events to listeners.
This property is a BubbleEventBroadcaster.

Node
 Inheritedchanged : Boolean = false
This property set the cache status of the current node.
Node
 Inheritedchildren : Array
The children of this node are stored inside this array.
Node
 Inheritedcontainer : Sprite
The contianer for this object.
Shape3D
 Inheritedculled : CullingState
This property represent the culling state of the current node.
Node
 InheritedDEFAULT_APPEARANCE : Appearance
[static] Default appearance for Shape3D instances.
Shape3D
 InheritedDEFAULT_MATERIAL : Material
[static] Default material for the DEFAULT_APPEARANCE object
Shape3D
 Inheriteddepth : Number
The depth of this object.
Shape3D
 Inheriteddisable : Boolean = false
Disable the local transformations applied to this Node if set to false.
ATransformable
 InheritedenableBackFaceCulling : Boolean
Should back face culling be enabled for this object?.
Shape3D
 InheritedenableClipping : Boolean = false

Enable the Frustum clipping on the visible polygons.

Shape3D
 InheritedenableEvents : Boolean
Enables the event system for mouse events.
Shape3D
 InheritedenableForcedDepth : Boolean = false
Should forced depth be enable for this object?.
Shape3D
 InheritedenableInteractivity : Boolean
Shape3D
 InheritedenableNearClipping : Boolean = false

Enable the Frustum near plane clipping on the visible polygons.

Shape3D
 InheritedforcedDepth : Number = 0
The forced depth for this object.
Shape3D
 Inheritedgeometry : Geometry3D
The geometry of this object.
Shape3D
 InheritedgeometryCenter : Vector
This property call allows you to get the geometryCenter offset vector of the Shape.
Shape3D
 Inheritedmatrix : Matrix4
ATransformable
 InheritedmodelMatrix : Matrix4
Cached matrix corresponding to the transformation to the 0,0,0 frame system
Node
 Inheritedname : String
Name of this node.
Node
 Inheritedout : Vector
Forward direction ( local z ) in parent coordinates.
ATransformable
 Inheritedpan : Number
Pans this object around the local y axis.
ATransformable
 Inheritedparent : Node
The parent node of this node.
Node
 Inheritedroll : Number
Rolls this object around the local z axis.
ATransformable
 InheritedrotateX : Number
Rotates this object around an axis parallel to the parents x axis.
ATransformable
 InheritedrotateY : Number
Rotates this object around an axis parallel to the parents y axis.
ATransformable
 InheritedrotateZ : Number
Rotates this object around an axis paralell to the parents z axis.
ATransformable
 InheritedscaleX : Number
x scale of this object.
ATransformable
 InheritedscaleY : Number
y scale of this object.
ATransformable
 InheritedscaleZ : Number
z scale of this object.
ATransformable
 Inheritedscene : Scene3D = null
Reference to the scene is it linked to.
Node
 Inheritedside : Vector
Side direction ( local x ) in parent coordinates.
ATransformable
 Inheritedtarget : Vector
The position in the parent frame this object should "look at".
ATransformable
 Inheritedtilt : Number
Getter for the tilt value
ATransformable
 Inheritedup : Vector
Up direction ( local y ) in parent coordinates.
ATransformable
 InheriteduseSingleContainer : Boolean
setter that allow user to change the way to render this object.
Shape3D
 InheritedviewMatrix : Matrix4
Cached matrix corresponding to the transformation to the camera frame system
Node
 Inheritedvisible : Boolean = true
Specify the visibility of this node.
Node
 Inheritedx : Number
x position of this object in its parent frame.
ATransformable
 Inheritedy : Number
y position of this object in its parent frame.
ATransformable
 Inheritedz : Number
z position of the node in its parent frame.
ATransformable
Protected Properties
 PropertyDefined by
 Inheritedm_bUseSingleContainer : Boolean = true
Shape3D
 Inheritedm_nDepth : Number = 0
Shape3D
 Inheritedm_oContainer : Sprite
Shape3D
 Inheritedm_oEB : BubbleEventBroadcaster
Node
 Inheritedm_oGeomCenter : Vector
Shape3D
 Inheritedm_oPreviousOffsetRotation : Vector
ATransformable
 Inheritedm_tmpMt : Matrix4
ATransformable
 Inherited_oScale : Vector
ATransformable
 Inherited_p : Vector
ATransformable
 Inherited_vOut : Vector
ATransformable
 Inherited_vSide : Vector
ATransformable
 Inherited_vUp : Vector
ATransformable
Public Methods
 MethodDefined by
  
Plane3D(p_sName:String = null, p_nHeight:Number = 100, p_nWidth:Number = 100, p_nQualityH:uint = 1, p_nQualityV:uint = 1, p_sType:String, p_sMode:String = null)
Creates a Plane primitive.
Plane3D
 Inherited
addChild(p_oChild:Node):void
Adds a new child to this node.
Node
 Inherited
addEventListener(p_sEvt:String, p_oL:*):void
Adds a listener for the specified event.
Node
 Inherited
clear():void
Clears the graphics object of this object's container.
Shape3D
 Inherited
clone(p_sName:String = "", p_bKeepTransform:Boolean = false):Shape3D
This method returns a clone of this Shape3D.
Shape3D
 Inherited
cull(p_oScene:Scene3D, p_oFrustum:Frustum, p_oViewMatrix:Matrix4, p_bChanged:Boolean):void
Tests this node against the camera frustum to get its visibility.
Shape3D
 Inherited
destroy():void
Destroy this object and all its faces container object is removed, and graphics cleared.
Shape3D
 Inherited
display(p_oScene:Scene3D, p_oContainer:Sprite = null):void
Performs a z-sorting and renders the objects visible polygons.
Shape3D
  
generate(... arguments):Geometry3D
Generates the geometry for this Shape3D
Plane3D
 Inherited
getChildByName(p_sName:String, p_bRecurs:Boolean = false):Node
Returns the child node with the specified name.
Node
 Inherited
getChildFromId(p_nId:uint, p_bRecurs:Boolean = false):Node
Returns the child node with the specified id.
Node
 Inherited
getChildList():Array
Returns an array with all child nodes of this node.
Node
 Inherited
getPosition(p_sMode:String = "local"):Vector
Returns the position of this group or object.
ATransformable
 Inherited
hasParent():Boolean
Tests if this node has a parent.
Node
 Inherited
initFrame():void
Initiates the local coordinate system for this object.
ATransformable
 Inherited
isParent(p_oNode:Node):Boolean
Tests if the node passed in the argument is parent of this node.
Node
 Inherited
lookAt(p_nX:Number, p_nY:Number, p_nZ:Number):void
Makes this object "look at" the specified position in the parent frame.
ATransformable
 Inherited
moveForward(p_nD:Number):void
Translates this object along its forward vector ( local z ) in the parent frame.
ATransformable
 Inherited
moveHorizontally(p_nD:Number):void
Translates this object parallel to its parent zx plane and in its forward direction.
ATransformable
 Inherited
moveLateraly(p_nD:Number):void
Translates this object laterally in its parent frame.
ATransformable
 Inherited
moveSideways(p_nD:Number):void
Translates this object along its side vector ( local x ) in the parent frame.
ATransformable
 Inherited
moveUpwards(p_nD:Number):void
Translates this object along its up vector ( local y ) in the parent frame.
ATransformable
 Inherited
moveVertically(p_nD:Number):void
Translates this object vertically in ots parent frame.
ATransformable
 Inherited
remove():void
Removes this node from the node tree, saving its child nodes.
Node
 Inherited
removeChildById(p_nId:Number):Boolean
Removes the child node with the specified id.
Node
 Inherited
removeChildByName(p_sName:String):Boolean
Removes the child node with the specified name.
Node
 Inherited
removeEventListener(p_sEvt:String, p_oL:*):void
Removes a listener for the specified event.
Node
 Inherited
render(p_oScene:Scene3D, p_oCamera:Camera3D):void
Renders this 3D object.
Shape3D
 Inherited
rotateAxis(p_nX:Number, p_nY:Number, p_nZ:Number, p_nAngle:Number):void
Rotate this object around the specified axis in the parent frame by the specified angle.
ATransformable
 Inherited
setPosition(p_nX:Number, p_nY:Number, p_nZ:Number):void
Sets the position of this object in coordinates of its parent frame.
ATransformable
 Inherited
swapCulling():void
Changes the backface culling side.
Shape3D
 Inherited
swapParent(p_oNewParent:Node):void
Moves this node to another parent node.
Node
 Inherited
toString():String
Returns a string representation of this object
Shape3D
 Inherited
translate(p_nX:Number, p_nY:Number, p_nZ:Number):void
Translate this object from it's current position with the specified offsets.
ATransformable
 Inherited
update(p_oScene:Scene3D, p_oModelMatrix:Matrix4, p_bChanged:Boolean):void
Updates this node or object.
ATransformable
 Inherited
updateBoundingVolumes():void
Updates the bounding volumes of this object.
Shape3D
 Inherited
updateTransform():void
Updates the transform matrix of the current object/node before it is rendered.
ATransformable
Protected Methods
 MethodDefined by
 Inherited
_onInteraction(p_oEvt:Event):void
Shape3D
Public Constants
 ConstantDefined by
 Inheritedid : uint
The unique id of this node in the node graph.
Node
  XY_ALIGNED : String = "xy_aligned"
[static]
Plane3D
  YZ_ALIGNED : String = "yz_aligned"
[static]
Plane3D
  ZX_ALIGNED : String = "zx_aligned"
[static]
Plane3D
Constructor detail
Plane3D()constructor
public function Plane3D(p_sName:String = null, p_nHeight:Number = 100, p_nWidth:Number = 100, p_nQualityH:uint = 1, p_nQualityV:uint = 1, p_sType:String, p_sMode:String = null)

Creates a Plane primitive.

The plane is vreated with its center in the origin of the global coordinate system, and paralell to one of the global coordinate planes in accordance with the alignment parameter
The plane is divided in rectangular or triangular polygons

Parameters
p_sName:String (default = null) — p_nHeight
 
p_nHeight:Number (default = 100) — p_nWidth
 
p_nWidth:Number (default = 100) — p_nQualityH Number of segments horizontally
 
p_nQualityH:uint (default = 1) — Number of segments vertically
 
p_nQualityV:uint (default = 1) — Alignment of the plane, one of XY_ALIGNED ( default ), YZ_ALIGNED or ZX_ALIGNED
 
p_sType:String — p_sMode One of two available face generation modes: "tri" generates faces with 3 vertices, "quad" generates faces with 4 vertices.
 
p_sMode:String (default = null)
Method detail
generate()method
public function generate(... arguments):Geometry3D

Generates the geometry for this Shape3D

Parameters
... arguments

Returns
Geometry3D

See also

sandy.core.data.Vertex
sandy.core.data.UVCoord
sandy.core.data.Polygon
Constant detail
XY_ALIGNEDconstant
public static const XY_ALIGNED:String = "xy_aligned"
YZ_ALIGNEDconstant 
public static const YZ_ALIGNED:String = "yz_aligned"
ZX_ALIGNEDconstant 
public static const ZX_ALIGNED:String = "zx_aligned"



ASDoc: Preliminary documentation for the Sandy 3D Engine, version 3.0.1