Unreal スマート ポインタ ライブラリ

Unreal スマート ポインタ ライブラリ は、メモリ割り当てとメモリ追跡の負担を軽減するために設計された C++11 のスマート ポインタをカスタム実装したものです。この実装には、業界標準の シェアード ポインタ、弱いポインタ、および ユニーク ポインタ が含まれています。non-nullable 型のシェアード ポインタとして動作する 共有の参照 も追加されています。これらのクラスを UObject システムで使用することはできません。Unreal オブジェクトはゲーム コード向けに改良された独自のメモリ追跡システムを使用しているためです。

スマート ポインタのタイプ

スマート ポインタは、スマート ポインタに含まれる、または参照されるオブジェクトのライフスパンに影響します。スマート ポインタのタイプによって、オブジェクトに対する制限と効果が異なります。次の表は、各スマート ポインタのタイプをどの状況で使用するのが適切かを判断するうえで役立ちます。

スマート ポインタの利点

ヘルパー クラスと関数

スマート ポインタを簡単かつ直観的に使用するために、Unreal スマート ポインタ ライブラリには、ヘルパー クラスとヘルパー関数がいくつか用意されています。

スマート ポインタの実装に関する詳細

Unreal スマート ポインタ ライブラリのスマート ポインタは共通して、機能性と効率性の面でいくつかの一般的特徴を共有しています。

速度

スマート ポインタの使用を検討する際は、常にパフォーマンスの考慮が重要となります。スマート ポインタは、特定のハイレベルなシステム、リソース管理、またはツール プログラミングに適しています。ただし、スマート ポインタのタイプによっては、生の C++ ポインタよりも低速となり、このオーバーヘッドにより、レンダリングなどの低レベルのエンジン コードにおける有用性が低下します。

スマート ポインタのパフォーマンス上の利点は以下のとおりです。

• すべての操作を一定時間で実行

• ほとんどのスマート ポインタは逆参照すると生の C++ ポインタと同等に高速 (出荷ビルドの場合)

• スマート ポインタをコピーしてもメモリが割り当てられない

• スレッド セーフなスマート ポインタはロックフリー

スマート ポインタのパフォーマンス上の欠点には以下のとおりです。

• 生の C++ ポインタを作成したりコピーするよりスマート ポインタを作成、コピーしたときのオーバーヘッドの方が大きい

• 参照カウントを維持すると基本演算のサイクルが増える

• スマート ポインタによっては、C++ ポインタよりも多くのメモリを使用することがある

• 参照コントローラーには 2 つのヒープ割り当てが存在する。MakeShareable の代わりに MakeShared を使用して 2 つ目の割り当てを回避することで、パフォーマンスを向上させることができます。

侵入型アクセサー

シェアード ポインタは非侵入型です。つまり、スマート ポインタによって所有されているかどうかについてオブジェクトは認識しません。これは、通常は許容されますが、共有の参照またはシェアード ポインタとしてオブジェクトにアクセスしたい場合があるかもしれません。そうするためには、オブジェクトのクラスをテンプレート パラメータとして使用して、TSharedFromThis からオブジェクトのクラスを派生させます。TSharedFromThis は、オブジェクトを共有の参照に (そしてそこからシェアード ポインタへ) 変換できる 2 つの関数 AsShared と SharedThis を提供します。これは、常に共有の参照を返すクラス ファクトリで、または、オブジェクトを共有の参照またはシェアード ポインタを想定するシステムに渡す必要がある場合に役立ちます。AsShared は、本来 TSharedFromThis へのテンプレート引数として渡される型としてクラスを返します。この型は呼び出し側のオブジェクトの親の型となる場合がある一方で、SharedThis はこれから直接型を派生させて、その型のオブジェクトを参照するスマート ポインタを返します。以下のサンプル コードで両方の関数を示します。

class FRegistryObject;
class FMyBaseClass: public TSharedFromThis<FMyBaseClass>
{
    virtual void RegisterAsBaseClass(FRegistryObject* RegistryObject)
    {
        // Access a shared reference to 'this'.
        // We are directly inherited from <TSharedFromThis> , so AsShared() and SharedThis(this) return the same type.
        TSharedRef<FMyBaseClass> ThisAsSharedRef = AsShared();
        // RegistryObject expects a TSharedRef<FMyBaseClass>, or a TSharedPtr<FMyBaseClass>. TSharedRef can implicitly be converted to a TSharedPtr.
        RegistryObject->Register(ThisAsSharedRef);
    }
};
class FMyDerivedClass : public FMyBaseClass
{
    virtual void Register(FRegistryObject* RegistryObject) override
    {
        // We are not directly inherited from TSharedFromThis<>, so AsShared() and SharedThis(this) return different types.
        // AsShared() will return the type originally specified in TSharedFromThis<> - TSharedRef<FMyBaseClass> in this example.
        // SharedThis(this) will return a TSharedRef with the type of 'this' - TSharedRef<FMyDerivedClass> in this example.
        // The SharedThis() function is only available in the same scope as the 'this' pointer.
        TSharedRef<FMyDerivedClass> AsSharedRef = SharedThis(this);
        // RegistryObject will accept a TSharedRef<FMyDerivedClass> because FMyDerivedClass is a type of FMyBaseClass.
        RegistryObject->Register(ThisAsSharedRef);
    }
};
class FRegistryObject
{
    // This function will accept a TSharedRef or TSharedPtr to FMyBaseClass or any of its children.
    void Register(TSharedRef<FMyBaseClass>);
};

この時点で共有の参照は初期化されていないので、コンストラクタから AsShared や SharedThis を呼び出さないでください。クラッシュやアサートが発生します。

キャスト

Unreal スマート ポインタ ライブラリに含まれるサポート関数をいくつか使用して、シェアード ポインタ (および共有の参照) をキャストできます。アップキャストは C++ ポインタと同様、暗黙的に行われます。ConstCastSharedPtr 関数でコンスト キャスト、 StaticCastSharedPtr 関数で静的キャスト (しばしば派生したクラス ポインタのダウンキャストに使用されます) が可能です。実行時型情報 (RTTI) が存在しないので、動的キャストはサポートされません。代わりに、以下のコードのように静的キャストを使用してください。

// This assumes we validated that the FDragDropOperation is actually an FAssetDragDropOp through other means.
TSharedPtr<FDragDropOperation> Operation = DragDropEvent.GetOperation();
// We can now cast with StaticCastSharedPtr.
TSharedPtr<FAssetDragDropOp> DragDropOp = StaticCastSharedPtr<FAssetDragDropOp>(Operation);

スレッド セーフティ

デフォルトでは、スマート ポインタは単一スレッドにアクセスする場合のみ安全です。複数のスレッドへのアクセスが必要な場合、スマート ポインタ クラスのスレッド セーフなバージョンを使用します。

• TSharedPtr<T, ESPMode::ThreadSafe>

• TSharedRef<T, ESPMode::ThreadSafe>

• TWeakPtr<T, ESPMode::ThreadSafe>

• TSharedFromThis<T, ESPMode::ThreadSafe>

これらのスレッド セーフなバージョンはアトミックな参照カウントにより若干低速ですが、ビヘイビアは通常の C++ ポインタと一致します。

• Read と Copy は常にスレッド セーフです。

• Write と Reset は安全性のため同期する必要があります。

ヒントと制限事項

• 逆参照や参照カウントによってオーバーヘッドが発生するため、可能な限り TSharedRef や TSharedPtr パラメータとしてデータを関数に渡すことは避けてください。代わりに、参照されているオブジェクトを const & として渡すことを推奨します。

• シェアード ポインタを前方宣言して不完全な型にすることができます。

• シェアード ポインタは Unreal オブジェクト (UObject およびその派生クラス) と互換性がありません。Unreal Engine には UObject 管理のための独自のメモリ管理システムがあります (「Unreal でのオブジェクトの処理」 を参照)。これら 2 つのシステムは互いに干渉しません。