Merge pull request #890 from pandamicro/develop

[3.1 release] Add docs and update h5 engine

Author: dingpinglv

CHANGELOG

@@ -1,5 +1,47 @@
 ChangeLog:
 
+Cocos2d-JS v3.1 @ Oct.22, 2014
+
+* Released Facebook Integration for Cocos2d-JS v1.0, all APIs have been significantly polished and stabilized. Improved test cases for Facebook with more features demonstrated.
+* Upgraded Cocos2d-x to v3.3 rc0
+* Supported Cocos Studio v2.0 including Timeline animation support and proto buffers format support for both web engine and JSB engine.
+* Refactored load event of texture, sprite frame and sprite for better maintainability.
+* Refactored `cc.rendererCanvas` for improving performance.
+* Moved the `CC_Texture0` definition of fragment shader to cc.GLProgram to ensure compatibility with JSB.
+* Added normalized position functions to cc.Node.
+* Refactored the constructor of Cocos Studio's classes and deprecated all create functions.
+* Refactored Cocos Studio reader for better maintainability.
+* Improved Facebook SDK.
+* Modified `cc.ProgressTo`'s behavior, its progression didn't reset to zero when the progression is 100.
+* Changed `ccui.Widget`'s default anchor point to (0, 0) in widget reader.
+* Removed all deprecated create function usage in engine and in the test cases.
+* [JSB] Refactor `cc.GLNode` for new renderer and re-enable OpenGL test case.
+
+* Bug fixes:
+    1. Fixed an issue of `cc.UILayout` that its scissor mode didn't work.
+    2. Fixed an issue of `ccui.TextBMFont` that its 'string' property setting was incorrect.
+    3. Fixed an issue of `cc.DrawNode` that its element's position was incorrect in Canvas mode.
+    4. Fixed an issue of `cc.Layer` that its bake function didn't work in new renderer.
+    5. Fixed an issue of `cc.Scale9Sprite` that its cached canvas size was incorrect.
+    6. Fixed an issue of `cc.Director` that its position was incorrect when calling `setProjection` in new renderer.
+    7. Fixed an issue of `cc.view` that the reinitialization logic of frame size was incorrect.
+    8. Fixed incorrect usage of  `cc.progressTo` in progress action test.
+    9. Fixed an issue of CocosNodeTest for the new renderer.
+    10. Fixed minor issues in test cases.
+    11. [JSB] Fixed an issue of `cc.EditBox`'s constructor.
+    12. [JSB] Refactored an issue that `ccui.CheckBox`'s deprecated function `setSelectedState` is used instead of `setSelected`.
+    13. [JSB] Fixed an issue of `cc.ScrollView`'s constructor.
+    14. [JSB] Fixed an issue in Moon Warriors sample that a label's height was too small so it was cutting off its content.
+    15. [JSB] Fixed user object conflict in `ccui.Widget`'s `addTouchEventListener` function binding.
+    16. [JSB] Fixed an issue that null parameter was not correctly processed in `ccs.ArmatureAnimations`'s `setFrameEventCallFunc` and `setMovementEventCallFunc` functions.
+    17. [JSB] Fixed an issue that `cc.Scale9Sprite`'s `updateWithBatchNode` had been deprecated in JSB.
+    18. [JSB] Fixed an issue that `cc.SpriteBatchNode` could not be extended in JSB.
+    19. [JSB] Fixed an issue that Cocos Studio extension classes could not be extended in JSB.
+    20. [JSB] Fixed API inconsistency issues by renaming `cc.Node`'s `getRotationSkewX/Y` and `setRotationSkewX/Y` to `getRotationX/Y` and `setRotationX/Y`.
+
+* Known Issues:
+    1. `jsb.AssetsManager` doesn't work on windows due to a bug in libcurl
+
 Cocos2d-JS v3.1 beta @ Oct.13, 2014
 
 * Refactoration of the web engine with new renderer on the architecture level, optimization is under going.

build/cocos2d_jsb_samples.xcodeproj/project.pbxproj

@@ -1432,6 +1432,7 @@
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				USER_HEADER_SEARCH_PATHS = "$(inherited) $(SRCROOT)/../frameworks/js-bindings/cocos2d-x/cocos/platform/ios $(SRCROOT)/../frameworks/js-bindings/external/spidermonkey/include/ios";
+				VALID_ARCHS = "arm64 armv7";
 			};
 			name = Debug;
 		};
@@ -1460,6 +1461,7 @@
 				TARGETED_DEVICE_FAMILY = "1,2";
 				USER_HEADER_SEARCH_PATHS = "$(inherited) $(SRCROOT)/../frameworks/js-bindings/cocos2d-x/cocos/platform/ios $(SRCROOT)/../frameworks/js-bindings/external/spidermonkey/include/ios";
 				VALIDATE_PRODUCT = YES;
+				VALID_ARCHS = "arm64 armv7";
 			};
 			name = Release;
 		};
@@ -1493,6 +1495,7 @@
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				USER_HEADER_SEARCH_PATHS = "$(inherited) $(SRCROOT)/../frameworks/js-bindings/cocos2d-x/cocos/platform/ios $(SRCROOT)/../frameworks/js-bindings/external/spidermonkey/include/ios $(SRCROOT)/../frameworks/js-bindings/cocos2d-x/plugin/jsbindings/auto $(SRCROOT)/../frameworks/js-bindings/cocos2d-x/plugin/jsbindings/manual";
+				VALID_ARCHS = "arm64 armv7";
 			};
 			name = Debug;
 		};
@@ -1526,6 +1529,7 @@
 				TARGETED_DEVICE_FAMILY = "1,2";
 				USER_HEADER_SEARCH_PATHS = "$(inherited) $(SRCROOT)/../frameworks/js-bindings/cocos2d-x/cocos/platform/ios $(SRCROOT)/../frameworks/js-bindings/external/spidermonkey/include/ios $(SRCROOT)/../frameworks/js-bindings/cocos2d-x/plugin/jsbindings/auto $(SRCROOT)/../frameworks/js-bindings/cocos2d-x/plugin/jsbindings/manual";
 				VALIDATE_PRODUCT = YES;
+				VALID_ARCHS = "arm64 armv7";
 			};
 			name = Release;
 		};

docs/release-note-v3.1-beta.md renamed to docs/release-note-v3.1.md

@@ -1,12 +1,22 @@
-# Cocos2d-JS v3.1 Beta release note
+# Cocos2d-JS v3.1 release note
 
 <img src="http://www.cocos2d-x.org/attachments/download/1508" height=180> 
 
 Cocos2d-JS is Cocos2d-x engine's JavaScript version that includes Cocos2d-html5 and Cocos2d-x JavaScript Bindings. It equips your game with cross-browser and cross-platform abilities, accompanied by full Cocos2d-x features and simplified JavaScript friendly APIs.
 
 Cocos2d-JS reinvented workflows for all platforms in v3.x, it provides a consistent development experience for whichever platform you want to distribute to, no matter web and native. "Code once, run everywhere" is incredibly easy and natural in Cocos2d-JS. With one single JavaScript code base, you can run your game on all web browsers and native platforms including Mac OS, Windows, iOS and Android. This will bring your game great opportunities in almost all channels of distribution. On the other hand, if you are only interested in casual games on the web, you can embed directly in your web page the Cocos2d-JS Lite Version which is extremely easy to use and light as a feather.
 
-Furthermore, JavaScript friendly APIs make your game development experience a breeze - easy to code, test and distribute. In the meantime, Cocos2d-JS v3.x is super powerful along with all these cool new features: Editors Support, Assets Manager, Object Pool, JS to Objective-C/JAVA reflection, etc.
+In addition, Cocos2d-JS v3.x is super powerful along with all these cool new features: Editors Support, Assets Manager, Object Pool, JS to Objective-C/JAVA reflection, etc.
+
+One more thing, Facebook Integration for Cocos2d-JS have brought a huge opportunity for game developers who want to integrate Facebook functionality into their games. With a single code base, they can release fully cross-platform games across Facebook Canvas, iOS and Android.
+
+## Highlights
+
+* Released Facebook Integration for Cocos2d-JS v1.0, its APIs have been significantly polished and stablized. Improved test cases for Facebook with more features demonstrated. Refer to the [API reference document](http://cocos2d-x.org/docs/manual/framework/html5/facebook-sdk/api-reference/en) for more details.
+* Refactorization of the web engine with new renderer architecture, the new renderer has brought a great performance boost on Web engine.
+* Upgraded Cocos2d-x to v3.3rc0.
+* Supported Cocos Studio v2.0 including Timeline animation support and proto buffers format support for both web engine and JSB engine.
+* Automatically enabled WebGL on iOS 8 safari, the performance is incredibly enhanced compare to Canvas render mode.
 
 ## Workflows
 
@@ -16,24 +26,17 @@ Furthermore, JavaScript friendly APIs make your game development experience a br
 
 ![](workflows.jpg)
 
-## Highlights
-
-* Refactoration of the web engine with new renderer architecture, the new renderer has bring a great performance boost on Web engine, yet it hasn't been fully optimized. The next step is to focus on the optimization.
-* Released Facebook SDK for Cocos2d-JS Beta2, its API have been significantly improved and stablized. API reference document have been greatly improved also.
-* Upgraded MoonWarriors sample game with brand new graphical assets.
-* Automatically enabled WebGL on iOS 8 safari, the performance is incredibly enhanced compare to Canvas render mode.
-* Upgraded chipmunk to the newest version and improved bindings for chipmunk.
-
 ## Notice
 
 For JSB build, there are some restrictions :
 
 - [Android build] NDK version must be r9d
 - [iOS build] Xcode version must be 5.1.1 +
+- [Web code obfuscation] JRE or JDK version must be 1.6 or 1.7
 
 ## Download
 
-- [Cocos2d-JS v3.1 Beta](http://www.cocos2d-x.org/filedown/cocos2d-js-v3.1-beta.zip)
+- [Cocos2d-JS v3.1](http://www.cocos2d-x.org/filedown/cocos2d-js-v3.1.zip)
 - [Online API reference](http://www.cocos2d-x.org/reference/html5-js/V3.0/index.html)
 - [Downloadable API Reference](http://www.cocos2d-x.org/filedown/Cocos2d-JS-v3.0-API.zip)
 - [Online test cases](http://cocos2d-x.org/js-tests/)
@@ -42,14 +45,24 @@ For JSB build, there are some restrictions :
 
 Read more about all the features and bug fixes
 
-- [Cocos2d-JS v3.1 Beta changelog](http://www.cocos2d-x.org/docs/manual/framework/html5/release-notes/v3.1b/changelog/en)
+- [Cocos2d-JS v3.1 changelog](http://www.cocos2d-x.org/docs/manual/framework/html5/release-notes/v3.1/changelog/en)
 - [Cocos2d-JS v3.1 upgrade guide](http://www.cocos2d-x.org/docs/manual/framework/html5/release-notes/v3.0rc0/upgrade-guide/en)
 
+## Upgrade your project from previous versions
+
+If you want to upgrade your game based on v3.0 previous version to the 3.1 version, you should follow these steps:
+
+1. Download the Cocos2d-JS v3.1 package.
+2. Upgrade cocos command with `setup.py`.
+3. Create a new project with `cocos new` command.
+4. Replace the "src", "res", "index.html", "project.json", "main.js" etc with your old project.
+5. Then you may need to refer to the upgrade guide to solve some API change issues.
+
 ## About Cocos2d family
 
-- Cocos2d-JS v3.1 Beta uses Cocos2d-x 3.2 final as base of JSB solution
-- Cocos2d-JS v3.1 Beta is compatible with Cocos Code IDE v1.0.0 RC2+
-- Cocos2d-JS v3.1 Beta is compatible with Cocos Studio v1.2 - v1.5.0.1
+- Cocos2d-JS v3.1 uses Cocos2d-x v3.3rc0 as base of JSB solution
+- Cocos2d-JS v3.1 is compatible with Cocos Code IDE v1.0
+- Cocos2d-JS v3.1 is compatible with Cocos Studio v1.2 - v2.0
 
 With any problems you might have, our communities are happy to help:
 

frameworks/cocos2d-html5

@@ -37,7 +37,7 @@
 #include <assert.h>
 #include <memory>
 
-#define ENGINE_VERSION "Cocos2d-JS v3.1 Beta"
+#define ENGINE_VERSION "Cocos2d-JS v3.1"
 
 void js_log(const char *format, ...);
 

frameworks/js-bindings/bindings/manual/ScriptingCore.h

@@ -881,6 +881,7 @@
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				USER_HEADER_SEARCH_PATHS = "$(inherited) $(SRCROOT)/../../external/spidermonkey/include/ios $(SRCROOT)/../../cocos2d-x/cocos/platform/ios $(SRCROOT)/../../cocos2d-x/plugin/protocols/include";
+				VALID_ARCHS = "arm64 armv7";
 			};
 			name = Debug;
 		};
@@ -903,6 +904,7 @@
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				USER_HEADER_SEARCH_PATHS = "$(inherited) $(SRCROOT)/../../external/spidermonkey/include/ios $(SRCROOT)/../../cocos2d-x/cocos/platform/ios $(SRCROOT)/../../cocos2d-x/plugin/protocols/include";
+				VALID_ARCHS = "arm64 armv7";
 			};
 			name = Release;
 		};

frameworks/js-bindings/bindings/proj.ios_mac/cocos2d_js_bindings.xcodeproj/project.pbxproj

@@ -26,7 +26,7 @@
 
 // CCConfig.js
 //
-cc.ENGINE_VERSION = "Cocos2d-JS v3.1 Beta";
+cc.ENGINE_VERSION = "Cocos2d-JS v3.1";
 
 cc.FIX_ARTIFACTS_BY_STRECHING_TEXEL = 0;
 cc.DIRECTOR_STATS_POSITION = {x: 0, y: 0};

frameworks/js-bindings/bindings/script/jsb_cocos2d.js

@@ -45,6 +45,12 @@ var cocoStudioTestItemNames = [
         testScene:function () {
             runSceneEditorTest();
         }
+    },
+    {
+        itemTitle:"ParserTest",
+        testScene:function(){
+            runParserTest();
+        }
     }
 ];
 
@@ -55,12 +61,6 @@ if(!cc.sys.isNative){
             runComponentsTestLayer();
         }
     });
-    cocoStudioTestItemNames.push({
-        itemTitle:"ParserTest",
-        testScene:function(){
-            runParserTest();
-        }
-    });
     cocoStudioTestItemNames.push({
         itemTitle:"CustomWidget",
         testScene:function(){

frameworks/js-bindings/cocos2d-x

@@ -64,14 +64,14 @@ var CocostudioParserJsonLayer = cc.Layer.extend({
 
         var guiReader = ccs.uiReader;
 
-        guiReader.registerTypeAndCallBack("CustomImageView",
-            CustomImageView,
-            customImageViewReader,
-            customImageViewReader.setProperties);
-        guiReader.registerTypeAndCallBack("CustomParticleWidget",
-            CustomParticleWidget,
-            customParticleWidgetReader,
-            customParticleWidgetReader.setProperties);
+//        guiReader.registerTypeAndCallBack("CustomImageView",
+//            CustomImageView,
+//            customImageViewReader,
+//            customImageViewReader.setProperties);
+//        guiReader.registerTypeAndCallBack("CustomParticleWidget",
+//            CustomParticleWidget,
+//            customParticleWidgetReader,
+//            customParticleWidgetReader.setProperties);
 
         var layout = guiReader.widgetFromJsonFile(this._jsonFile);
         layout.setScale(0.7);

samples/js-tests/src/CocoStudioTest/CocoStudioTest.js

@@ -103,7 +103,7 @@ var extensionsTestItemNames = [
     }
 ];
 
-if (cc.sys.OS_IOS == cc.sys.os) {
+if (cc.sys.isNative && cc.sys.OS_IOS == cc.sys.os) {
     extensionsTestItemNames.push({
         itemTitle:"PluginTest",
         testScene:function () {

samples/js-tests/src/CocoStudioTest/ParserTest/ParserTest.js

@@ -892,6 +892,7 @@
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				USER_HEADER_SEARCH_PATHS = "$(inherited) $(SRCROOT)/../../js-bindings/cocos2d-x/cocos/platform/ios $(SRCROOT)/../../js-bindings/external/spidermonkey/include/ios $(SRCROOT)/../../js-bindings/cocos2d-x/plugin/jsbindings/auto $(SRCROOT)/../../js-bindings/cocos2d-x/plugin/jsbindings/manual";
+				VALID_ARCHS = "arm64 armv7";
 			};
 			name = Debug;
 		};
@@ -917,6 +918,7 @@
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				USER_HEADER_SEARCH_PATHS = "$(inherited) $(SRCROOT)/../../js-bindings/cocos2d-x/cocos/platform/ios $(SRCROOT)/../../js-bindings/external/spidermonkey/include/ios $(SRCROOT)/../../js-bindings/cocos2d-x/plugin/jsbindings/auto $(SRCROOT)/../../js-bindings/cocos2d-x/plugin/jsbindings/manual";
+				VALID_ARCHS = "arm64 armv7";
 			};
 			name = Release;
 		};

samples/js-tests/src/ExtensionsTest/ExtensionsTest.js

@@ -1177,6 +1177,7 @@
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				USER_HEADER_SEARCH_PATHS = "$(inherited) $(SRCROOT)/../../js-bindings/cocos2d-x/cocos $(SRCROOT)/../../js-bindings/cocos2d-x/cocos/platform/ios $(SRCROOT)/../../js-bindings/external/spidermonkey/include/ios $(SRCROOT)/../../js-bindings/cocos2d-x/plugin/jsbindings/auto $(SRCROOT)/../../js-bindings/cocos2d-x/plugin/jsbindings/manual";
+				VALID_ARCHS = "arm64 armv7";
 			};
 			name = Debug;
 		};
@@ -1202,6 +1203,7 @@
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				USER_HEADER_SEARCH_PATHS = "$(inherited) $(SRCROOT)/../../js-bindings/cocos2d-x/cocos $(SRCROOT)/../../js-bindings/cocos2d-x/cocos/platform/ios $(SRCROOT)/../../js-bindings/external/spidermonkey/include/ios $(SRCROOT)/../../js-bindings/cocos2d-x/plugin/jsbindings/auto $(SRCROOT)/../../js-bindings/cocos2d-x/plugin/jsbindings/manual";
+				VALID_ARCHS = "arm64 armv7";
 			};
 			name = Release;
 		};