Merge pull request #2 from Live2D/develop

Cubism 4 SDK for Java R1 beta1

Author: wada-at-live2d-com

CHANGELOG.md

@@ -4,8 +4,32 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [4-r.1-alpha.1] - 2022-10-06
+## [4-r.1-beta.1] - 2022-12-08
+
+### Added
+
+* Add support for high-precision masks.
+* Implement to throw an exception when a user attempt to give null value to a setter method.
+* Add API to allow users to configure culling.
+* The number of render textures used can now be increased arbitrarily.
+  * The maximum number of masks when using multiple render textures has been increased to "number of render textures * 32".
+
+### Changed
+
+* Change the visibility of field variables in CubismClippingContext class from private to public and remove the getter and setter methods.
+* Change the specification of the logging functions in `CubismDebug` so that they can take a format string as an argument.
+
+### Fixed
+
+* Change `radianToDirection` function in `CubismMath` so that an instance of CubismVector2 created by an API user is given as second argument, and the calculation result is stored in that instance and returned.
+* Change the type of cache variables for vertex information used in `doDrawModel` function in `CubismRendererAndroid` and `setupClippingContext` function in `CubismClippingManagerAndroid` from `Map` to array.
+  * The cost of converting `int` type to `Integer` type (auto-boxing) that was incurred every frame was removed by this change.
+* Fix `updateParticles` and `updateParticlesForStabilization` function in `CubismPhysics` not to create an instance of CubismVector2.
+
+## 4-r.1-alpha.1 - 2022-10-06
 
 ### Added
 
 * New released!
+
+[4-r.1-beta.1]: https://github.com/Live2D/CubismJavaFramework/compare/4-r.1-alpha.1...4-r.1-beta.1

README.ja.md

@@ -8,8 +8,6 @@ Live2D Cubism 4 Editor で出力したモデルをアプリケーションで利
 
 モデルを表示、操作するための各種機能を提供します。モデルをロードするにはCubism Coreライブラリと組み合わせて使用します。
 
-このリポジトリは**alpha版**となっています。バグ報告やご提案がありましたら、GitHubの機能で[issue](https://github.com/Live2D/CubismJavaFramework/issues)を立てて弊社までお寄せください。
-
 ## 対応Javaバージョン
 
 このFrameworkは**Java SE 6**以上でコンパイルが可能です。
@@ -62,7 +60,7 @@ JSON パーサーやログ出力などのユーティリティ機能を提供し
 
 当リポジトリには Live2D Cubism Core for Java は同梱されていません。
 
-ダウンロードするには[こちら](https://creatorsforum.live2d.com/t/topic/1110)のページを参照ください。
+ダウンロードするには[こちら](https://www.live2d.com/download/cubism-sdk/download-java/)のページを参照ください。
 
 ## サンプル
 
@@ -78,6 +76,22 @@ JSON パーサーやログ出力などのユーティリティ機能を提供し
 
 当リポジトリの変更履歴については [CHANGELOG.md](CHANGELOG.md) を参照ください。
 
+## プロジェクトへの貢献
+
+プロジェクトに貢献する方法はたくさんあります。バグのログの記録、このGitHubでのプルリクエストの送信、Live2Dコミュニティでの問題の報告と提案の作成です。
+
+### フォークとプルリクエスト
+
+修正、改善、さらには新機能をもたらすかどうかにかかわらず、プルリクエストに感謝します。ただし、ラッパーは可能な限り軽量で浅くなるように設計されているため、バグ修正とメモリ/パフォーマンスの改善のみを行う必要があることに注意してください。メインリポジトリを可能な限りクリーンに保つために、必要に応じて個人用フォークと機能ブランチを作成してください。
+
+### バグ
+
+Live2Dコミュニティでは、問題のレポートと機能リクエストを定期的にチェックしています。バグレポートを提出する前に、Live2Dコミュニティで検索して、問題のレポートまたは機能リクエストがすでに投稿されているかどうかを確認してください。問題がすでに存在する場合は、関連するコメントを追記してください。
+
+### 提案
+
+SDKの将来についてのフィードバックにも関心があります。Live2Dコミュニティで提案や機能のリクエストを送信できます。このプロセスをより効果的にするために、それらをより明確に定義するのに役立つより多くの情報を含めるようお願いしています。
+
 ## コミュニティ
 
 ユーザー同士でCubism SDKの活用方法の提案や質問をしたい場合は、是非コミュニティをご活用ください。

README.md

@@ -8,8 +8,6 @@ This is a framework for using models output by Live2D Cubism 4 Editor in applica
 
 It provides various functions for displaying and manipulating the model. It is used in conjunction with the Cubism Core library to load the model.
 
-This repository is an **alpha version**. If you have any bug reports or suggestions, please send them to us by creating an [issue](https://github.com/Live2D/CubismJavaSamples/issues) using the GitHub feature.
-
 ## Supported Java Versions
 
 This framework can be compiled with **Java SE 6** or higher.
@@ -62,7 +60,7 @@ Provides utility functions such as JSON parser and log output.
 
 Live2D Cubism Core for Java is not included in this repository.
 
-To download, please refer to [this](https://community.live2d.com/discussion/1480/download-cubism-sdk-for-java-alpha/) page.
+To download, please refer to [this](https://www.live2d.com/download/cubism-sdk/download-java/) page.
 
 ## Samples
 
@@ -78,11 +76,25 @@ Please refer to the following sample repository for implementation examples of s
 
 Please refer to [CHANGELOG.md](CHANGELOG.md) for the changelog of this repository.
 
+## Contributing
+
+There are many ways to contribute to the project: logging bugs, submitting pull requests on this GitHub, and reporting issues and making suggestions in Live2D Community.
+
+### Forking And Pull Requests
+
+We very much appreciate your pull requests, whether they bring fixes, improvements, or even new features. Note, however, that the wrapper is designed to be as lightweight and shallow as possible and should therefore only be subject to bug fixes and memory/performance improvements. To keep the main repository as clean as possible, create a personal fork and feature branches there as needed.
+
+### Bugs
+
+We are regularly checking issue-reports and feature requests at Live2D Community. Before filing a bug report, please do a search in Live2D Community to see if the issue-report or feature request has already been posted. If you find your issue already exists, make relevant comments and add your reaction.
+
+### Suggestions
+
+We're also interested in your feedback for the future of the SDK. You can submit a suggestion or feature request at Live2D Community. To make this process more effective, we're asking that you include more information to help define them more clearly.
+
 ## Community
 
 If you want to suggest or ask questions about how to use the Cubism SDK between users, please use the community.
 
 - [Live2D community](https://community.live2d.com/)
 - [Live2D 公式コミュニティ (Japanese)](https://creatorsforum.live2d.com/)
-
-

framework/src/main/java/com/live2d/sdk/cubism/framework/CubismCdiJson.java

@@ -171,8 +171,6 @@ private CubismCdiJson(CubismJson json) {
      * @return If true, the key exists
      */
     private boolean existsParameters() {
-//        ACubismJsonValue node = json.getRoot().get(JsonKey.PARAMETERS.key);
-//        return node != null;
         ACubismJsonValue node = json.getRoot().get(JsonKey.PARAMETERS.key);
         return !node.isNull() && !node.isError();
     }
@@ -184,7 +182,6 @@ private boolean existsParameters() {
      */
     private boolean existsParameterGroups() {
         ACubismJsonValue node = json.getRoot().get(JsonKey.PARAMETER_GROUPS.key);
-//        return node != null;
         return !node.isNull() && !node.isError();
     }
 
@@ -195,7 +192,6 @@ private boolean existsParameterGroups() {
      */
     private boolean existsParts() {
         ACubismJsonValue node = json.getRoot().get(JsonKey.PARTS.key);
-//        return node != null;
         return !node.isNull() && !node.isError();
     }
 

framework/src/main/java/com/live2d/sdk/cubism/framework/CubismFramework.java

@@ -75,6 +75,9 @@ public int getId() {
          * @param logger log output function
          */
         public void setLogFunction(ICubismLogger logger) {
+            if (logger == null) {
+                throw new IllegalArgumentException("logger is null.");
+            }
             logFunction = logger;
         }
 

framework/src/main/java/com/live2d/sdk/cubism/framework/CubismModelSettingJson.java

@@ -7,7 +7,6 @@
 
 package com.live2d.sdk.cubism.framework;
 
-import com.live2d.sdk.cubism.framework.exception.CubismJsonParseException;
 import com.live2d.sdk.cubism.framework.id.CubismId;
 import com.live2d.sdk.cubism.framework.utils.jsonparser.ACubismJsonValue;
 import com.live2d.sdk.cubism.framework.utils.jsonparser.CubismJson;
@@ -22,7 +21,7 @@
  * This class deals with model3.json data.
  */
 public class CubismModelSettingJson implements ICubismModelSetting {
-    public CubismModelSettingJson(byte[] buffer) throws CubismJsonParseException {
+    public CubismModelSettingJson(byte[] buffer) {
         CubismJson json;
         json = CubismJson.create(buffer);
 

framework/src/main/java/com/live2d/sdk/cubism/framework/effect/CubismBreath.java

@@ -118,29 +118,17 @@ public void updateParameters(CubismModel model, float deltaTimeSeconds) {
      * Bind parameters of breath.
      *
      * @param breathParameters A parameters list bound breath
+     * @throws IllegalArgumentException if an argument is null
      */
     public void setParameters(List<BreathParameterData> breathParameters) {
+        if (breathParameters == null) {
+            throw new IllegalArgumentException("breathParameters is null.");
+        }
+
         this.breathParameters = breathParameters;
         areBreathParametersChanged = true;
     }
 
-    /**
-     * Get the parameter bound breath at the specified index.
-     * <p>
-     * This method returns the copy of the breath parameter.
-     * </p>
-     *
-     * @param index parameter index
-     * @return BreathParameterData instance(Optional type)
-     */
-    public BreathParameterData getParameter(int index) {
-        if (index < 0 || index >= breathParameters.size()) {
-            return null;
-        }
-//        return new BreathParameterData(_breathParameters.get(index));
-        return breathParameters.get(index);
-    }
-
     /**
      * Returns the parameters bound breath.
      * <p>

framework/src/main/java/com/live2d/sdk/cubism/framework/effect/CubismEyeBlink.java

@@ -120,24 +120,13 @@ public void setBlinkingSettings(float closing, float closed, float opening) {
      * Set a parameter IDs list to blink.
      *
      * @param parameterIds A parameter IDs list
+     * @throws IllegalArgumentException if an argument is null
      */
     public void setParameterIds(List<CubismId> parameterIds) {
-        this.parameterIds = parameterIds;
-    }
-
-    /**
-     * Get the parameter ID to eye-blink.
-     * <p>If the ID does not exist at the specified index, or if the parameter list is empty, then empty instance of Optional is returned.
-     *
-     * @param index index of the parameter ID
-     * @return CubismId instance(Optional type)
-     */
-    public CubismId getParameterId(int index) {
-        if (index < 0 || index >= parameterIds.size()) {
-            return null;
+        if (parameterIds == null) {
+            throw new IllegalArgumentException("parameterIds is null.");
         }
-
-        return parameterIds.get(index);
+        this.parameterIds = parameterIds;
     }
 
     /**

framework/src/main/java/com/live2d/sdk/cubism/framework/effect/CubismPose.java

@@ -113,7 +113,6 @@ public static CubismPose create(byte[] pose3json) {
         return pose;
     }
 
-
     /**
      * Update model's parameters.
      *
@@ -393,5 +392,4 @@ private enum JsonTag {
      * Previous operated model
      */
     private CubismModel lastModel;
-
 }

framework/src/main/java/com/live2d/sdk/cubism/framework/id/CubismId.java

@@ -15,8 +15,12 @@ public class CubismId {
      * Consturctor
      *
      * @param id A ID name
+     * @throws IllegalArgumentException if an argument is null
      */
     public CubismId(String id) {
+        if (id == null) {
+            throw new IllegalArgumentException("id is null.");
+        }
         this.id = id;
     }