This is a quick overview tutorial of the WireframeRegularPolygon primitive in the Away3D TypeScript library.
We will be recreating the scene as seen above.
To use a WireframeRegularPolygon primitive, we’ll need to:
- Declare, instantiate, and initialize a new WireframeRegularPolygon object.
- Add the WireframeRegularPolygon object to the scene.
Notice, we do not place the wireframe in a Mesh object. This is because a Mesh would be overkill, trying to apply materials, shaders, and what have you. So just add the wireframe object as a child of the scene itself.
This tutorial builds off of the Away3D TypeScript: Primitives – Cube. All the new or changed code will be highlighted in the full code block below.
An error has occurred. Please try again later.
Line 5 renames the class to WireframeRegularPolygon.
Lines 14,15,50,56,57,58,74,75 you can comment out. We will not be using these lines from the template.
Line 17 declares a variable named _objectWireframe of type WireFrameRegularPolygon().
Line 60 instantiates a new WireFrameRegularPolygon object referenced by the variable _objectWireframe. It was initialized with 250, 10, 0xFFFFFF, 1: which we’ll discuss more later.
Line 61 adds the WireFrameRegularPolygon object to the scene.
Lines 76-77 adds a spin to our WireFrameRegularPolygon object on every frame of animation.
Line 102 changes the called class name to WireframeRegularPolygon.
That’s it, our object is in the scene.
However, we glazed over the initialization process, let’s take a closer look at the object’s constructor.
The constructor looks as follows:
WireframeRegularPolygon(radius:Number, sides:int, color:uint = 0xFFFFFF, thickness:Number = 1, orientation:String = xz)
The Constructor’s Parameters:
- radius:Number (default = 50) — The radius of the polygon.
- sides:Number (default = 16) — The number of sides on the polygon.
- color:uint (default = 0xFFFFFF) — The color of the wireframe lines
- thickness:Number (default = 1) — The thickness of the wireframe lines
- orientation:String (default = xz) — The orientation in which the tetrahedron lies.
So in our initialization we stated:
this._objectWireframe = new away.primitives.WireframeRegularPolygon(250, 10, 0xFFFFFF, 1);
Which created a WireframeRegularPolygon:
- A radius of 250 units.
- 10 sides to the polygon.
- colored white (0xFFFFFF).
- With a line thickness of 1 units.
- We left the orientation at the default (XZ)
Adding a basic primitive is relatively easy. Just understanding the constructor and what the parameters are, is the hardest part. You can look at the official documentation here.