Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs #1335

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Docs #1335

wants to merge 7 commits into from

Conversation

anatawa12
Copy link
Owner

@anatawa12 anatawa12 commented Nov 7, 2024

Fix #1321
Fix #1207
Fix #1229
Fix #1321
Fix #1337
Fix #1297
Fix #1144

@anatawa12 anatawa12 added the documentation Improvements or additions to documentation label Nov 7, 2024
@anatawa12 anatawa12 marked this pull request as ready for review November 7, 2024 11:08
@anatawa12
Copy link
Owner Author

#1337 もやる

@anatawa12 anatawa12 marked this pull request as draft November 8, 2024 05:19
@anatawa12 anatawa12 marked this pull request as ready for review November 8, 2024 06:11
.docs/content/docs/reference/trace-and-optimize/index.md Outdated Show resolved Hide resolved
@@ -19,6 +19,12 @@ Component APIが利用可能なコンポーネントの一覧は以下の通り
将来のバージョンで追加されるデフォルトで有効な機能との互換性を保つために、コンポーネントの設定変更を行う場合には注意が必要です。
詳細については以下のドキュメントを参照してください。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

詳細については~を追加する文章より下にした方が良い説?

文章側も後で変えるかも

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

詳細については〜の中に移動したほうがいいかもな。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

あー、そもそもここじゃなくて下の方にってこと?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

その方向性で調整する方が良いかも

Comment on lines 19 to +26
将来のバージョンで追加されるデフォルトで有効な機能との互換性を保つために、コンポーネントの設定変更を行う場合には注意が必要です。
詳細については以下のドキュメントを参照してください。

コンポーネントの設定は、コンポーネントを追加した直後にのみサポートされます。
すでにGameObjectに追加されているコンポーネントの設定はサポートされていません。
これは、将来の機能が既存のコンポーネントの設定と互換性がない可能性があるためです。

実際、1.8.0で追加されたRemove Mesh in Box invertオプションは、boxの意味を変更するため、1.7以前のみを想定したツールとは互換性がありません。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
将来のバージョンで追加されるデフォルトで有効な機能との互換性を保つために、コンポーネントの設定変更を行う場合には注意が必要です。
詳細については以下のドキュメントを参照してください。
コンポーネントの設定は、コンポーネントを追加した直後にのみサポートされます。
すでにGameObjectに追加されているコンポーネントの設定はサポートされていません。
これは、将来の機能が既存のコンポーネントの設定と互換性がない可能性があるためです。
実際、1.8.0で追加されたRemove Mesh in Box invertオプションは、boxの意味を変更するため、1.7以前のみを想定したツールとは互換性がありません。
コンポーネントの設定変更はコンポーネントを追加した直後に行う場合のみサポートされており、既にGameObject上に存在しているコンポーネントに対する設定変更はサポートされていません。
これは、将来のバージョンで追加された機能が、既存のコンポーネントの設定内容と互換性がない可能性があるためです。
例えば、v1.8.0で追加された`AAO Remove Mesh in Box`コンポーネントの反転オプションを変更すると、設定される箱による効果が変わってしまうため、v1.7以前のみを想定して作成されているツールと互換性がなくなってしまいます。
将来のバージョンで追加されるデフォルトで有効な機能との互換性を保つためにも、コンポーネントの設定変更を行う際はご注意ください。
その他の詳細については以下のドキュメントを参照してください。

なんか迷走してきた

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

将来のデフォルトでオンとの互換性はInitializeの債務なのでここに書くのは違うと思う

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ふむふむ

@anatawa12
Copy link
Owner Author

レビュー途中だけど #1144 追加します

In previous version, I don't stated NDMF Pass since it's a special version of `IVRCSDKPreprocessAvatarCallback` but Sayamame told me it's not explict enough so I did.
@@ -28,7 +28,7 @@ Avatar Optimizer v1.6.0で[コンポーネントにAAOとの互換性をもた
非破壊ツールでなく、ビルド時に処理を行わないようなツールでは、`IVRCSDKPreprocessAvatarCallback`でコンポーネントを削除するのは少し面倒だろうと考えました。\
そのため、Avatar Optimizerに無視してほしい、ビルド時やランタイムで処理を行わないコンポーネントを指定するためのシンプルな仕組みとして、Asset Descriptionがv1.7.0で追加されました。

なお、非破壊ツールの場合については、正しくない実行順で処理が行われた場合に、Avatar Optimizerがコンポーネントを誤って削除してしまわないように、従来通り`IVRCSDKPreprocessAvatarCallback`でコンポーネントを削除することを推奨します
なお、非破壊ツールの場合については、正しくない実行順で処理が行われた場合に、Avatar Optimizerがコンポーネントを誤って削除してしまわないように、従来通り`IVRCSDKPreprocessAvatarCallback`やNDMFの実行パスでコンポーネントを削除することを推奨します
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
なお、非破壊ツールの場合については、正しくない実行順で処理が行われた場合に、Avatar Optimizerがコンポーネントを誤って削除してしまわないように、従来通り`IVRCSDKPreprocessAvatarCallback`やNDMFの実行パスでコンポーネントを削除することを推奨します
なお、非破壊ツールの場合については、正しくない実行順で処理が行われた場合にAvatar Optimizerがコンポーネントを誤って削除してしまわないように、従来通り`IVRCSDKPreprocessAvatarCallback`やNDMFを使用してAvatar Optimizerの処理よりも先にコンポーネントを削除することを推奨します

こう?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NDMFを使用するでいいか。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants