[Manual] Simple Path Generator

🌊 Simple Path Visualizer

Unity Flow Visualizer's simple version

To be updated later

한국어 설명은 아래에 있습니다.

---

1 . Overview

• Expresses only the shortest straight line path by receiving two point (Vector3 or Transform)
• Visualizer that can display the flow rate passing through the path

---

2. How to use

in Unity Scene, You should instantiate Assets\UnityFlowVisualizer\Prefabs\SimplePath\SimplePathGenerator prefabs (You only need one in the scene)

2-1. Set namespace

To use the Simple Path Visualizer, you must use the UnityFlowVisualizer namespace in your script.

using UnityFlowVisualizer;

2-2. Get SimplePathGenerator instance

In order to use the Simple Path Visualizer, you need to get an instance of SimplePathGenerator.

SimplePathGenerator simplePath = SimplePathGenerator.Instance;

At this time, if step 2 is not performed, SimplePathGenerator.Instance is null.

2-3. Make simple path

You can create a path connecting two points through the public GameObject InstantiatePath(...) function of SimplePathGenerator.

public GameObject InstantiatePath(...) is overloaded with the following 4 types.

• public GameObject InstantiatePath(Transform Start, Transform End, Color PathColor, float Thickness = 1f);
• public GameObject InstantiatePath(Vector3 Start, Vector3 End, Color PathColor, float Thickness = 1f);
• public GameObject InstantiatePath(Transform Parent, Transform Start, Transform End, Color PathColor, float Thickness = 1f);
• public GameObject InstantiatePath(Transform Parent, Vector3 Start, Vector3 End, Color PathColor, float Thickness = 1f);

A description of the parameters is as follows.

Parameter	Description
Start	The starting point of the Path (For Vector3, it must be World coordinates of the starting point)
End	End point of Path (For Vector3, it must be World coordinates of the starting point)
Parent	Path can be set as a child of that object
Color	The color of the path. Alpha value can be applyed
Thickness	The thickness of the path. Default 1

2-4. Flow visualize

Through the public GameObject Shooting(...) function of SimplePathGenerator, you can visualize the flow rate that flows through the path.

public GameObject Shooting(...) has the following three overloads.

• public GameObject Shooting(SimplePath path, SHOT_TYPE type = SHOT_TYPE.FLOW_BLUE, float speed = 0.2f);
• public GameObject Shooting(Transform start, Transform end, SHOT_TYPE type = SHOT_TYPE.FLOW_BLUE, float speed =0.2f);
• public GameObject Shooting(Vector3 start, Vector3 end, SHOT_TYPE type = SHOT_TYPE.FLOW_BLUE, float speed = 0.2f);

A description of the parameters is as follows.

Parameter	Description
Start	The starting point of the Path (For Vector3, it must be World coordinates of the starting point)
End	End point of Path (For Vector3, it must be World coordinates of the starting point)
path	Path to be expressed.
type	Type of flow particle. Default FLOW_BLUE
speed	flow rate. Default 0.2

Here, SHOT_TYPE is an enum declared in SimplePathGenerator and is as follows.

public enum SHOT_TYPE {
    FLOW_RED, FLOW_GREEN, FLOW_BLUE,
    GAS_RED,  GAS_GREEN,  GAS_BLUE,
    ELEC_RED, ELEC_GREEN, ELEC_BLUE
}

2-5. Delete path

You can delete the created path through the public void DeletePath(SimplePath path) function of SimplePathGenerator.

2-6. Clear path

You can remove all generated paths through the public void ClearPath() function of SimplePathGenerator.

This is useful when you want to redraw the path.

---

Example

Here is a demo of SimplePathDemo.unity located in Assets\UnityFlowVisualizer\Demo.

The following test code was used.

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityFlowVisualizer;    // UnityFlowVisualizer 네임 스페이스 사용

public class SimplePathTest : MonoBehaviour
{
    public Transform StartTr;
    public Transform EndTr;
    public Color PathColor;

    // Start is called before the first frame update
    void Start()
    {
        // Draw path
        SimplePathGenerator.Instance.InstantiatePath(StartTr, EndTr, PathColor, 1f);

        // Visualize flow
        StartCoroutine(Shooting());
    }

    // Update is called once per frame
    IEnumerator Shooting()
    {
        while(true) {
            // Fires FLOW_BLUE at a speed of 0.2 every 0.7 seconds
            SimplePathGenerator.Instance.Shooting(StartTr, EndTr);
            yield return new WaitForSeconds(0.35f);
        }
    }
}

---

🌊 심플 패스 생성기 (🇰🇷 Ver)

Unity Flow Visualizer의 간단한 버전

추후 더 업데이트 예정

---

1 . 개요

• 두 좌표(Vector3또는 Transform)을 입력받아 최단거리 직선 Path만을 표현
• Path를 지나가는 유량을 표시 할 수 있는 Visualize

---

2. 어떻게 사용하는가?

Unity Scene에서, Assets\UnityFlowVisualizer\Prefabs\SimplePath\SimplePathGenerator프리팹을 인스턴스화 해야함 (Scene에 하나만 있으면 됨)

2-1. 네임 스페이스 사용하기

Simple Path Visualizer를 사용하기 위해서, 스크립트에서 UnityFlowVisualizer 네임스페이스를 사용해야함

using UnityFlowVisualizer;

2-2. SimplePathGenerator 인스턴스 가져오기

Simple Path Visualizer를 사용하기 위해서, SimplePathGenerator 인스턴스를 가져와야함

SimplePathGenerator simplePath = SimplePathGenerator.Instance;

이때, 2를 진행하지 않았으면, SimplePathGenerator.Instance는 null임

2-3. 패스 만들기

SimplePathGenerator의 public GameObject InstantiatePath(...) 함수를 통해 두 점을 잇는 Path를 만들 수 있음

public GameObject InstantiatePath(...)는 다음 4가지로 오버로딩되어 있다.

• public GameObject InstantiatePath(Transform Start, Transform End, Color PathColor, float Thickness = 1f);
• public GameObject InstantiatePath(Vector3 Start, Vector3 End, Color PathColor, float Thickness = 1f);
• public GameObject InstantiatePath(Transform Parent, Transform Start, Transform End, Color PathColor, float Thickness = 1f);
• public GameObject InstantiatePath(Transform Parent, Vector3 Start, Vector3 End, Color PathColor, float Thickness = 1f);

파라미터에 대한 설명은 아래와 같다.

파라미터	설명
Start	Path의 시작 지점 (Vector3인 경우, 시작 지점의 World좌표여야 함)
End	Path의 끝 지점 (Vector3인 경우, 시작 지점의 World좌표여야 함)
Parent	해당 오브젝트의 자식으로 Path를 설정할 수 있음
Color	Path의 색상. Alpha값을 넣을 수 있음
Thickness	Path의 두께. 기본값 1

2-4. 유량 시각화

SimplePathGenerator의 public GameObject Shooting(...) 함수를 통해 Path를 흐르는 유량을 시각화 할 수 있다.

public GameObject Shooting(...)는 다음 3가지로 오버로딩되어 있다.

• public GameObject Shooting(SimplePath path, SHOT_TYPE type = SHOT_TYPE.FLOW_BLUE, float speed = 0.2f);
• public GameObject Shooting(Transform start, Transform end, SHOT_TYPE type = SHOT_TYPE.FLOW_BLUE, float speed =0.2f);
• public GameObject Shooting(Vector3 start, Vector3 end, SHOT_TYPE type = SHOT_TYPE.FLOW_BLUE, float speed = 0.2f);

파라미터에 대한 설명은 아래와 같다.

파라미터	설명
Start	Path의 시작 지점 (Vector3인 경우, 시작 지점의 World좌표여야 함)
End	Path의 끝 지점 (Vector3인 경우, 시작 지점의 World좌표여야 함)
path	표현하고자 하는 Path.
type	유량 Particle의 종류. 기본값 FLOW_BLUE
speed	유량의 속도. 기본값 0.2

여기서 SHOT_TYPE은 SimplePathGenerator에 선언된 enum으로 다음과 같다.

public enum SHOT_TYPE {
    FLOW_RED, FLOW_GREEN, FLOW_BLUE,
    GAS_RED,  GAS_GREEN,  GAS_BLUE,
    ELEC_RED, ELEC_GREEN, ELEC_BLUE
}

2-5. 패스 삭제

SimplePathGenerator의 public void DeletePath(SimplePath path) 함수를 통해 생성된 Path를 제거 할 수 있다.

2-6. 패스 전체 삭제

SimplePathGenerator의 public void ClearPath() 함수를 통해 생성된 모든 Path를 제거 할 수 있다.

Path를 다시 그리고 싶을 때 사용하면 좋다.

---

사용 예제

다음은 Assets\UnityFlowVisualizer\Demo에 있는 SimplePathDemo.unity 데모이다.

아래와 같은 테스트 코드를 사용하였다.

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityFlowVisualizer;    // UnityFlowVisualizer 네임 스페이스 사용

public class SimplePathTest : MonoBehaviour
{
    public Transform StartTr;
    public Transform EndTr;
    public Color PathColor;

    // Start is called before the first frame update
    void Start()
    {
        // Path 그리기
        SimplePathGenerator.Instance.InstantiatePath(StartTr, EndTr, PathColor, 1f);

        // Flow 시각화
        StartCoroutine(Shooting());
    }

    // Update is called once per frame
    IEnumerator Shooting()
    {
        while(true) {
            // 0.7초마다 FLOW_BLUE를 속도 0.2로 발사
            SimplePathGenerator.Instance.Shooting(StartTr, EndTr);
            yield return new WaitForSeconds(0.35f);
        }
    }
}