Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@KimYC1223
KimYC1223 authored Sep 1, 2020
1 parent 53677e5 commit c4a99a6
Showing 1 changed file with 72 additions and 27 deletions.
99 changes: 72 additions & 27 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@

아래에 한국어 번역이 있습니다. (There is an Korean translation at the bottom.)


<br>

## 1. Introduction

Imagine that you make car running along curved road in Unity Scene.

You can make this car with Animator, but there are some problems.

<br>

#### 1-1 . It is difficult to handling object between keyframes.

![image](https://github.com/KimYC1223/UnityPathGenerator/blob/master/ReadmeImage/figure2.png?raw=true)
Expand All @@ -26,6 +28,8 @@ There are so many ways to move object.

But If you implement this with Unity Animator, the Animator will choose the shortest path (orange line).

<br>

#### 1-2 . It is difficult to move at a constant speed

![image](https://github.com/KimYC1223/UnityPathGenerator/blob/master/ReadmeImage/figure3.png?raw=true)
Expand All @@ -46,7 +50,7 @@ Of course, It's possible if you spend a lot of time.

But if the path is curved, It will be very hard to calculate the ratio.


<br>

#### 1-3 . Bézier Curve

Expand Down Expand Up @@ -84,25 +88,21 @@ The trajectory drawn by point B is called a quadratic Bezier curve.

Below is the Bezier curve equation for time t.



![image](https://github.com/KimYC1223/UnityPathGenerator/blob/master/ReadmeImage/figure7.png?raw=true)



As you increase the control point, you can create a 3rd, 4th, 5th order .. Bezier curve.

As the control point increases, you can create sophisticated or complex curves,

For this project, I thought that the quadratic Bezier curve was sufficient.


<br><br>

## 2 . Environment

Unity Version : 2019.4.1f


<br><br>

## 3 . How to use

Expand All @@ -114,8 +114,12 @@ There are 3 scripts I will introduce.

So let's get started.

<br>

---

<br>

#### 3-1 . Import package

3-1-1 . Download [latest release unity package](https://github.com/KimYC1223/UnityPathGenerator/releases/tag/1.0) or clone this repo.
Expand All @@ -138,7 +142,9 @@ So let's get started.

---

​ 3-2-4-1. **Flag**
<br>

##### 3-2-4-1. **Flag**

​ Put in a game object (prefab) to represent the **"Flag".**

Expand All @@ -150,7 +156,9 @@ So let's get started.

​ ***(This is the same role as P0 and P2 in the picture above.)***

​ 3-2-4-2 . **Start Flag**
<br><br>

##### 3-2-4-2 . **Start Flag**

​ Put in a game object (prefab) to represent the **"Start Flag"**

Expand All @@ -160,7 +168,9 @@ So let's get started.

​ **Start Flag is the 0th Flag (FlagList[0]), which is the point where the object will start first.**

​ 3-2-4-3 . **Angle**
<br><br>

##### 3-2-4-3 . **Angle**

​ Put in a game object (prefab) to represent the **"Angle"**

Expand All @@ -174,7 +184,9 @@ So let's get started.

​ ***(It is the same role as P1 in the picture above.)***

​ 3-2-4-4 . **Guide**
<br><br>

##### 3-2-4-4 . **Guide**

​ Put in a game object (prefab) to represent the **"Guide (Path)"**

Expand All @@ -184,21 +196,29 @@ So let's get started.

​ **Guide visually expresses the path determined through Flags and Angles.**

​ 3-2-4-5 . **Is Close**
<br><br>

##### 3-2-4-5 . **Is Close**

​ choose path type (Closed path or open path).

​ If this is true, auto connection between head of Flag List and tail of Flag List.

​ 3-2-4-6 . **Is Debug Obejct**
<br><br>

##### 3-2-4-6 . **Is Debug Obejct**

​ Determine to show Debug Objects (Flag,StarFlag,Angle).

​ 3-2-4-7 . **Is Debug Line**
<br><br>

##### 3-2-4-7 . **Is Debug Line**

​ Determine to show Debug Lines (Guide).

​ 3-2-4-8 . **Path Density**
<br><br>

##### 3-2-4-8 . **Path Density**

![figure11](https://github.com/KimYC1223/UnityPathGenerator/blob/master/ReadmeImage/figure11.gif?raw=true)

Expand All @@ -210,14 +230,20 @@ So let's get started.

​ The recommended value is 30.

​ 3-2-4-9 . **FlagList**
<br><br>

##### 3-2-4-9 . **FlagList**

​ List of Flag. FlagList's Length should always be at least 2.

​ 3-2-4-10 . **AngleList**
<br><br>

##### 3-2-4-10 . **AngleList**

​ List of Angle. AngleList's Length should always be equal FlagList's Length.

<br>

---

3-2-5 . Fill in the blanks. In this tutorial, I'll use [Prefabs>Makers] elements.
Expand Down Expand Up @@ -250,38 +276,50 @@ So let's get started.

---

​ 3-3-4-1 . **EndEvent()**
##### 3-3-4-1 . **EndEvent()**

​ Input the function to run when it arrived final destination.

​ **Remember!** If the path is closed loop, there is no final destination.

​ 3-3-4-2 . **Path**
<br><br>

##### 3-3-4-2 . **Path**

​ Input the object with "Path Generator" component.

​ This object will move along this path.

​ 3-3-4-3 . **Speed**
<br><br>

##### 3-3-4-3 . **Speed**

​ Speed of movement. **too high value can cause objects to behave erratically.**

​ 3-3-4-4 . **Turning Speed**
<br><br>

##### 3-3-4-4 . **Turning Speed**

​ Speed of rotation. **too high value can cause objects to behave erratically.**

​ 3-3-4-5 . **Is Loop**
<br><br>

##### 3-3-4-5 . **Is Loop**

​ If the path is opened and this value is true,

​ the object teleport at Start Flag when it arrived final destination.

​ **Remember!** If the path is closed loop, there is no final destination.

​ 3-3-4-6 . **IsMove**
<br><br>

##### 3-3-4-6 . **IsMove**

​ If this value is false, object doesn't move.

<br>

---

3-3-5 . Fill the blanks.
Expand All @@ -308,8 +346,12 @@ I once made a car that runs on a circular track I got from the Asset Store.

With a little modification, you can implement a car that moves naturally even the wheels and steering wheel.

<br>

---

<br>

#### 4-2 . Planet Movement

![figure17](https://github.com/KimYC1223/UnityPathGenerator/blob/master/ReadmeImage/figure17.gif?raw=true)
Expand All @@ -318,17 +360,19 @@ You can express movements between planets like the solar system.

This script also allows you to create circular paths and elliptical orbits like Comet Halley.

---
<br>

---

<br>

## 5 . QnA

#### 5-1 . My Git Blog

Thanks for read! check out [my blog](https://kimyc1223.github.io/) too !


<br>

#### 5-2 . Contact

Expand All @@ -337,6 +381,7 @@ Thanks for read! check out [my blog](https://kimyc1223.github.io/) too !
- [email protected]
- [email protected]

<br><br><br>


---
Expand All @@ -345,4 +390,4 @@ Thanks for read! check out [my blog](https://kimyc1223.github.io/) too !

**한국어 번역은 추후 추가 예정**

*Korean translation will be added later*
*Korean translation will be added later*

0 comments on commit c4a99a6

Please sign in to comment.