CWinCtrlRenderIcon

スクリプト: RENDERICON

アイコンにレンダリングするためのコントロールです。

指定されたレンダーテクスチャから自動的に矩形を切り出し、レンダリングします。

複数のレンダー結果を一枚のレンダーテクスチャ内に含めることができるため、一度レンダリングした後のアイコンの描画が高速です。

例えば、リストボックス内のコンテンツに着せ替え可能アバターアイコンを表示したいときなどに使うと効果的です。

CWindowBase に届くコールバック

:meth:`void onClick(CWinCtrlBase cCtrl)<CWindowBase.onClick>`

:meth:`void onHold(CWinCtrlBase cCtrl)<CWindowBase.onHold>`

:meth:`void onBeginDrag(CWinCtrlBase cCtrl,Vector2 pos)<CWindowBase.onBeginDrag>`

:meth:`void onDrag(CWinCtrlBase cCtrl,Vector2 pos,Vector2 dragVelocity)<CWindowBase.onDrag>`

:meth:`bool onDragRender(CWinCtrlBase cCtrl,Transform transform)<CWindowBase.onDragRender>`

:meth:`void onDrop(CWinCtrlBase cCtrl,CWindowBase cDragWindow,CWinCtrlBase cDragCtrl)<CWindowBase.onDrop>`

:meth:`void onDropGround(CWinCtrlBase cCtrl)<CWindowBase.onDropGround>`

:meth:`bool onBeginRenderIcon(CWinCtrlRenderIcon icon)<CWindowBase.onBeginRenderIcon>`

アイコンにレンダリング開始

この関数の戻り値は、次の意味を持ちます。

:meth:`bool onEndRenderIcon(CWinCtrlRenderIcon icon)<CWindowBase.onEndRenderIcon>`

レンダリングが終了したときに呼ばれる

この関数の戻り値は、次の意味を持ちます。

一度停止させたレンダリングを再開したいときは、 :prop:`needToRender<CWinCtrlRenderIcon.needToRender>` をtrueにしてください。

固有の関数/プロパティ

0以外の固有のIDを割り振ってください。 0を代入すると確保されたレンダリング領域が解放されます。 また、他のコントロールと同じ値を割り振ると、レンダリング領域を共有します。

レンダリングテクスチャが割り当てられたカメラを取得できます。 カメラの位置や角度等をカスタマイズしたいときにアクセスしてください。

レンダリングする際の背景色として割り当てられています。

デフォルトは、(0,0,0,0)です。

レンダリングを再開したいとき、trueを設定してください。

次のフレームでは :meth:`onBeginRenderIcon<CWindowBase.onBeginRenderIcon>` が呼び出されます。

アイコンが押されている状態を取得できます。

使用例

:meth:`onBeginRenderIcon<CWindowBase.onBeginRenderIcon>` によって、レンダリングしたいオブジェクトのみアクティブにしています。 そして、 :meth:`onEndRenderIcon<CWindowBase.onEndRenderIcon>` によって、非アクティブにしています。

この操作をしないと全てのオブジェクトが一つのアイコンにレンダリングされることになります。

また、 :meth:`onBeginRenderIcon<CWindowBase.onBeginRenderIcon>` がtrueを返すと、直ちにCamera.Render()が呼び出されるので、 アニメーションなどの設定をしたときは、下記の例のように、Animation.Sample()を明示的に呼んでおく必要があります。

正しくレンダリングされないときは、以下の点をチェックしてみて下さい。

  • レイヤーの設定がおかしくないか？/レイヤーの設定を忘れていないか?

  • カメラにレンダリング対象が収まっているか？

当然、カメラに収まっていないとオブジェクトはレンダリングされません。

:prop:`regionId<CWinCtrlRenderIcon.regionId>` が0の時は、レンダーテクスチャへのレンダリングが行われません。 :prop:`regionId<CWinCtrlRenderIcon.regionId>` をキーにしてレンダーテクスチャの空いている領域から矩形を切り出し、レンダリングします。

override public bool onBeginRenderIcon(CWinCtrlRenderIcon icon) {
    CWinCtrlListbox    lbAvatar = lbAvatar = find(CWinCtrlListbox>(LISTBOX_Avatar);
    int idx = lbAvatar.getContentsIndex(icon);
    if (idx < 0) {
        return false;
    }
    GameObject go = m_lstGameObject[idx];
    if (go == null) {
       return false;
    }
    go.SetActive(true);
    Animation anim = go.GetComponent<Animation>();
    anim.Sample();

    return true;
}
override public bool onEndRenderIcon(CWinCtrlRenderIcon icon) {
    CWinCtrlListbox    lbAvatar = lbAvatar = find(CWinCtrlListbox>(LISTBOX_Avatar);
    int idx = lbAvatar.getContentsIndex(icon);

    GameObject go = m_lstGameObject[idx];
    if (go == null) {
       return false;
    }
    go.SetActive(false);
    return false;
}

// click callback
override public void onClick(CWinCtrlBase cCtrl) {
  switch (cCtrl.id) {
    case RENDERICON_Avatar:
      break;
   }
}
// hold callback
override public void onHold(CWinCtrlBase cCtrl) {
   switch (cCtrl.id) {
     case RENDERICON_Avatar:
      break;
    }
}

各レイヤーの初期値

Camera.cullingMask = e_Layer.RenderIcon;

特に必要が無ければ触らないようにしておいてください。

レンダリングするときは、レイヤー設定をしているかしっかり確認してください。

レンダリング対象のゲームオブジェクトも上記値を設定しておくようにしておいてください。

// If gameobjectAvatar is not multiple hierarchies, the following is sufficient.
gameobjectAvatar.layer = (int) e_LayerId.RenderIcon;
// If gameobjectAvatar is made up of multiple hierarchies, it must be recursively set using the following function:
Utility.setLayer(gameObjectAvatar,e_LayerId.RenderIcon);
gameobjectAvatar.SetActive(false);

注釈

GameObject.layerは、一つの階層に対してのみレイヤーを設定します。子供の階層にまで影響を与えません。 レンダーアイコンが持つカメラに選択的に子供の階層を持つオブジェクトを正しくレンダリングするためには、 本アセットが用意しているレイヤーを再帰的に設定可能な、Utility.setLayerを使ってください。

レンダリングの主な流れ

RenderIconは、複数のモデルをテクスチャにレンダリングして表示するのに適しています。 ただし、レイヤーの数が限りがあるので、一つのレイヤーを使いまわすことを考える必要があります。

この問題を回避するために次のような手順でレンダリングします。

  1. モデルの読み込み

  2. 読み込み終わったら、SetActive(false)にしてゲームオブジェクトを非アクティブにします

  3. レイヤーをRenderIconに設定します。

  4. :prop:`regionId<CWinCtrlRenderIcon.regionId>` に、ユニークな値を設定します。

  5. OnBeginRenderIconが呼ばれたら、対象のゲームオブジェクトをアクティブにします

  6. OnEndRenderIconが呼ばれたら、対象のゲームオブジェクトを非アクティブにします

これによって必ずRenderIconにレンダリングされるゲームオブジェクトを一つに絞ることができます。 OnEndRenderIconの戻り値は、falseを返しておく方がパフォーマンスが出ます。 そうしないと、毎フレーム、テクスチャへのレンダリングが発生してしまいます。

onBeginRenderが呼ばれるタイミング