-
-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
203 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Changelog | ||
|
|
||
| ## [1.1.0](https://github.com/mob-sakai/UnmaskForUGUI/tree/1.1.0) (2019-01-25) | ||
|
|
||
| [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/v1.0.0...1.1.0) | ||
|
|
||
| **Install UnmaskForUGUI with Unity Package Manager!** | ||
|
|
||
| Find the manifest.json file in the Packages folder of your project and edit it to look like this: | ||
| ```js | ||
| { | ||
| "dependencies": { | ||
| "com.coffee.unmask": "https://github.com/mob-sakai/UnmaskForUGUI.git#1.1.0", | ||
| ... | ||
| }, | ||
| } | ||
| ``` | ||
| To update the package, change `#1.1.0` to the target version. | ||
|
|
||
| **Implemented enhancements:** | ||
|
|
||
| - Unmask only for children option [\#11](https://github.com/mob-sakai/UnmaskForUGUI/issues/11) | ||
|
|
||
| ## [v1.0.0](https://github.com/mob-sakai/UnmaskForUGUI/tree/v1.0.0) (2018-10-18) | ||
|
|
||
| [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/v0.2.0...v1.0.0) | ||
|
|
||
| **Implemented enhancements:** | ||
|
|
||
| - Add `Fit On LateUpdate` option [\#10](https://github.com/mob-sakai/UnmaskForUGUI/issues/10) | ||
|
|
||
| ## [v0.2.0](https://github.com/mob-sakai/UnmaskForUGUI/tree/v0.2.0) (2018-10-16) | ||
|
|
||
| [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/v0.1.0...v0.2.0) | ||
|
|
||
| **Implemented enhancements:** | ||
|
|
||
| - Update demo & readme [\#9](https://github.com/mob-sakai/UnmaskForUGUI/issues/9) | ||
|
|
||
| ## [v0.1.0](https://github.com/mob-sakai/UnmaskForUGUI/tree/v0.1.0) (2018-10-14) | ||
|
|
||
| [Full Changelog](https://github.com/mob-sakai/UnmaskForUGUI/compare/987e437b26b83a78d6f54d6cc6778c3181e8e5dc...v0.1.0) | ||
|
|
||
| **Implemented enhancements:** | ||
|
|
||
| - Add demo [\#5](https://github.com/mob-sakai/UnmaskForUGUI/issues/5) | ||
| - Support nesting [\#4](https://github.com/mob-sakai/UnmaskForUGUI/issues/4) | ||
| - Following another object [\#3](https://github.com/mob-sakai/UnmaskForUGUI/issues/3) | ||
| - Ray through the unmasked rectangle [\#2](https://github.com/mob-sakai/UnmaskForUGUI/issues/2) | ||
| - Reverse mask [\#1](https://github.com/mob-sakai/UnmaskForUGUI/issues/1) | ||
|
|
||
|
|
||
|
|
||
| \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Copyright 2018 mob-sakai | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| UnmaskForUGUI | ||
| === | ||
|
|
||
| Reverse mask for uGUI element in Unity. | ||
|
|
||
|  | ||
|
|
||
| [](https://github.com/mob-sakai/UnmaskForUGUI/releases) | ||
| [](https://github.com/mob-sakai/UnmaskForUGUI/releases) | ||
|  | ||
| [](https://github.com/mob-sakai/UnmaskForUGUI/blob/upm/LICENSE.txt) | ||
| [](http://makeapullrequest.com) | ||
|
|
||
| << [Description](#Description) | [WebGL Demo](#demo) | [Download](https://github.com/mob-sakai/UnmaskForUGUI/releases) | [Install](#install) | [Usage](#usage) >> | ||
|
|
||
| ### What's new? [See changelog ](https://github.com/mob-sakai/UnmaskForUGUI/blob/upm/CHANGELOG.md) | ||
| ### Do you want to receive notifications for new releases? [Watch this repo ](https://github.com/mob-sakai/UnmaskForUGUI/subscription) | ||
|
|
||
|
|
||
|
|
||
| <br><br><br><br> | ||
| ## Description | ||
|
|
||
| Unmask provides the following features: | ||
| 1. Reverse mask | ||
| 2. Ray through the unmasked rectangle | ||
| 3. Following another object | ||
| 4. Support nesting | ||
|
|
||
| | Component | Features | Screenshot | | ||
| |-|-|-| | ||
| |**Unmask**|Reverse masking for parent Mask component.<br><br>**Fit Target / Fit On Late Update:** Fit graphic's transform to target transform on LateUpdate.<br>**Only For Children:** Unmask affects only for children.<br>**Show Unmask Graphic:** Show the graphic that is associated with the unmask render area.|<img src="https://user-images.githubusercontent.com/12690315/51745704-0e3e2a00-20e7-11e9-8da8-5abb1c5193bc.png" width="600px">| | ||
| |**UnmaskRaycastFilter**|The ray Passes through the unmasked rectangle.<br>You can click on the unmasked button on the back side.|<img src="https://user-images.githubusercontent.com/12690315/51745958-ebf8dc00-20e7-11e9-8cfc-8174e6ab2b7c.png" width="600px">| | ||
|
|
||
|
|
||
|
|
||
| <br><br><br><br> | ||
| ## Demo | ||
|
|
||
| [WebGL Demo](http://mob-sakai.github.io/UnmaskForUGUI) | ||
|
|
||
|  | ||
|
|
||
|
|
||
|
|
||
| <br><br><br><br> | ||
| ## Install | ||
|
|
||
| #### Using UnityPackageManager (for Unity 2018.3+) | ||
|
|
||
| Find the manifest.json file in the Packages folder of your project and edit it to look like this: | ||
| ```js | ||
| { | ||
| "dependencies": { | ||
| "com.coffee.unmask": "https://github.com/mob-sakai/UnmaskForUGUI.git#1.1.1", | ||
| ... | ||
| }, | ||
| } | ||
| ``` | ||
| To update the package, change `#{version}` to the target version. | ||
| Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension). | ||
|
|
||
| #### Using .unitypackage file (for Unity 5.5+) | ||
|
|
||
| Download `*.unitypackage` from [Releases](https://github.com/mob-sakai/UnmaskForUGUI/releases) and import the package into your Unity project. | ||
| Select `Assets > Import Package > Custom Package` from the menu. | ||
|  | ||
|
|
||
|
|
||
|
|
||
| <br><br><br><br> | ||
| ## Usage | ||
|
|
||
| 1. Add Unmask component to the UI element (Image, RawImage, Text, etc...) under Mask, from `Add Component` in inspector or `Component > UI > Unmask > Unmask` menu. | ||
| 2. If you want to unmask the area of the button, follow the steps below: | ||
| * Set the button to `Fit Target` in Unmask component. | ||
| * If the button moves with animation etc., enable `Fit On LateUpdate` in Unmask component. | ||
| * Add a UnmaskRaycastFilter component to UI element blocking ray. | ||
| * Set the Unmask to `Unmask` in UnmaskRaycastFilter component. | ||
| * Disable `RaycastTarget` of the UI elements, as necessary. | ||
|  | ||
| 3. Enjoy! | ||
|
|
||
|
|
||
| ##### Requirement | ||
|
|
||
| * Unity 5.5+ *(included Unity 2018.x)* | ||
| * No other SDK are required | ||
|
|
||
|
|
||
|
|
||
| <br><br><br><br> | ||
| ## Example of using | ||
|
|
||
| | Case | Description |Screenshot | | ||
| |-|-|-| | ||
| |Unmasked text|Black screen is cut out with unmasked text.|| | ||
| |Hole|Black screen is cut out with unmasked Image.|| | ||
| |Tutorial button|In tutorial, only specific button can be pressed.|| | ||
| |Transition|Transition effect with silhouette.|| | ||
|
|
||
|
|
||
|
|
||
| <br><br><br><br> | ||
| ## License | ||
|
|
||
| * MIT | ||
| * © UTJ/UCL | ||
|
|
||
|
|
||
|
|
||
| ## Author | ||
|
|
||
| [mob-sakai](https://github.com/mob-sakai) | ||
|
|
||
|
|
||
|
|
||
| ## See Also | ||
|
|
||
| * GitHub page : https://github.com/mob-sakai/UnmaskForUGUI | ||
| * Releases : https://github.com/mob-sakai/UnmaskForUGUI/releases | ||
| * Issue tracker : https://github.com/mob-sakai/UnmaskForUGUI/issues | ||
| * Current project : https://github.com/mob-sakai/UnmaskForUGUI/projects/1 | ||
| * Change log : https://github.com/mob-sakai/UnmaskForUGUI/blob/upm/CHANGELOG.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "name": "com.coffee.unmask", | ||
| "displayName": "Unmask for uGUI", | ||
| "description": "Reverse mask for uGUI element in Unity.", | ||
| "version": "1.1.0", | ||
| "unity": "5.5", | ||
| "license": "MIT", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/mob-sakai/UnmaskForUGUI.git" | ||
| }, | ||
| "src": "Assets/Coffee/UIExtensions/UnmaskForUGUI", | ||
| "author": "mob-sakai <sakai861104@gmail.com> (https://github.com/mob-sakai)", | ||
| "editorOnly": false, | ||
| "upmSupport": true, | ||
| "dependencies": { | ||
| } | ||
| } |