Skip to content

Commit

Permalink
Update comments and documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
alan-wu committed Jan 23, 2019
1 parent 13c8a4e commit 18bd077
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/modules/ScaffoldViewer.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ var THREE = require('zincjs').THREE;
var ITEM_LOADED = require("../utility").ITEM_LOADED;

/**
* Provides rendering of the 3D-scaffold data created from ScaffikdNjaer,
* Provides rendering of the 3D-scaffold data created from Scaffoldmaker,
* @class
*
* @author Alan Wu
Expand Down
13 changes: 11 additions & 2 deletions src/utilities/csg.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@ var Zinc = require('zincjs');
var dat = require('../ui/dat.gui');
var THREE = Zinc.THREE;

/**
* This module provides quick access to constructive solid geometries (CSG) and surfaces cutting on said
* geometries.
*
* @class
* @param {Zinc.Scene} sceneIn - scene containing geometries for conversion, once intersected
* surfaces are created they are drawn on this scene.
* @param {Zinc.Renderer} zincRendererIn - renderer.
* @author Alan Wu
* @returns {exports.csg}
*/
exports.csg = function(sceneIn, zincRendererIn) {

var datGui = undefined;
var scene = sceneIn;
var csgScene = zincRendererIn.createScene("csg");
Expand Down Expand Up @@ -124,7 +134,6 @@ exports.csg = function(sceneIn, zincRendererIn) {
}
}


var createCube = function(width, height, depth) {
var tempGeometry = new THREE.BoxGeometry(width, height, depth);
boxGeometry = scene.addZincGeometry(tempGeometry, 40001, 0xdddddd, 0.5, false, false, true);
Expand Down
6 changes: 6 additions & 0 deletions src/utilities/graphicsHighlight.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
var THREE = require('zincjs').THREE;

/**
* This module manages highlighted and selected objects in 3D modules.
*
* @class
* @returns {exports.GraphicsHighlight}
*/
exports.GraphicsHighlight = function() {
var currentHighlightedObjects = [];
var currentSelectedObjects = [];
Expand Down

0 comments on commit 18bd077

Please sign in to comment.