Packageaway3dlite.primitives
Classpublic class Torus
InheritanceTorus Inheritance AbstractPrimitive Inheritance Mesh Inheritance Object3D Inheritance flash.display.Sprite

Creates a 3d torus primitive.

Public Properties
 PropertyDefined by
 InheritedanimationLibrary : AnimationLibrary
Used in the loaders to store all parsed animation data contained in the model.
Object3D
 Inheritedbothsides : Boolean
Determines whether the faces in teh mesh are visible on both sides (true) or just the front side (false).
Mesh
 Inheritedfaces : Vector
Returns the faces used in the mesh.
AbstractPrimitive
 InheritedgeometryLibrary : GeometryLibrary
Used in loaders to store all parsed geometry data contained in the model.
Object3D
 Inheritedlayer : Sprite
An optional layer sprite used to draw into inseatd of the default view.
Object3D
 Inheritedmaterial : Material
Determines the global material used on the faces in the mesh.
Mesh
 InheritedmaterialLibrary : MaterialLibrary
Used in loaders to store all parsed materials contained in the model.
Object3D
 Inheritedposition : Vector3D
Returns a 3d vector representing the local position of the 3d object.
Object3D
  radius : Number
Defines the overall radius of the torus.
Torus
 Inheritedscene : Scene3D
Returns the scene to which the 3d object belongs
Object3D
 InheritedsceneMatrix3D : Matrix3D
Returns a 3d matrix representing the absolute transformation of the 3d object in the scene.
Object3D
 InheritedscreenZ : Number
Returns the z-sorting position of the 3d object.
Object3D
  segmentsR : Number
Defines the number of radial segments that make up the torus.
Torus
  segmentsT : Number
Defines the number of tubular segments that make up the torus.
Torus
 InheritedsortFaces : Boolean = true
Determines if the faces in the mesh are sorted.
Mesh
 InheritedsortType : String
Determines by which mechanism vertices are sorted.
Mesh
  tube : Number
Defines the tube radius of the torus.
Torus
 Inheritedtype : String
Returns the type of 3d object.
Object3D
 Inheritedurl : String
Returns the source url of the 3d object, or the name of the family of generative geometry objects if not loaded from an external source.
Object3D
 Inheritedvertices : Vector
Returns the 3d vertices used in the mesh.
AbstractPrimitive
 InheritedviewMatrix3D : Matrix3D
Returns a 3d matrix representing the absolute transformation of the 3d object in the view.
Object3D
  yUp : Boolean
Defines whether the coordinates of the torus points use a yUp orientation (true) or a zUp orientation (false).
Torus
Protected Properties
 PropertyDefined by
 Inherited_vertexNormals : Vector
Mesh
Public Methods
 MethodDefined by
  
Torus
(material:Material = null, radius:Number = 100, tube:Number = 40, segmentsR:int = 8, segmentsT:int = 6, yUp:Boolean = true)
Creates a new Torus object.
Torus
  
clone(object:Object3D = null):Object3D
Duplicates the torus properties to another Torus object.
Torus
 Inherited
lookAt(target:Vector3D, upAxis:Vector3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
Object3D
Protected Methods
 MethodDefined by
  
Builds the vertex, face and uv objects that make up the 3d primitive.
Torus
 Inherited
copyMatrix3D(m1:Matrix3D, m2:Matrix3D):void
Object3D
 Inherited
AbstractPrimitive
Events
 EventSummaryDefined by
 Inherited Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor while it is over the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor away from the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor over the 3d object.Object3D
 Inherited Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when a user rolls out of the 3d object.Object3D
 Inherited Dispatched when a user rolls over the 3d object.Object3D
Property detail
radiusproperty
radius:Number  [read-write]

Defines the overall radius of the torus. Defaults to 100.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
segmentsRproperty 
segmentsR:Number  [read-write]

Defines the number of radial segments that make up the torus. Defaults to 8.

Implementation
    public function get segmentsR():Number
    public function set segmentsR(value:Number):void
segmentsTproperty 
segmentsT:Number  [read-write]

Defines the number of tubular segments that make up the torus. Defaults to 6.

Implementation
    public function get segmentsT():Number
    public function set segmentsT(value:Number):void
tubeproperty 
tube:Number  [read-write]

Defines the tube radius of the torus. Defaults to 40.

Implementation
    public function get tube():Number
    public function set tube(value:Number):void
yUpproperty 
yUp:Boolean  [read-write]

Defines whether the coordinates of the torus points use a yUp orientation (true) or a zUp orientation (false). Defaults to true.

Implementation
    public function get yUp():Boolean
    public function set yUp(value:Boolean):void
Constructor detail
Torus()constructor
public function Torus(material:Material = null, radius:Number = 100, tube:Number = 40, segmentsR:int = 8, segmentsT:int = 6, yUp:Boolean = true)Parameters
material:Material (default = null) — Defines the global material used on the faces in the torus.
 
radius:Number (default = 100) — Defines the overall radius of the torus.
 
tube:Number (default = 40) — Defines the tube radius of the torus.
 
segmentsR:int (default = 8) — Defines the number of radial segments that make up the torus.
 
segmentsT:int (default = 6) — Defines the number of tubular segments that make up the torus.
 
yUp:Boolean (default = true) — Defines whether the coordinates of the torus points use a yUp orientation (true) or a zUp orientation (false).
Init Parameters
Method detail
buildPrimitive()method
protected override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

clone()method 
public override function clone(object:Object3D = null):Object3D

Duplicates the torus properties to another Torus object.

Parameters
object:Object3D (default = null) — [optional] The new object instance into which all properties are copied. The default is Torus.

Returns
Object3D — The new object instance with duplicated properties applied.
Wiki link
Click to go to the wiki page for 'away3dlite.primitives.Torus'

Code examples

Comments