Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): transformation guide fixes #249

Merged
merged 1 commit into from
Jul 23, 2024
Merged

chore(docs): transformation guide fixes #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/docs/guides/SKYBOX.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ be filled with the skybox. The Skybox can be rendered from either:
```tsx
import { Skybox } from 'react-native-filament';

<Skybox color="#00ff00" />
<Skybox colorInHex="#00ff00" />
```

### 🏞️ A [cubemap texture](https://learnopengl.com/img/advanced/cubemaps_skybox.png)
Expand All @@ -28,7 +28,7 @@ function Scene() {

return (
<FilamentView>
<Skybox texture={cubemap} />
<Skybox source={cubemap} />
</FilamentView>
)
}
18 changes: 9 additions & 9 deletions docs/docs/guides/TRANSFORMATION.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const rotationInDegree = 45;
const angleInRadians = rotationInDegree * (Math.PI / 180);
const rotateOnAxis = [0, angleInRadians, 0]; // Rotate on the y-axis

<Model rotation={rotateOnAxis} />
<Model rotate={rotateOnAxis} />
```

The `rotation` props expects a 3D vector (called `Float3` in RNF), where each value represents the rotation in radians around the x, y and z axis respectively.
Expand Down Expand Up @@ -93,7 +93,7 @@ When matrix multiplication is **enabled (default)** all transform operations wil

## Animate the transform props

You may want to change the transformation props very frequently (e.g. every frame). To avoid performance issues, you should **not** update the props uusing `useState` directly, but use shared values.
You may want to change the transformation props very frequently (e.g. every frame). To avoid performance issues, you should **not** update the props using `useState` directly, but use shared values.

You may know shared values from `reanimated`. We are using the shared values from `react-native-worklets-core`, but they work very similary.

Expand All @@ -114,9 +114,9 @@ You can pass a shared value to any of the transformation props:

```tsx
function MyScene() {
const rotation = useSharedValue([0, 0, 0]);
const rotation = useSharedValue<Float3>([0, 0, 0]);

return <Model rotation={rotation} />
return <Model rotate={rotation} />
}
```

Expand All @@ -125,10 +125,10 @@ Now, lets update the rotation value every frame:
```tsx
import { useCallback } from 'react'
import { useSharedValue } from "react-native-worklets-core"
import { RenderCallback, FilamentView, Model } from "react-native-filament"
import { RenderCallback, FilamentView, Model, Float3 } from "react-native-filament"

function MyScene() {
const rotation = useSharedValue([0, 0, 0]);
const rotation = useSharedValue<Float3>([0, 0, 0]);

const renderCallback: RenderCallback = useCallback(() => {
"worklet"
Expand All @@ -142,7 +142,7 @@ function MyScene() {

return (
<FilamentView renderCallback={renderCallback}>
<Model rotation={rotation} />
<Model rotate={rotation} />
</FilamentView>
)
}
Expand Down Expand Up @@ -193,7 +193,7 @@ function MyScene() {

// We get the transformManager for the filament context.
// For this to work <MyScene /> needs to be wrapped with a <FilamentScene>
const { transformManager } = useFilamentConext()
const { transformManager } = useFilamentContext()

const renderCallback: RenderCallback = useCallback(() => {
"worklet"
Expand All @@ -204,7 +204,7 @@ function MyScene() {
// Add a rotation of 1 degree every frame on the y-axis and
// multiply it with the current transform by setting `true` as last argument
transformManager.setEntityRotation(rootEntity, 0.01, [0, 1, 0], true)
}, [])
}, [rootEntity, transformManager])
}
```

Expand Down