update documents for v2.2.0

mob-sakai · Feb 23, 2019 · 4c26006 · 4c26006
1 parent fb29041
commit 4c26006
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,12 +1,21 @@
 # Changelog
 
-## [v2.1.1](https://github.com/mob-sakai/ParticleEffectForUGUI/tree/v2.1.1) (2019-02-15)
+## [v2.2.0](https://github.com/mob-sakai/ParticleEffectForUGUI/tree/v2.2.0) (2019-02-23)
 
-[Full Changelog](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v2.1.0...v2.1.1)
+[Full Changelog](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v2.1.1...v2.2.0)
+
+**Implemented enhancements:**
+
+- Display warning when material does not support Mask [\#43](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/43)
+- Support changing material property by AnimationClip [\#42](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/42)
 
 **Fixed bugs:**
 
-- UIParticle.Scale - Rendering Order Issue [\#39](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/39)
+- UV Animation is not work. [\#41](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/41)
+
+## [v2.1.1](https://github.com/mob-sakai/ParticleEffectForUGUI/tree/v2.1.1) (2019-02-15)
+
+[Full Changelog](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v2.1.0...v2.1.1)
 
 ## [v2.1.0](https://github.com/mob-sakai/ParticleEffectForUGUI/tree/v2.1.0) (2019-02-07)
 

diff --git a/README.md b/README.md
@@ -55,6 +55,8 @@ Compares this "Baking mesh" approach with the conventional approach:
 ![](https://user-images.githubusercontent.com/12690315/49866926-6c22f500-fe4c-11e8-8393-d5a546e9e2d3.gif)
 * Scaled gizmo  
 ![](https://user-images.githubusercontent.com/12690315/50343861-f31e4e80-056b-11e9-8f60-8bd0a8ff7adb.gif)
+* Animatable material property  
+![](https://user-images.githubusercontent.com/12690315/53286323-2d94a980-37b0-11e9-8afb-c4a207805ff2.gif)
 
 
 
@@ -74,12 +76,13 @@ Find the manifest.json file in the Packages folder of your project and edit it t
 ```js
 {
   "dependencies": {
-    "com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git#2.1.0",
+    "com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git#2.2.0",
     ...
   },
 }
 ```
-To update the package, change `#{version}` to the target version.
+To update the package, change `#{version}` to the target version.  
+Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension).
 
 #### Using .unitypackage file (for Unity 2018.2+)
 
@@ -124,6 +127,21 @@ Select `Assets > Import Package > Custom Package` from the menu.
 <br><br><br><br>
 ## Development Note
 
+#### Animatable material property
+
+![](https://user-images.githubusercontent.com/12690315/53286323-2d94a980-37b0-11e9-8afb-c4a207805ff2.gif)
+
+Animation clips can change the material properties of the Renderer, such as ParticleSystemRenderer.  
+It uses MaterialPropertyBlock so it does not create new material instances.  
+Using material properties, you can change UV animation, scale and color etc.
+
+Well, there is a component called CanvasRenderer.  
+It is used by all Graphic components for UI (Text, Image, Raw Image, etc.) including UIParticle.  
+However, It is **NOT** a Renderer.  
+Therefore, in UIParticle, changing ParticleSystemRenderer's MaterialPropertyBlock by animation clip is ignored.
+
+To prevent this, Use "Animatable Material Property".  
+"Animatable Material Property" gets the necessary properties from ParticleSystemRenderer's MaterialPropertyBlock and sets them to the CanvasRenderer's material. 
 
 
 

diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "com.coffee.ui-particle",
 	"displayName": "UI Particle",
 	"description": "This plugin provide a component to render particle effect for uGUI.\nThe particle rendering is maskable and sortable, without Camera, RenderTexture or Canvas.",
-  "version": "2.1.1",
+  "version": "2.2.0",
 	"unity": "2018.2",
   "license": "MIT",
   "repository": {