|
1 | | -###### Structure |
| 1 | +###### Structure |
2 | 2 |
|
3 | 3 | # `CellNoise3D` |
4 | 4 | A type of three-dimensional cellular noise (sometimes called [Worley noise](https://en.wikipedia.org/wiki/Worley_noise), or Voronoi noise), suitable for texturing arbitrary three-dimensional objects. |
5 | 5 |
|
6 | 6 | Unlike many other cell noise implementations, *Noise*’s implementation samples all relevant generating-points, preventing artifacts or discontinuities from ever appearing in the noise. Accordingly, *Noise*’s implementation is heavily optimized to prevent the additional edge cases from impacting the performance of the cell noise. |
7 | 7 |
|
8 | | -Three dimensional cell noise is approximately three to four times slower than its [two-dimensional version](struct-CellNoise2D), but has a vastly superior visual appearance, even when sampled in two dimensions. |
| 8 | +Three dimensional cell noise is approximately three to four times slower than its [two-dimensional version](struct-CellNoise2D.md), but has a vastly superior visual appearance, even when sampled in two dimensions. |
9 | 9 |
|
10 | 10 | `CellNoise3D` is analogous to [Blender Voronoi noise](https://docs.blender.org/manual/en/dev/render/cycles/nodes/types/textures/voronoi.html), with the *Distance Squared* metric. The *Scale* of Blender Voronoi noise is identical to the `frequency` of `CellNoise3D`; its range is approximately `0 ... 10/3` in `CellNoise3D` units. |
11 | 11 |
|
12 | | - |
13 | | -*** |
| 12 | + |
| 13 | +*** |
14 | 14 |
|
15 | | -## Symbols |
| 15 | +## Symbols |
16 | 16 |
|
17 | 17 | ### Initializers |
18 | 18 |
|
19 | | -#### [`init`](protocol-Noise#initamplitudedouble-frequencydouble-seedint)`(amplitude:Double, frequency:Double, seed:Int = 0)` |
| 19 | +#### [`init`](protocol-Noise.md#initamplitudedouble-frequencydouble-seedint)`(amplitude:Double, frequency:Double, seed:Int = 0)` |
20 | 20 | > Creates an instance with the given `amplitude`, `frequency`, and random `seed` values. Creating an instance generates a new pseudo-random permutation table for that instance, and a new instance does not need to be regenerated to sample the same procedural noise field. |
21 | 21 |
|
22 | 22 | > The given amplitude is adjusted internally to produce output *exactly* within the range of `0 ... amplitude`. However, in practice the cell noise rarely reaches the maximum threshold, as it is often useful to inflate the amplitude to get the desired appearance. |
23 | 23 |
|
24 | | -### Instance methods |
| 24 | +### Instance methods |
25 | 25 |
|
26 | 26 | #### `func` `closest_point(_ x:Double, _ y:Double, _ z:Double) -> (point:(Int, Int, Int), r2:Double)` |
27 | 27 | > Returns the index numbers of the closest feature point to the given coordinate, and the squared distance from the given coordinate to the feature point. These index numbers can be fed to a color hashing function to produce a [Voronoi diagram](https://en.wikipedia.org/wiki/Voronoi_diagram). |
28 | 28 |
|
29 | | -#### `func` [`evaluate`](protocol-Noise#func-evaluate_-xdouble-_-ydouble---double)`(_ x:Double, _ y:Double) -> Double` |
| 29 | +#### `func` [`evaluate`](protocol-Noise.md#func-evaluate_-xdouble-_-ydouble---double)`(_ x:Double, _ y:Double) -> Double` |
30 | 30 | > Evaluates the cell noise field at the given `x, y` coordinates, supplying `0` for the missing `z` coordinate. |
31 | 31 |
|
32 | | -#### `func` [`evaluate`](protocol-Noise#func-evaluate_-xdouble-_-ydouble-_-zdouble---double)`(_ x:Double, _ y:Double, _ z:Double) -> Double` |
| 32 | +#### `func` [`evaluate`](protocol-Noise.md#func-evaluate_-xdouble-_-ydouble-_-zdouble---double)`(_ x:Double, _ y:Double, _ z:Double) -> Double` |
33 | 33 | > Evaluates the cell noise field at the given coordinates. |
34 | 34 |
|
35 | | -#### `func` [`evaluate`](protocol-Noise#func-evaluate_-xdouble-_-ydouble-_-zdouble-_-wdouble---double)`(_ x:Double, _ y:Double, _ z:Double, _:Double) -> Double` |
| 35 | +#### `func` [`evaluate`](protocol-Noise.md#func-evaluate_-xdouble-_-ydouble-_-zdouble-_-wdouble---double)`(_ x:Double, _ y:Double, _ z:Double, _:Double) -> Double` |
36 | 36 | > Evaluates the cell noise field at the given coordinates. The fourth coordinate is ignored. |
37 | 37 |
|
38 | | -#### `func` [`sample_area`](protocol-Noise#func-sample_areawidthint-heightint---double-double-double)`(width:Int, height:Int) -> [(Double, Double, Double)]` |
| 38 | +#### `func` [`sample_area`](protocol-Noise.md#func-sample_areawidthint-heightint---double-double-double)`(width:Int, height:Int) -> [(Double, Double, Double)]` |
39 | 39 | > Evaluates the noise field over the given area, starting from the origin, and extending over the first quadrant, taking unit steps in both directions. Although the `x` and `y` coordinates are returned, the output vector is guaranteed to be in row-major order. |
40 | 40 |
|
41 | | -#### `func` [`sample_area_saturated_to_u8`](protocol-Noise#func-sample_area_saturated_to_u8widthint-heightint-offsetdouble--05---uint8)`(width:Int, height:Int, offset:Double = 0.5) -> [UInt8]` |
| 41 | +#### `func` [`sample_area_saturated_to_u8`](protocol-Noise.md#func-sample_area_saturated_to_u8widthint-heightint-offsetdouble--05---uint8)`(width:Int, height:Int, offset:Double = 0.5) -> [UInt8]` |
42 | 42 | > Evaluates the noise field over the given area, starting from the origin, and extending over the first quadrant, storing the values in a row-major array of samples. The samples are clamped, but not scaled, to the range `0 ... 255`. |
43 | 43 |
|
44 | | -#### `func` [`sample_volume`](protocol-Noise#func-sample_volumewidthint-heightint-depthint---double-double-double-double)`(width:Int, height:Int, depth:Int) -> [(Double, Double, Double, Double)]` |
| 44 | +#### `func` [`sample_volume`](protocol-Noise.md#func-sample_volumewidthint-heightint-depthint---double-double-double-double)`(width:Int, height:Int, depth:Int) -> [(Double, Double, Double, Double)]` |
45 | 45 | > Evaluates the noise field over the given volume, starting from the origin, and extending over the first octant, taking unit steps in all three directions. Although the `x`, `y`, and `z` coordinates are returned, the output vector is guaranteed to be in `xy`-plane-major, and then row-major order. |
46 | 46 |
|
47 | | -#### `func` [`sample_volume_saturated_to_u8`](protocol-Noise#func-sample_volume_saturated_to_u8widthint-heightint-depthint-offsetdouble--05---uint8)`(width:Int, height:Int, depth:Int, offset:Double = 0.5) -> [UInt8]` |
| 47 | +#### `func` [`sample_volume_saturated_to_u8`](protocol-Noise.md#func-sample_volume_saturated_to_u8widthint-heightint-depthint-offsetdouble--05---uint8)`(width:Int, height:Int, depth:Int, offset:Double = 0.5) -> [UInt8]` |
48 | 48 | > Evaluates the noise field over the given volume, starting from the origin, and extending over the first octant, storing the values in a `xy`-plane-major, and then row-major order array of samples. The samples are clamped, but not scaled, to the range `0 ... 255`. |
49 | 49 |
|
50 | | -## Relationships |
| 50 | +## Relationships |
51 | 51 |
|
52 | 52 | ### Conforms to |
53 | 53 |
|
54 | | -#### [`Noise`](protocol-Noise) |
| 54 | +#### [`Noise`](protocol-Noise.md) |
0 commit comments