質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.91%

UnityEngineライブラリクラスのプライベートフィールド名を確認してGatherPropertiesで保護したい

解決済

回答 2

投稿

  • 評価
  • クリップ 0
  • VIEW 226

yuraoka

score 2

GatherProperties機能の確認

UnityのタイムライントラックにはGatherPropertiesという仮想メソッドがあり、
これをオーバーライドしてタイムラインプレビュー中に変更した値を元に戻すのが一般的かと思います。
公式ドキュメント

コンポーネントのフィールドの保護

コンポーネントのプロパティに対しては以下のメソッドで値を保護することができています。

// driverはIPropertyCollectorインターフェースを実装したオブジェクトです。
driver.AddFromName <コンポーネントの型>(対象のゲームオブジェクト, シリアライズフィールド名);

ゲームオブジェクトのフィールドの保護

同様にゲームオブジェクトのフィールド、特にActiveSelfプロパティのフィールドを保護しようとしたのですが、うまくいきませんでした。

driver.AddFromName( 対象のゲームオブジェクト, "m_ActiveSelf");

エラーメッセージ

DrivenPropertyManager has failed to register property "m_ActiveSelf" of object "TsetObject"
with driver "" because the property doesn't exist.

課題1:ライブラリクラスのプライベートフィールド名を調べたい

今ある課題としては、フィールド名がm_ActiveSelfで合っている保証がありません。UnityEngineライブラリクラスのプライベートフィールドなので確認する方法がないためです。
試しに以下のようにリフレクションで取得しようとしてもうまくいきませんでした。

var fieldNames = typeof(GameObject).GetFields(System.Reflection.BindingFlags.NonPublic).Select(field => field.Name).ToArray();
Debug.Log(fieldNames.Length); // 0


例えばトランスフォームであればm_LocalPositionというフィールドがありますが、このようなプライベートフィールド名を知る一般的な方法はどのようなものなのでしょうか。

課題2:ゲームオブジェクトのフィールドを保護したい

ライブラリクラスのプライベートフィールドの確認方法を理解した上で上記と同じ

driver.AddFromName( 対象のゲームオブジェクト, シリアライズフィールド名);


でゲームオブジェクトのActive状態を保護できるのか試したいと考えています。
もしできなければ、ゲームオブジェクトはコンポーネントとは違って特殊なのか、それともActiveプロパティが特殊なのか切り分けて行きたいと考えています。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

+1

bboydaisukeさんのおっしゃる通り、Unityユーザーが自由に使えるようにpublicとして公開している、マニュアルやリファレンスでちゃんと解説されている機能だけを使って何とかするのが王道かと思います。裏技の範疇に足を突っ込むのであれば、たとえばバージョンアップで予告なしに動かなくなっても文句は言えない...みたいなリスクも覚悟する必要があるでしょう。

アセンブリをデコンパイルしてみるほかにも、GitHub - Unity-Technologies/UnityCsReference: Unity C# reference source codeを読んでみても発見があるかもしれません(参考情報として公開されているだけのようで、いわゆる「オープンソース」というわけではないみたいですからご注意ください)。
たとえばUnityCsReference/GameObject.bindings.cs at master · Unity-Technologies/UnityCsReference · GitHubには、見慣れたメソッドやらプロパティやらが並んでいるのを見て取れるかと思います。
中ほどには...

        public extern bool activeSelf
        {
            [NativeMethod(Name = "IsSelfActive")]
            get;
        }

なんて記述があり、アクティブかどうかはC#上のフィールドとしてではなく、ネイティブコード側で管理しているみたいですね。

とはいえ、シーン上にゲームオブジェクトを配置してアクティブ状態を切り替えて保存すれば、次回Unityを起動したときにもちゃんとアクティブ状態が復元されます。ですので、何かしらの情報をシリアライズしているであろうことは想像されるでしょう。
シリアライゼーションに関しては、マニュアルのテキストシーン形式の節もお役に立つかもしれません。Format of Text Serialized filesには、下記のような例が載っていました。

--- !u!1 &6
GameObject:
  m_ObjectHideFlags: 0
  m_PrefabParentObject: {fileID: 0}
  m_PrefabInternal: {fileID: 0}
  importerVersion: 3
  m_Component:
  - 4: {fileID: 8}
  - 33: {fileID: 12}
  - 65: {fileID: 13}
  - 23: {fileID: 11}
  m_Layer: 0
  m_Name: Cube
  m_TagString: Untagged
  m_Icon: {fileID: 0}
  m_NavMeshLayer: 0
  m_StaticEditorFlags: 0
  m_IsActive: 1

いかにも怪しげなm_IsActiveなんてプロパティが見えますが、残念ながらこれが何を意味するのかまでは解説されていないようです。

ほかにも取っかかりになりそうな所として、ActivationTrackはまさしくゲームオブジェクトのアクティブ状態を切り替える機能を持っています。そこでプロジェクトのフォルダ内をActivationTrackで全文検索してみたところ...

using System;
using UnityEngine.Playables;

namespace UnityEngine.Timeline
{
    /// <summary>
    /// Track that can be used to control the active state of a GameObject.
    /// </summary>
    [Serializable]
    [TrackClipType(typeof(ActivationPlayableAsset))]
    [TrackBindingType(typeof(GameObject))]
    [ExcludeFromPreset]
    public class ActivationTrack : TrackAsset
    {
        [SerializeField]
        PostPlaybackState m_PostPlaybackState = PostPlaybackState.LeaveAsIs;
        ActivationMixerPlayable m_ActivationMixer;

        /// <summary>
        /// Specify what state to leave the GameObject in after the Timeline has finished playing.
        /// </summary>
        public enum PostPlaybackState
        {
            /// <summary>
            /// Set the GameObject to active.
            /// </summary>
            Active,

            /// <summary>
            /// Set the GameObject to Inactive.
            /// </summary>
            Inactive,

            /// <summary>
            /// Revert the GameObject to the state in was in before the Timeline was playing.
            /// </summary>
            Revert,

            /// <summary>
            /// Leave the GameObject in the state it was when the Timeline was stopped.
            /// </summary>
            LeaveAsIs
        }

        internal override bool CanCompileClips()
        {
            return !hasClips || base.CanCompileClips();
        }

        /// <summary>
        /// Specifies what state to leave the GameObject in after the Timeline has finished playing.
        /// </summary>
        public PostPlaybackState postPlaybackState
        {
            get { return m_PostPlaybackState; }
            set { m_PostPlaybackState = value; UpdateTrackMode(); }
        }

        /// <inheritdoc/>
        public override Playable CreateTrackMixer(PlayableGraph graph, GameObject go, int inputCount)
        {
            var mixer = ActivationMixerPlayable.Create(graph, inputCount);
            m_ActivationMixer = mixer.GetBehaviour();

            UpdateTrackMode();

            return mixer;
        }

        internal void UpdateTrackMode()
        {
            if (m_ActivationMixer != null)
                m_ActivationMixer.postPlaybackState = m_PostPlaybackState;
        }

        /// <inheritdoc/>
        public override void GatherProperties(PlayableDirector director, IPropertyCollector driver)
        {
            var gameObject = GetGameObjectBinding(director);
            if (gameObject != null)
            {
                driver.AddFromName(gameObject, "m_IsActive");
            }
        }

        /// <inheritdoc/>
        protected override void OnCreateClip(TimelineClip clip)
        {
            clip.displayName = "Active";
            base.OnCreateClip(clip);
        }
    }
}

なんて記述が見つかりました。これはけっこうな手がかりになるんじゃないでしょうか?
ですが、やはりbboydaisukeさんの「すでに一般的ではない」という警告はもっともだと思いますので、この方針で進めるかどうかは熟慮いただくのがいいかと思います。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2020/07/09 23:00

    ご回答ありがとうございます。
    GitHubのリンクと参考コードの引用までありがとうございます!
    ヒントを元に試したら目的の動作はできたのですが、やはり裏技感は否めなかったです。

    正攻法で実装するのであれば以下の2パターンでしょうか。


    正攻法?1: Unityクラスのプロパティを操作したい場合はそれ用のコンポーネントを追加する

    ```
    public sealed class SerializableActiveSelf : MonoBehaviour
    {
    [SerializeField] bool activeSelf = true;

    private void OnValidate()
    {
    gameObject.SetActive(activeSelf);
    }
    }
    ```
    OnValidateがエディタ以外で動いたかはうろ覚えです。
    Updateで値の変更を監視して反映でもよいかもしれません。


    正攻法?2: PlayableBehaviourの`OnGraphStart`と`OnGraphStop`をオーバーライドしてキャッシュと復元を行う

    ```
    private bool targetActiveCache;

    public override void OnGraphStart(Playable playable)
    {
    this.targetActiveCache = target.activeSelf;
    }

    public override void OnGraphStop(Playable playable)
    {
    target.SetActive(targetActiveCache);
    }
    ```

    キャンセル

  • 2020/07/10 00:28

    そうですね、おっしゃるように仲介役のスクリプトを用意するのは妥当な方法かと思います。ですが、回答を投稿しておきながら申し訳ないですけれども、私はまだタイムラインを頻繁に使用した経験がなくてコメントいただいた方法で問題ないかどうか判断しかねるところがあります...

    OnValidateについては、確かにリファレンス(https://docs.unity3d.com/ja/current/ScriptReference/MonoBehaviour.OnValidate.html )を見てみたところエディター上でしか機能しないようです。また、PlayableGraphのスタート・ストップタイミングで処理するという案についても、PlayableGraphが動いている途中でゲームオブジェクトへの参照を付け外ししたりするような状況には対応できないのではないか、といった懸念もありますね...
    ですが少なくとも前者のOnValidate案であれば、エディター上での動作に問題がなければ実機でのゲームプレイ時に動作しないとしても大したことはないんじゃないかと思います。制作者がエディター上で任意のタイミングでタイムラインを編集する可能性がある状況とは異なり、実際のプレイ時にはすべての動作がプログラマーの記述したコードに従って行われることになるでしょう。ですのでゲームオブジェクトへの参照を操作するタイミングもプログラマーが把握できているはずであり、そのタイミングで適切にアクティブ状態を切り替えてやればいいような気がします。

    キャンセル

  • 2020/07/10 23:38

    なるほどOnGraphStartとStopでは参照変更の可能性がありましたね・・・

    OnValidateはタイムラインからシリアライズフィールドを操作した際には反応しなかったです・・・
    (インスペクタからの操作ではもちろん反応しました。)

    [ExecuteInEditMode]を付けてUpdateしてみても、GameObjectが非アクティブになるのでUpdateが止まってしまいました。

    自身は非アクティブにならないオブジェクトに[ExecuteInEditMode]を付けて、
    実際にSetActiveしたいオブジェクトへの参照を持つという方法はありそうですが回りくどい・・・

    元々の目的としてはオブジェクトのActive状態を特定のパターンで切り替えるタイムラインを作りたかったからなので、
    ・目的のパターンのActivationトラックを自動生成する機能を追加する
    ・Rendererの方をdisableにするなどで表示を消す。
    という方法もあるかもです。

    キャンセル

+1

このようなプライベートフィールド名を知る一般的な方法はどのようなものなのでしょうか。

隠蔽している情報を知ろうということでやろうとしていることがすでに一般的ではないように思いますが、方法としては mono のアセンブリを逆アセンブルする、ということかなと思います。
やり方は書かないので調べて欲しいのですが、結果としては activeSelf は別にプライベートフィールドの値を返しているわけではないので「ActiveSelfプロパティのフィールドを保護」ということはできない、という結論になると思います。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2020/07/09 23:00

    ご回答ありがとうございます。
    逆アセンブリして得たフィールド名を使って無理やり値を操作というのはあまりよい方法ではなさそうですね・・・
    Unity公式で公開/推奨している情報があれば使用したかったのですが、可能な限り公開されているプロパティを操作する方法で実装していきたいと思います。

    キャンセル

  • 2020/07/09 23:02

    > 逆アセンブリして得たフィールド名を使って
    そういうことではなくて、上に書いたようにフィールドを返しているわけではなく、フィールド自体ありません。

    キャンセル

  • 2020/07/09 23:07 編集

    すみませんactiveSelfについてはシリアライズフィールドで実装されているわけではないとのことでしたね。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.91%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る