positionCountを設定する意味と、使う目的。

Question

前提・実現したいこと

こちらのサイトを参考に、
LineRendererを勉強中なのですが、positionCountを使う理由がわからない為、
ご教示お願い致します。

試したこと

下記コードで実装しました。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class Sample : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {
        GameObject newLine = new GameObject ("Line");
        LineRenderer line = newLine.AddComponent<LineRenderer> ();
        line.positionCount = 2;
        line.startWidth = 0.2f;
        line.endWidth =0.2f;
        Vector3 startVec = new Vector3 (0.0f, 0.0f, 0.0f);
        Vector3 endVec = new Vector3 (5.0f, 5.0f, 0.0f);
        line.SetPosition (0, startVec);
        line.SetPosition (1, endVec);
    }

    // Update is called once per frame
    void Update()
    {
        
    }
}

上記ソースに関して、
下記コードをコメントアウトするのとしないのとの両方でゲームを実行して試してみたのですが、
その違いがわかりませんでした。

line.positionCount = 2;

positionCountを設定する意味はあるのでしょうか？
どんな役割を果たしていますか？

また、今回のコードで仮に書く必要がなかった場合、positionCountはどんなときに有用ですか？
セットすることに意味はなく、頂点数を知る為の読み取りで使う機会が多いのでしょうか？
(頂点数という表現が適切かどうかわかりませんが)。

また、GetPositionsメソッドを使っても、同じように頂点数が取得できるのかと思い、
下記を試してみたのですが、outの使い方がわからなく、実装できませんでした。
GetPositionsメソッドを使って、positionCount(頂点数)を取得できる方法があれば、こちらも教えていただきたいです。

        Vector3[] positions;
        line.GetPositions(out positions);
        Debug.Log(positions.length);

ご教示お願い致します。

追記。

色がなぜか反映されませんでした。

    void Start()
    {
        GameObject newLine = new GameObject ("Line");
        LineRenderer line = newLine.AddComponent<LineRenderer> ();
        line.positionCount = 3;
        line.startWidth = 0.2f;
        line.endWidth = 0.2f;
        line.startColor = Color.red;
        line.endColor = Color.blue;
        Vector3 pos1 = new Vector3 (0.0f, 0.0f, 0.0f);
        Vector3 pos2 = new Vector3 (5.0f, 5.0f, 0.0f);
        Vector3 pos3 = new Vector3 (3.0f, 2.0f, 1.0f);
        line.SetPositions(new Vector3[]{pos1, pos2, pos3});
        /*
        Vector3[] positions = new Vector3[line.positionCount];
        line.GetPositions(positions);
        foreach(Vector3 vertex in positions){
            Debug.Log(vertex);
        }
        */
    }

Answer 1

新規にLineRendererを作った際のデフォルトのpositionCountは2のようなので、今回の場合は違いが現れなかったのだと思います。

positionCountは頂点数を調べるために読み取るだけでなく、どうやら頂点数を変えたい場合は事前に新しい頂点数をセットしておく必要がありそうでした。
下記のようにpositionCountがデフォルトの2の状態でむりやり3点セットしようとする、あるいは3点取得しようとすると...

var lineRenderer = this.gameObject.AddComponent<LineRenderer>();
for (var i = 0; i < 3; i++)
{
    var p = Random.insideUnitSphere;
    Debug.Log($"SetPosition({i}, {p})");
    lineRenderer.SetPosition(i, p);
}
for (var i = 0; i < 3; i++)
{
    Debug.Log($"GetPosition({i}) : {lineRenderer.GetPosition(i)}");
}

下図のようなエラーメッセージが表示されました。

ただし、範囲外にアクセスしようとしても例外が発生して実行が中断されることはなく、単に無視されるような動きをしていました。

GetPositionsについてですが、リファレンスでは引数のpositionsにoutが付いていますが、実際には不要なようです（おそらくリファレンスの不備かと思います）。

使い方としては、あらかじめ頂点座標を受け取るのに十分なサイズの配列を用意しておいて、それを引数にGetPositionsを実行すればよさそうでした。
データが何個詰められたかはGetPositions実行時の返り値を見ればいいかと思います。引数の配列が新しい配列に差し替えられるわけではないため、配列のLengthを調べても最初に配列を生成したときの長さと同じになってしまうでしょう。

また、こちらも範囲外の部分はエラーメッセージだけ出して無視されるようでした。たとえば受け手側の配列の長さが足りない場合...

var lineRenderer = this.gameObject.AddComponent<LineRenderer>();
Debug.Log($"lineRenderer.positionCount:{lineRenderer.positionCount}");

// むりやり3頂点セットしようとすると、最初の2頂点だけがセットされる（エラーメッセージは出ない）
lineRenderer.SetPositions(new[] {new Vector3(1, 2, 3), new Vector3(4, 5, 6), new Vector3(7, 8, 9)});

// 1要素しかない配列で受け取ろうとすると、最初の1頂点だけが取得される
var positions = new Vector3[1];
var count = lineRenderer.GetPositions(positions);
Debug.Log($"count:{count}");
for (var i = 0; i < positions.Length; i++)
{
    Debug.Log($"positions[{i}]:{positions[i]}");
}

下図のようにエラーメッセージが表示され、GetPositionsの返り値は1となっています。

ラインマテリアルの例

Shader "Unlit/UnlitLine"
{
    Properties
    {
        _MainTex ("Texture", 2D) = "white" {}
    }
    SubShader
    {
        Tags { "RenderType"="Opaque" }

        Pass
        {
            CGPROGRAM
            #pragma vertex vert
            #pragma fragment frag
            #pragma multi_compile_fog

            #include "UnityCG.cginc"

            struct appdata
            {
                float4 vertex : POSITION;
                fixed4 color : COLOR; // 入力データとして頂点色を追加する
                float2 uv : TEXCOORD0;
            };

            struct v2f
            {
                float2 uv : TEXCOORD0;
                fixed4 color : COLOR; // v2fにも色データを追加する
                UNITY_FOG_COORDS(1)
                float4 vertex : SV_POSITION;
            };

            sampler2D _MainTex;
            float4 _MainTex_ST;

            v2f vert (appdata v)
            {
                v2f o;
                o.vertex = UnityObjectToClipPos(v.vertex);
                o.uv = TRANSFORM_TEX(v.uv, _MainTex);
                o.color = v.color; // 頂点色をセットする
                UNITY_TRANSFER_FOG(o,o.vertex);
                return o;
            }

            fixed4 frag (v2f i) : SV_Target
            {
                fixed4 col = tex2D(_MainTex, i.uv) * i.color; // 受け渡された色を乗算する
                UNITY_APPLY_FOG(i.fogCoord, col);
                return col;
            }
            ENDCG
        }
    }
    Fallback "Diffuse" // Diffuseに影落としを代行させる
}

Comments

[退会済みユーザー]

ご回答ありがとうございます。
なるほど、デフォルトの頂点数が2に設定されていたのですね。
2頂点以外の頂点数の場合は、positionCountで設定する必要があるということですね。

outは書かなくてよいのですね。
GetPositionsの引数の配列の長さは変化しないのですね。
試したところ、positionCountよりも多い要素数で引数の配列を確保した場合、
余った要素には(0,0,0)の頂点が格納されることが確認できました。
使い方や意図にもよると思いますが、
普通はGetPositionsの引数に渡す配列の要素数は、positionCountで確保するのが望ましいということでしょうか？
(最初の質問で試そうとしていた、GetPositionsに渡した配列から要素数を調べるという使い方はしなさそうで、
むしろ逆に予めpositionCountで、頂点配列の要素数を確保しておいて、GetPositionsに渡すのが普通なのかと思いました)。

Vector3 pos1 = new Vector3 (0.0f, 0.0f, 0.0f);
Vector3 pos2 = new Vector3 (5.0f, 5.0f, 0.0f);
Vector3 pos3 = new Vector3 (3.0f, 2.0f, 1.0f);
line.SetPositions(new Vector3[]{pos1, pos2, pos3});
Vector3[] positions = new Vector3[line.positionCount];
line.GetPositions(positions);
foreach(Vector3 vertex in positions){
Debug.Log(vertex);
}

あと、質問が増えてしまい、すみません。
ちょっとカラーをいじってみたのですが、反映されていなく、エラーも表示されなくて、
可能であれば原因を教えていただけませんか？
詳細は質問の追記に書きました。

[Bongo]

そうですね。GetPositionsの受け手配列のサイズをどうするべきかについては、基本的にはおっしゃるとおりpositionCountと同数でいいと思います。

positionCountと異なるサイズにするべき状況としては、頂点数を動的にころころ変えたい場合とか、頂点数の異なる複数本のラインを順次処理していく場合とかでしょうね。そんな場合にいちいちpositionCountぴったりのサイズの配列を毎回確保するのは無駄でしょうから、あらかじめ予想される最大サイズの配列を最初に確保しておく方式にすれば（もし当初の予測より大きい数が必要になったら、そのときに新しいサイズの配列を確保しなおすことになるでしょう）メモリの確保・解放処理を最小限に抑えることができ効率的かと思います。

こういった「余分なメモリ領域を確保しておいて、実際に使うのは配列の先頭から実際の要素数個だけ」という戦略はわりとよく見かけるように思います。たとえばList<T>（https://docs.microsoft.com/ja-jp/dotnet/api/system.collections.generic.list-1 ）は追加・削除によって要素数が増減しますが、内部的には似たような方式を使用していたはずです。リファレンスによると、Count（https://docs.microsoft.com/ja-jp/dotnet/api/system.collections.generic.list-1.count ）が実際に格納されている要素数、Capacity（https://docs.microsoft.com/ja-jp/dotnet/api/system.collections.generic.list-1.capacity ）が内部的に確保している領域の容量を示すようです。

色を反映させられなかった件についてですが、メニューの「GameObject」→「Effects」→「Line」で作成されるラインオブジェクトの場合はDefault-Lineマテリアルがセットされているのに対し、スクリプトからLineRendererをアタッチしただけの状態だとマテリアルがセットされていないことによるんじゃないでしょうか。

Default-Lineマテリアルをスクリプトから取得する方法があるのかどうかはよくわかりませんでした。メニューからラインを作成した場合の挙動については、おそらくhttps://github.com/Unity-Technologies/UnityCsReference/blob/master/Editor/Mono/Commands/GOCreationCommands.cs の最後の方にある「CreateLine」が実行されているんじゃないかと思いますが、ここだとマテリアルを「line.material = Material.GetDefaultLineMaterial();」という風にセットしています。ですがGetDefaultLineMaterialはアクセシビリティがinternalなので普通に使用することはできないでしょう。むりやり...

lineRenderer.material = typeof(Material).GetMethod("GetDefaultLineMaterial", BindingFlags.DeclaredOnly | BindingFlags.NonPublic | BindingFlags.Static).Invoke(null, null) as Material;

とでもしてやれば取得できなくはなさそうでしたが、順当な方法としては...

[SerializeField] private Material lineMaterial;

のようにフィールドを追加してやり、これにインスペクター上であらかじめDefault-Lineをセットしておいて...

lineRenderer.material = this.lineMaterial;

という風にしてやるのがいいんじゃないかと思います。

[退会済みユーザー]

ご回答ありがとうございます。
GetPositionsでpositionCountと同数以外の要素数を確保する事例のご教示ありがとうございます。

下記コードで色が反映されることを確認できました。

[SerializeField]
Material lineMaterial;

void Start()
{
GameObject newLine = new GameObject ("Line");
LineRenderer line = newLine.AddComponent<LineRenderer> ();
line.positionCount = 3;
line.startWidth = 0.2f;
line.endWidth = 0.2f;
line.material = lineMaterial;
//line.startColor = Color.red;
//line.endColor = Color.green;
Vector3 pos1 = new Vector3 (0.0f, 0.0f, 0.0f);
Vector3 pos2 = new Vector3 (5.0f, 5.0f, 0.0f);
Vector3 pos3 = new Vector3 (3.0f, 2.0f, 1.0f);
line.SetPositions(new Vector3[]{pos1, pos2, pos3});
}

また、今までラインの影が生成されてなくて悩んでいたのですが、
今回のマテリアルで色を与えるやり方を実装したら、影も生成されるようになりました。

ちなみに、こちらのサイトのように、
https://qiita.com/keito_takaishi/items/f619cf3cb8d0013237ee
SetColorsは、今はstartColorやendColorかと思いますが、
今回の動的にGameObjectを生成して、AddComponent<LineRenderer>するコードで
startColorとendColorで別々の色を指定する方法って存在しますか？
上記コードにおいてコメントを外してみたのですが、色が反映されませんでした。

また、「GameObject」→「Effects」→「Line」で予め作成しておいた
LineオブジェクトのLineRendererコンポーネントをいじるコードでは、
startColorとendColorの色設定が効くことは確認できました。

[Bongo]

私の環境では（2019.2.11f1、Windows版）ではどうも再現せず、ご提示いただいたコードのコメント部分を有効にしてみると赤から緑のグラデーションで塗られました...

lineMaterialにセットしたマテリアルは「Default-Line」になっているでしょうかね?
影も生成されるようになったとのことですが、Default-Lineは影を落とさないタイプのマテリアルかと思います。
もしグラデーション付きかつ影落としありにする場合、自前でマテリアルを作る必要があるかもしれません。
シェーダーの例を追記してみましたがどうでしょうか?

[退会済みユーザー]

ご回答ありがとうございます。
Default-Lineを理解していなく、新規作成のマテリアルでセットしてしまっていました。

>これにインスペクター上であらかじめDefault-Lineをセットしておいて...
このDefault-LineをUnityエディタのAssetsから取得する方法なのですが、
こちらのサイトを参考にしたのですが、
http://kan-kikuchi.hatenablog.com/entry/GetBuiltinResource

C:\Program Files\Unity\Hub\Editor\2019.2.1f1\Editor\Data\Resources\unity_builtin_extra
をコピーして、.assetを付けて、UnityエディタのProjectパネルで取り込むという方法で合っていますか？
一応できたのですが、もしかしたら、もっと手軽な方法ってあったりしますか？

また、上記参考サイトにより、スクリプトで取得することができました。
#if UNITY_EDITOR
Material lineDefaultMaterial = UnityEditor.AssetDatabase.GetBuiltinExtraResource<Material>("Default-Line.mat");
#else
Material lineDefaultMaterial = Resources.GetBuiltinResource<Material>("Default-Line.mat");
#endif

なるほど、グラデーション付きかつ影落としありにする場合、
シェーダーを自作しなければならないのですね
(シェーダーは全然勉強していないので後々勉強していきたいと思っています)。
シェーダーのご提示ありがとうございます。
こちら試させていただき、グラデーションも影落としもありのラインが生成できたことを確認致しました。ありがとうございます。

追記：
GetBuiltinResourceを知りたいと思い、公式のスクリプトリファレンスで検索してみたのですが、何故か引っ掛かりませんでした。

[Bongo]

おお、GetBuiltinResourceが使えましたか!私の環境だとなぜかうまくいかず早々にあきらめてしまったのですが、それで取得できましたら問題ないかと思います。
リファレンスに載っていない理由はいまいちわかりませんね...何かの理由でpublicにしてあるけれど、Unityユーザー側から使うことは想定していないということなのでしょうか?

追記:
https://docs.unity3d.com/ScriptReference/ParticleSystemRenderer.SetMeshes.html のサンプルコード内で堂々とGetBuiltinResourceを使っているようでした。使ってはいけないというわけでもないんでしょうかね?お役に立てずすみません...

「Default-Lineをセットしておいて」と申し上げたのは、インスペクター上のマテリアル欄の右端にある「◎」（丸の中に点）ボタンを押すと出てくるウィンドウで選択・セットすることを意図しておりました。わかりづらくてすみません...

[退会済みユーザー]

ご回答ありがとうございます。
GetBuiltinResourceそのものはリファレンスになくても、ParticleSystemRenderer.SetMeshesのサンプルコードでは出てくるのですね、謎ですね。
私の環境は、Unity 2019.2.1f1でした。もしかしたら、バージョンによってはまだGetBuiltinResourceが安定していないのかなと思いました。
「◎」ボタンで、デフォルトリソースのアセットが取得できたのですね。
ご教示ありがとうございます。

いろいろな質問をご教示くださり、ありがとうございました。
とても勉強になりました。