Skip to content

Commit 1911c7e

Browse files
authored
docs: fix/improve docs
1 parent 5cb3069 commit 1911c7e

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

documents/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ interface Store {
2121
get: <T>(dataType: string, key: KeyType) => Promise<T | null>
2222
set: <T>(dataType: string, key: KeyType, value: T) => Promise<boolean>
2323
all: <T>(dataType: string) => Promise<T[] | null>
24-
query: <T>(dataType: string, queryString: string) => Promise<T[]>
24+
query: <T>(dataType: string, query: Partial<T>) => Promise<T[]>
2525
}
2626
```
2727

@@ -52,7 +52,7 @@ Some examples:
5252

5353
Provides a factory for processing/generating data required in the render loop. This is typically geometry data which it builds based on simple arguments passed by a component depeneding on the generator (such as an id, radius, scale and other option values). The generator code will typically access the store itself to retrieve the data it needs from the data provider.
5454

55-
The components available in this library already have generator functions created that expects certain data sets to be accessable from the store. These can be imported from `videx-3d/generators`.
55+
The components available in this library already have generator functions created that expects certain data sets to be available from the store. These can be imported from `videx-3d/generators`.
5656

5757
Generator functions are registered in the `GeneratorRegistry` by adding them to the instance along with a key:
5858

documents/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ Let's start by adding the package to our project:
266266
### Example using the tube geometry
267267
We will start simple, and experiment with the `createTubeGeometry` function from the SDK. This is a very flexible procedure for generating tube shapes. It is based on the implementation of the `TubeGeometry` from Thee.js, but heavily adapted to the needs of this library as you will see.
268268

269-
A tube is basically a curve with dimensions, and to define a smooth curve from a set of points we need to interpolate. The SDK includes a function `getSplineCurve`, which takes a set of 3d coordinates and returns an interpolator as defined by the `Curve3D` interface. Our implementation is using the [curve-interpolator](https://github.com/kjerandp/curve-interpolator) library, which is set up to interpolate a chordal cubic Hermite spline curve. You can use your own interpolation implementation as long as it implements the `Curve3D` interface.
269+
A tube is basically a curve with dimensions, and to define a smooth curve from a set of points we need to interpolate. The SDK (Software Developement Kit: `videx-3d/sdk`) includes a function `getSplineCurve`, which takes a set of 3d coordinates and returns an interpolator as defined by the `Curve3D` interface. Our implementation is using the [curve-interpolator](https://github.com/kjerandp/curve-interpolator) library, which is set up to interpolate a chordal cubic Hermite spline curve. You can use your own interpolation implementation as long as it implements the `Curve3D` interface.
270270

271271
In this example we will create a new component, which will generate a tube geometry and render it using the standard material from Three.js. Let's create a new file and component `Tube.tsx`:
272272

0 commit comments

Comments
 (0)