This is a quick overview tutorial of the WireframeCube primitive in the Away3D TypeScript library.
We will be recreating the scene as seen above.
To use a WireframeCube primitive, we’ll need to:
- Declare, instantiate, and initialize a new WireframeCube object.
- Add the WireframeCube 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 WireframeCube.
Line 17 declares a variable named _objectWireframe of type WireFrameCube().
Line 60 instantiates a new WireFrameCube object referenced by the variable _objectWireframe. It was initialized with 300, 300, 300, 0xFFFFFF, 1: which we’ll discuss more later.
Line 61 adds the WireFrameCube object to the scene.
Line 75 adds a spin to our WireFrameCube object on every frame of animation.
Line 100 changes the called class name to WireframeCube.
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:
WireframeCube(width:Number = 100, height:Number = 100, depth:Number = 100, color:uint = 0xFFFFFF, thickness:Number = 1)
The Constructor’s Parameters:
- width:Number (default = 100) — The size of the cube along its X-axis.
- height:Number (default = 100) — The size of the cube along its Y-axis.
- depth:Number (default = 100) — The size of the cube along its Z-axis.
- color:uint (default = 0xFFFFFF) — The color of the wireframe lines
- thickness:Number (default = 1) — The thickness of the wireframe lines
So in our initialization we stated:
this._objectWire = new away.primitives.WireframeCube(300, 300, 300, 0xFFFFFF, 1);
Which created a WireframeCube:
- 300 units wide.
- 300 units high.
- 300 units deep.
- colored white (0xFFFFFF).
- With a line thickness of 1 units.
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.