Class Object3D

Object
   |
   +--Object3D

class Object3D

Object3D is a class that defines 3D objects to displayed by Scene3D objects. A 3D object as defined is a face-vertex mesh. A face is an ordered list of vertex indices in the vertex array which are to be connected by lines. This model allows lines as well as surfaces and solids to all be Object3D objects.
Defined in Object3D.js

Requires:

- point3D
- Plane

Field Detail

faces

Array faces

The array of faces. A face is an ordered list of vertices to connect with line segments. [0, 4, 2, 3] for example, connects vertices 0, 4, 2, 3 and 0. This will be a 2-D array.

vertices

Array vertices

The list of vertices of the 3D object. An array of point3D's. Order is EXTREMELY important.

vertices2D

Array vertices2D

The list of vertices after being projected onto a plane. Might still be point3D objects, simply on a Plane now.

Object3D

Object3D(<Array> vertices, <Array> faces)

Creates a new 3D Object.

Parameters:
vertices - an array of point3D objects that are the vertices of the object
faces - (Optional) the array (2-dimensional!) of faces (i.e. [[0,1,2],[2,3,4]] defines two faces connecting vertices[0],vertices[1] and vertices[2], etc.)

Requires:
- point3D
- Plane

addFace

Object3D addFace(<Array> vertices)

Adds a face to the 3D Object.

Parameters:
vertices - the orderered list of vertex indices that should be connected to form a face

Returns:
this object, with updated faces array

draw

void draw(<Object> svg, <Object> settings)

Draws the given object. REQUIRES jQuery SVG. This function automatically "flips" the object because SVG's canvas goes from the bottom down. Make sure to adjust viewBox appropriately.

Parameters:
svg - the jQuery SVG object
settings - the settings to apply to each line of the wireframe; settings.transform = 'scale(1,-1)' automatically applied

to2D

Object3D to2D(<Number> focus)

After object has been moved to Scene coordinates (via viewIn method), this performs a perspective transformation to put the object in the XY plane.

Parameters:
focus - the focal distance (between camera and origin)

Returns:
this object, with vertices2D now being an array of point2D's

toEach

Object3D toEach(<Function> func)

Perform a function on each vertex of an object. Does not change faces.

Parameters:
func - the function to perform on each vertex

Returns:
this Object3D, with the specified function performed on each vertex

toString

String toString()

Generates a string representation of the Object (a face-vertex mesh).

Returns:
a list of all the vertices and faces

translate

Object3D translate(<Number> tx, <Number> ty, <Number> tz)

Translate an object by tx, ty, and tz. Performs the translation on every vertex.

Parameters:
tx - the x translation
ty - the y translation
tz - the z translation

Returns:
this Object3D, translated (NOT a new copy of the object)

viewIn

Object3D viewIn(<Object> camera)

Moves 3D object into new coordinates defined by 3D scene's camera. Updates this.vertices2D with coordinates in new system.

Parameters:
camera - the 3D Scene camera object through which to view this object; MUST have properties theta and phi

Returns:
this object, with updated vertices2D array

Cube

<static> Object3D Cube(<Number> side, <point3D> center)

Creates a new Cube as an Object3D object.

Parameters:
side - the length of each side of the cube.
center - (optional) the center point of the cube, default is (0,0,0)

Returns:
a new Object3D representing the specified cube

Line

<static> Object3D Line(<Array> points)

Creates a new line as an Object3D

Parameters:
points - an Array of point2D or point3D objects that define the line sequentially

Returns:
a line through each of the points in the points array as an Object3D

Sphere

<static> Object3D Sphere(<Number> rad, <point3D> cent, <Number> segments)

Creates a new Sphere as an Object3D object.

Parameters:
rad - the radius of the sphere
cent - (optional) the center of the sphere; defaults to (0,0,0)
segments - (optional) the number of segments to divide the sphere into; directly relates to the number of vertices/faces

Returns:
a new Object3D that defines a sphere as outlined above

Xaxis

<static> Object3D Xaxis(<Number> min, <Number> max)

Creates a new 3D Object that is the x-axis.

Parameters:
min - the minimum x value
max - the maximum x value

Returns:
the x-axis between min and max

Yaxis

<static> Object3D Yaxis(<Number> min, <Number> max)

Creates a new 3D Object that is the y-axis.

Parameters:
min - the minimum y value
max - the maximum y value

Returns:
the y-axis between min and max

Zaxis

<static> Object3D Zaxis(<Number> min, <Number> max)

Creates a new 3D Object that is the z-axis.

Parameters:
min - the minimum z value
max - the maximum z value

Returns:
the z-axis between min and max