Cleanup

Remove unused files.
Clean up Array to not contaminate global Array class and to use consistent definitions.
Update readme with license badge.

Author: jabbany

README.md

@@ -2,7 +2,7 @@
 [![NPM version](https://badge.fury.io/js/comment-core-library.svg)](http://badge.fury.io/js/comment-core-library)
 [![Bower version](https://badge.fury.io/bo/comment-core-library.svg)](http://badge.fury.io/bo/comment-core-library)
 [![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)
-
+[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 
 The CommentCoreLibrary is a set of Javascript modules that make up the
 core controller for comments streaming on top of timed media (video or audio).
@@ -40,8 +40,8 @@ gem 'rails-assets-comment-core-library'
 ```
 
 ## Examples and Documentation
-- Documentation can be found inside the `docs/` folder.
-- Some sample extension modules may be found in `extend/`.
+- [Documentation](docs/) can be found inside the `docs/` folder.
+- Some sample extension modules may be found in `src/extend/`.
 - Experimental modules are in `experimental/`.
 - You may test using test data found in `tests/`.
 
@@ -73,8 +73,8 @@ implementation of a video player with CommentCoreLibrary.
     CommentCoreLibrary (//github.com/jabbany/CommentCoreLibrary) - Licensed under the MIT license
 
 ## 使用
-- 有关本项目的文档可以在 `docs/` 文件夹里面找到。
-- 一些功能性扩展模块会出现在 `extend/` 中。
+- 有关本项目的[文档](docs/) 可以在 `docs/` 文件夹里面找到。
+- 一些功能性扩展模块会出现在 `src/extend/` 中。
 - 一些实验性模块在 `experimental/` 里。
 - 测试数据在 `tests/` 里。
 

build/CommentCoreLibrary.js

@@ -3,8 +3,8 @@
  * @license MIT
  * @author Jim Chen
  */
-var BinArray = {};
-(function(BinArray){
+var BinArray = (function(){
+	var BinArray = {};
 	BinArray.bsearch = function(arr, what, how){
 		if(arr.length == 0) return 0;
 		if(how(what,arr[0]) < 0) return 0;
@@ -33,7 +33,8 @@ var BinArray = {};
 		arr.splice(index,0,what);
 		return index;
 	};
-})(BinArray);
+	return BinArray;
+})();
 
 var __extends = this.__extends || function (d, b) {
     for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p];
@@ -655,9 +656,11 @@ function CommentFilter(){
 }
 
 /*!
- * Comment Core For HTML5 VideoPlayers
+ * Comment Core Library CommentManager
+ * @license MIT
+ * @author Jim Chen
+ * 
  * Copyright (c) 2014 Jim Chen
- * License: MIT
  */
 var CommentManager = (function() {
 	var getRotMatrix = function(yrot, zrot) {
@@ -695,7 +698,8 @@ var CommentManager = (function() {
 			scroll:{
 				opacity:1,
 				scale:1
-			}
+			},
+			limit: 0
 		};
 		this.timeline = [];
 		this.runline = [];
@@ -826,9 +830,9 @@ var CommentManager = (function() {
 			this.lastPos = time;
 		}
 		for(;this.position < this.timeline.length;this.position++){
-			if(this.limiter > 0 && this.runline.length > this.limiter) break;
+			if(this.options.limit > 0 && this.runline.length > this.limiter) break;
 			if(this.validate(this.timeline[this.position]) && this.timeline[this.position]['stime']<=time){
-				this.sendComment(this.timeline[this.position]);
+				this.send(this.timeline[this.position]);
 			}else{
 				break;
 			}
@@ -837,7 +841,7 @@ var CommentManager = (function() {
 	CommentManager.prototype.rescale = function(){
 
 	};
-	CommentManager.prototype.sendComment = function(data){
+	CommentManager.prototype.send = function(data){
 		if(data.mode === 8){
 			console.log(data);
 			if(this.scripting){
@@ -886,8 +890,9 @@ var CommentManager = (function() {
 		this.dispatchEvent("enterComment", cmt);
 		this.runline.push(cmt);
 	};
-	CommentManager.prototype.send = function(data){
-		this.sendComment(data); // Wrapper for future apis
+	CommentManager.prototype.sendComment = function(data){
+		console.log("CommentManager.sendComment is deprecated. Please use send instead");
+		this.send(data); // Wrapper for Backwards Compatible APIs
 	};
 	CommentManager.prototype.finish = function(cmt){
 		this.dispatchEvent("exitComment", cmt);

build/CommentCoreLibrary.min.js

@@ -1,2 +1,7 @@
 # 弹幕管理器 CommentManager
 弹幕管理器自 `v1.0` 后将改成支持多种多层渲染的模式了，在此之前请先参考一些[不完整的API实现](CommentCoreLibraryAPI.md)。
+
+## Properties 属性
+
+### options <Object>
+此处用于放置弹幕默认参数等.

docs/CommentManager.md

@@ -11,37 +11,37 @@
 
 ## Properties 属性
 
-### LINEAR <Func> [静态]
+### LINEAR &lt;Func&gt; [静态]
 LINEAR 为线形拟合函数，提供用于默认补间动画的拟合。
 
-### mode <Num> = 1
+### mode &lt;Num&gt; = 1
 Danmaku Mode: mode 表示弹幕的类型，参考 [弹幕类型 (Comment Types)](CommentTypes.md)
 
-### stime <Num> = 0
+### stime &lt;Num&gt; = 0
 Start Time: stime 表示弹幕相对于视频位置的开始时间（ms），`0`即在视频开始立即出现
 
-### text <String>
+### text &lt;String&gt;
 Text: text 表示弹幕的文字内容。注意：在创造弹幕对象后，对 text 的更改将无意义。
 
-### ttl <Num> = 4000
+### ttl &lt;Num&gt; = 4000
 Time To Live: ttl 表示弹幕剩余的生存时间（ms）（注意：在css模式下该子段可能不准确）
 
-### dur <Num> = 4000
+### dur &lt;Num&gt; = 4000
 Duration: dur 表示弹幕的总生存时间（ms）。默认情况下，对于滚动弹幕这个数字是 4000。
 
-### cindex <Num> = -1
+### cindex &lt;Num&gt; = -1
 Pool Index: cindex 表示弹幕的弹幕池ID，用于在删除弹幕时寻找弹幕所在弹幕池。
 
-### motion <Array<IMotion>> = []
+### motion &lt;Array&lt;IMotion&gt;&gt; = []
 Motion Group: motion 控制一般弹幕（CoreComment）的运动轨迹，别的类型的弹幕可能忽略此属性（如
 滚动弹幕）
 
-### movable <Bool> = true
+### movable &lt;Bool&gt; = true
 Is Movable: 弹幕是否可以移动。此处为 `False` 时，弹幕的 time 函数将不会调用 update() 来移动
 弹幕。这样弹幕将无动画效果（不管 motion 或者 update 函数的实现）。但是更改 `x,y` 坐标还是可以
 重新定位弹幕的。
 
-### align <Num> = 0
+### align &lt;Num&gt; = 0
 Alignment: 对齐锚点（方形四角）。此数的高位表示上下，低位表示左右。
 
       Byte  |  Number  |  Alignment
@@ -57,35 +57,35 @@ Alignment: 对齐锚点（方形四角）。此数的高位表示上下，低位
 设定后x,y坐标的锚点将变成对应的方形角。不过，在右和下的对齐时，读取 x,y 坐标不一定准确，而且因为
 效率低所以不推荐。比如 top right 模式下，读 x 坐标效率比较低，但是读 y 就要好很多。
 
-### absolute <Bool> =  true
+### absolute &lt;Bool&gt; =  true
 Absolute Coordinates: 是否使用绝对坐标。当 `absolute === false` 时，x,y坐标将会表示相对
 于整个弹幕管理器的比例，如 `x=0.5` 在 `640 x 480` 的管理器上则会显示在 `320` 位置。
 
 注意：width, height 总会以绝对坐标返回，所以如果需要叠加则必须手动转换到相对坐标。
 
-### width/height/bottom/right <Num>
+### width/height/bottom/right &lt;Num&gt;
 Bounding Box: 定义弹幕的宽高和下部右部位置，前两个定义了 top left 顶点，后两个定义了bottom 
 right顶点。
 
-### size <Num> = 25
+### size &lt;Num&gt; = 25
 Font Size: 弹幕的文字大小，请参考 [弹幕大小 Comment Sizes](CommentSizes.md)。更改会更新视图。
 
-### color <Num> = 0xffffff
+### color &lt;Num&gt; = 0xffffff
 Text Color: 文字颜色，为数字表示，RGB依次由高位到低位：`0xRRGGBB`。更改会更新视图。
 
-### border <Bool> = false
+### border &lt;Bool&gt; = false
 Display Border: 是否显示边框。用于标注新弹幕。更改会同步更新视图。
 
-### shadow <Bool> = true
+### shadow &lt;Bool&gt; = true
 Display Shadow: 是否显示弹幕描边/阴影（注意：具体用哪个描边效果需要CSS控制）。更改会同步更新视图。
 
-### font <String> = ""
+### font &lt;String&gt; = ""
 Font Family: 弹幕字体。当设置为空字符串时，使用默认字体。更改会同步更新视图。
 
-### parent <CommentManager>
+### parent &lt;CommentManager&gt;
 Parent: 此弹幕归属的上层管理器
 
-### dom <HTMLDivElement/Canvas/etc.>
+### dom &lt;HTMLDivElement/Canvas/etc.&gt;
 DOM Correspondance: 对应的渲染元素，根据不同情况是不一样的。默认是 DIV 元素。
 
 ## Methods 方法

docs/CommentObject.md

@@ -3,8 +3,8 @@
  * @license MIT
  * @author Jim Chen
  */
-var BinArray = {};
-(function(BinArray){
+var BinArray = (function(){
+	var BinArray = {};
 	BinArray.bsearch = function(arr, what, how){
 		if(arr.length == 0) return 0;
 		if(how(what,arr[0]) < 0) return 0;
@@ -33,4 +33,5 @@ var BinArray = {};
 		arr.splice(index,0,what);
 		return index;
 	};
-})(BinArray);
+	return BinArray;
+})();

src/Array.js

@@ -1,7 +1,9 @@
 /*!
- * Comment Core For HTML5 VideoPlayers
+ * Comment Core Library CommentManager
+ * @license MIT
+ * @author Jim Chen
+ * 
  * Copyright (c) 2014 Jim Chen
- * License: MIT
  */
 var CommentManager = (function() {
 	var getRotMatrix = function(yrot, zrot) {
@@ -39,7 +41,8 @@ var CommentManager = (function() {
 			scroll:{
 				opacity:1,
 				scale:1
-			}
+			},
+			limit: 0
 		};
 		this.timeline = [];
 		this.runline = [];
@@ -170,9 +173,9 @@ var CommentManager = (function() {
 			this.lastPos = time;
 		}
 		for(;this.position < this.timeline.length;this.position++){
-			if(this.limiter > 0 && this.runline.length > this.limiter) break;
+			if(this.options.limit > 0 && this.runline.length > this.limiter) break;
 			if(this.validate(this.timeline[this.position]) && this.timeline[this.position]['stime']<=time){
-				this.sendComment(this.timeline[this.position]);
+				this.send(this.timeline[this.position]);
 			}else{
 				break;
 			}
@@ -181,7 +184,7 @@ var CommentManager = (function() {
 	CommentManager.prototype.rescale = function(){
 
 	};
-	CommentManager.prototype.sendComment = function(data){
+	CommentManager.prototype.send = function(data){
 		if(data.mode === 8){
 			console.log(data);
 			if(this.scripting){
@@ -230,8 +233,9 @@ var CommentManager = (function() {
 		this.dispatchEvent("enterComment", cmt);
 		this.runline.push(cmt);
 	};
-	CommentManager.prototype.send = function(data){
-		this.sendComment(data); // Wrapper for future apis
+	CommentManager.prototype.sendComment = function(data){
+		console.log("CommentManager.sendComment is deprecated. Please use send instead");
+		this.send(data); // Wrapper for Backwards Compatible APIs
 	};
 	CommentManager.prototype.finish = function(cmt){
 		this.dispatchEvent("exitComment", cmt);