Code comment convention cleanup
MODIFY
src/vtkjs/pointFeature.js
src/vtkjs/pointFeature.js
@@ -8,7 +8,6 @@ var vtkMapper = vtk.Rendering.Core.vtkGlyph3DMapper;
var vtkPointSet = vtk.Common.DataModel.vtkPointSet;
var vtkSphereSource = vtk.Filters.Sources.vtkSphereSource;
-//////////////////////////////////////////////////////////////////////////////
/**
* Create a new instance of pointFeature
*
@@ -16,7 +15,6 @@ var vtkSphereSource = vtk.Filters.Sources.vtkSphereSource;
* @extends geo.pointFeature
* @returns {geo.vtkjs.pointFeature}
*/
-//////////////////////////////////////////////////////////////////////////////
var vtkjs_pointFeature = function (arg) {
'use strict';
if (!(this instanceof vtkjs_pointFeature)) {
@@ -30,11 +28,11 @@ var vtkjs_pointFeature = function (arg) {
object.call(this);
- ////////////////////////////////////////////////////////////////////////////
/**
+ * Member variables
+ *
* @private
*/
- ////////////////////////////////////////////////////////////////////////////
var m_this = this,
s_exit = this._exit,
m_actor = null,
@@ -42,11 +40,9 @@ var vtkjs_pointFeature = function (arg) {
m_source = null,
s_update = this._update;
- ////////////////////////////////////////////////////////////////////////////
/**
* Create pipeline
*/
- ////////////////////////////////////////////////////////////////////////////
this._createPipeline = function () {
m_pointSet = vtkPointSet.newInstance();
m_source = vtkSphereSource.newInstance();
@@ -60,23 +56,17 @@ var vtkjs_pointFeature = function (arg) {
this.renderer().contextRenderer().addActor(m_actor);
};
- ////////////////////////////////////////////////////////////////////////////
/**
* Initialize
*/
- ////////////////////////////////////////////////////////////////////////////
this._init = function () {
m_this.renderer().contextRenderer().setLayer(1);
this._createPipeline();
};
- ////////////////////////////////////////////////////////////////////////////
/**
- * Build
- *
- * @override
+ * Build this feature
*/
- ////////////////////////////////////////////////////////////////////////////
this._build = function () {
var i, i3, posVal,
nonzeroZ,
@@ -121,13 +111,10 @@ var vtkjs_pointFeature = function (arg) {
console.debug('built vtkjs point feature');
};
- ////////////////////////////////////////////////////////////////////////////
/**
* Update
*
- * @override
*/
- ////////////////////////////////////////////////////////////////////////////
this._update = function () {
s_update.call(m_this);
@@ -140,11 +127,9 @@ var vtkjs_pointFeature = function (arg) {
m_this.updateTime().modified();
};
- ////////////////////////////////////////////////////////////////////////////
/**
* Destroy
*/
- ////////////////////////////////////////////////////////////////////////////
this._exit = function () {
m_this.renderer().contextRenderer().removeActor(m_actor);
s_exit();

MODIFY
src/vtkjs/vtkjsRenderer.js
src/vtkjs/vtkjsRenderer.js
@@ -4,7 +4,6 @@ var renderer = require('../renderer');
var vtk = require('vtk.js');
var vtkFullScreenRenderWindow = vtk.Rendering.Misc.vtkFullScreenRenderWindow;
-//////////////////////////////////////////////////////////////////////////////
/**
* Create a new instance of class vtkjsRenderer
*
@@ -13,7 +12,6 @@ var vtkFullScreenRenderWindow = vtk.Rendering.Misc.vtkFullScreenRenderWindow;
* @param canvas
* @returns {geo.gl.vtkjsRenderer}
*/
-//////////////////////////////////////////////////////////////////////////////
var vtkjsRenderer = function (arg) {
'use strict';
@@ -36,48 +34,37 @@ var vtkjsRenderer = function (arg) {
const vtkjsren = fullScreenRenderer.getRenderer();
const renderWindow = fullScreenRenderer.getRenderWindow();
- /// TODO: Move this API to the base class
- ////////////////////////////////////////////////////////////////////////////
/**
* Return width of the renderer
*/
- ////////////////////////////////////////////////////////////////////////////
this.width = function () {
return m_width;
};
- ////////////////////////////////////////////////////////////////////////////
/**
* Return height of the renderer
*/
- ////////////////////////////////////////////////////////////////////////////
this.height = function () {
return m_height;
};
- ////////////////////////////////////////////////////////////////////////////
/**
* Get context specific renderer
*/
- ////////////////////////////////////////////////////////////////////////////
this.contextRenderer = function () {
return vtkjsren;
};
- ////////////////////////////////////////////////////////////////////////////
/**
* Get API used by the renderer
*/
- ////////////////////////////////////////////////////////////////////////////
this.api = function () {
return 'vtkjs';
};
- ////////////////////////////////////////////////////////////////////////////
/**
* Initialize
*/
- ////////////////////////////////////////////////////////////////////////////
this._init = function () {
if (m_this.initialized()) {
return m_this;
@@ -92,22 +79,18 @@ var vtkjsRenderer = function (arg) {
return m_this;
};
- ////////////////////////////////////////////////////////////////////////////
/**
* Handle resize event
*/
- ////////////////////////////////////////////////////////////////////////////
this._resize = function (x, y, w, h) {
m_this._render();
return m_this;
};
- ////////////////////////////////////////////////////////////////////////////
/**
* Render. This actually schedules rendering for the next animation frame.
*/
- ////////////////////////////////////////////////////////////////////////////
this._render = function () {
/* If we are already scheduled to render, don't schedule again. Rather,
* mark that we should render after other animation frame requests occur.
@@ -127,11 +110,9 @@ var vtkjsRenderer = function (arg) {
renderWindow.render();
};
- ////////////////////////////////////////////////////////////////////////////
/**
* Exit
*/
- ////////////////////////////////////////////////////////////////////////////
this._exit = function () {
// DO NOTHING
};
@@ -149,13 +130,17 @@ var vtkjsRenderer = function (arg) {
m_this.contextRenderer().getActiveCamera().setProjectionMatrix(projmat);
};
- // Connect to pan event. This is sufficient, as all zooms and rotations also
- // produce a pan
+ /**
+ * Connect to pan event. This is sufficient, as all zooms and rotations also
+ *produce a pan
+ */
m_this.layer().geoOn(geo_event.pan, function (evt) {
// DO NOTHING
});
- // Connect to parallelprojection event
+ /**
+ * Connect to parallelprojection event
+ */
m_this.layer().geoOn(geo_event.parallelprojection, function (evt) {
// DO NOTHING
});

Code comment convention cleanup