Class Scene3D

Object
   |
   +--Scene3D

class Scene3D

Scene3D defines a new 3D scene (shocking, I know). A 3D Scene has two main components: objects (to be displayed), and a camera (from which to view the objects). In this model of a 3D scene, the camera is the main mover, not the objects (though they can be moved). A view plane is defined through the origin with a normal in the direction from the origin to the camera; the objects are projected onto this view plane, which is then matched up with the 2D plane of the screen.
Most methods return this, so calls can be made sequentially.
Defined in Scene3D.js

Requires:

- point3D
- Plane

Field Detail

camera

point3D camera

The "camera" is the point from which the objects are being viewed. It is a dynamically defined Object with three properties: loc (point3D), theta (Number), and phi (Number). Theta is the angle between the positive x axis and the orthogonal projection of the camera onto the XY-plane. Phi is the angle between the camera and the positive z-axis.

focus

Number focus

The focus is the distance between the camera and the origin (in world coordinates)

objects

Array objects

The objects to be viewed/displayed. An array of Object3D objects.

plane

Plane plane

The view plane, onto which the objects are projected.

Scene3D

Scene3D(<Array> objs, <point3D> camera)

The constructor function for a new Scene3D object.

Parameters:
objs - an Array of Object3D objects to be displayed
camera - the position of the camera (as a point3D object); used to generate initial focus and view plane; also used to define this.camera = {loc: point3D, theta: angle, phi: angle}

Requires:
- point3D
- Plane

addObject

Scene3D addObject(<Object3D> obj)

Add an object to the 3D Scene.

Parameters:
obj - the object to be added to the 3D Scene

Returns:
this Scene3D, with the object added (returns null if obj is not an Object3D)

draw

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

Draws the 3D scene, with the specified objects. REQUIRES jQuery SVG.

Parameters:
objs - an array of object indices to be displayed.
svg - the jQuery SVG object in which to draw the scene
settings - the settings to give to each line of the objects; can be an Array of settings, where each index of the array corresponds to the index of the objects passed to this function

emptySVG

Scene3D emptySVG(<Object> svg)

Empties the SVG canvas supplied.

Parameters:
svg - the jQuery SVG root canvas

Returns:
this Scene3D object, so calls can be stringed together

rotateCamera

Scene3D rotateCamera(<Number> theta, <Number> phi)

Moves the camera to a new position. Parameters are two angles, one in the XY-plane from the positive x-axis and the other from the positive z-axis.

Parameters:
theta - the degree (in radians) to rotate the camera from the positive x-axis
phi - the degree (in radians) to rotate the camera from the positive z-axis

Returns:
this Scene3D object, with updated camera and view plane

setFocus

Scene3D setFocus(<Number> dist)

Sets the focus (distance between Origin and camera).

Parameters:
dist - the new focal distance

Returns:
this Scene3D object, with updated focus distance and matching camera position

toString

String toString()

Returns a string representation of the Scene (camera and objects).

Returns:
the location of the camera plus a list of all the objects

See:
- Object3D.toString()