Tutorial and changed names #57

2021-08-05T16:50:37+03:00

kiruma524 commented

2021-08-05 16:50:37 +03:00

(Migrated from github.com)

No description provided.

CommanderTvis (Migrated from github.com) reviewed 2021-08-06 03:10:29 +03:00

docs/tutorial.md

CommanderTvis (Migrated from github.com) commented

2021-08-06 02:59:20 +03:00

Use — (—) instead of -.

Use `—` (—) instead of ` - `.

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:00:12 +03:00

hexagon(
    Point3D(5, 30, 5),
    Point3D(24, 30, 8),
    Point3D(20, 30, -10),
    Point3D(5, 30, -7),
    Point3D(8, 16, 0),
    Point3D(12, 16, 0),
    Point3D(10, 16, -5),
    Point3D(6.5, 12, -3),
    name = "custom_hexagon"
) {
    color("brown")
}

```suggestion hexagon( Point3D(5, 30, 5), Point3D(24, 30, 8), Point3D(20, 30, -10), Point3D(5, 30, -7), Point3D(8, 16, 0), Point3D(12, 16, 0), Point3D(10, 16, -5), Point3D(6.5, 12, -3), name = "custom_hexagon" ) { color("brown") } ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:01:28 +03:00

It's scarcely a solid, but it can be visualized, so we mention it.

```suggestion It's scarcely a solid, but it can be visualized, so we mention it. ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:04:12 +03:00

* `shape` is a value of `List<Point2D>` type. It's just a list of all points of the solid. *`shape` has to consist of not less than two points!*

```suggestion * `shape` is a value of `List<Point2D>` type. It's just a list of all points of the solid. *`shape` has to consist of not less than two points!* ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:05:12 +03:00

#### The main goal of this tutorial is to show the main capabilities of the visualization instrument.

```suggestion #### The main goal of this tutorial is to show the main capabilities of the visualization instrument. ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:05:32 +03:00

3. `rotation` - it's the point, which sets rotations along axes. Initially, the value is `Point3D(0, 0, 0)`. Changing `x` coordinate of the point, you make pivot around `x axis`. The same for other coordinates: changing `y` - pivot around `y axis`, changing `z` - pivot around `z axis`.

```suggestion 3. `rotation` - it's the point, which sets rotations along axes. Initially, the value is `Point3D(0, 0, 0)`. Changing `x` coordinate of the point, you make pivot around `x axis`. The same for other coordinates: changing `y` - pivot around `y axis`, changing `z` - pivot around `z axis`. ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:06:07 +03:00

***There is plenty of other properties, especially those, which you can create by yourself. Here we mention just a small part.***

```suggestion ***There is plenty of other properties, especially those, which you can create by yourself. Here we mention just a small part.*** ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:06:43 +03:00

* `name` is an identifier of *any solid*; but in this case, it is an identifier of `polyline`.

```suggestion * `name` is an identifier of *any solid*; but in this case, it is an identifier of `polyline`. ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:07:30 +03:00

As you can see, only the rib of `y-axis` differs from other ribs.

```suggestion As you can see, only the rib of `y-axis` differs from other ribs. ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:07:53 +03:00

For a final trial, let's create a `box` with a bigger `x` value.

```suggestion For a final trial, let's create a `box` with a bigger `x` value. ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:08:26 +03:00

Predictably, only the `x-axis` rib is bigger than other ribs.

```suggestion Predictably, only the `x-axis` rib is bigger than other ribs. ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:08:50 +03:00

As for `radius`, it has `Float` type, and, as you can guess, it sets the radius of the sphere which will be created.

```suggestion As for `radius`, it has `Float` type, and, as you can guess, it sets the radius of the sphere which will be created. ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:09:17 +03:00

As the hexagon takes in specific points, we understand that this solid cannot be moved, it is fixed in space, and it can't make pivots.

```suggestion As the hexagon takes in specific points, we understand that this solid cannot be moved, it is fixed in space, and it can't make pivots. ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:09:43 +03:00

Obviously, `bottomRadius` is responsible for the radius of a bottom base, and `height` sets the height of a cone along the `z-axis`.

```suggestion Obviously, `bottomRadius` is responsible for the radius of a bottom base, and `height` sets the height of a cone along the `z-axis`. ```

CommanderTvis (Migrated from github.com) commented

2021-08-06 03:10:14 +03:00

* `layer` is `MutableList` types variable. (here is a sentence with a description of the work of this function). *The amount of `layer`-s has to be more than one*

```suggestion * `layer` is `MutableList` types variable. (here is a sentence with a description of the work of this function). *The amount of `layer`-s has to be more than one* ```