Skip to content

InstancedMesh, BatchedMesh docs: clarify lack of negatively scaled matrix support #1513

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

Merged
merged 1 commit into from
Jan 26, 2025
Merged

InstancedMesh, BatchedMesh docs: clarify lack of negatively scaled matrix support #1513

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
1 change: 1 addition & 0 deletions types/three/src/objects/BatchedMesh.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ declare class BatchedMesh extends Mesh<BufferGeometry, Material> {

/**
* Sets the given local transformation matrix to the defined instance.
* Negatively scaled matrices are not supported.
* @param instanceId The id of an instance to set the matrix of.
* @param matrix A 4x4 matrix representing the local transformation of a single instance.
*/
Expand Down
7 changes: 4 additions & 3 deletions types/three/src/objects/InstancedMesh.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,10 @@ export class InstancedMesh<
getMorphAt(index: number, mesh: Mesh): void;

/**
* Sets the given local transformation matrix to the defined instance.
* @remarks
* Make sure you set {@link InstancedBufferAttribute.needsUpdate | .instanceMatrix.needsUpdate()} flag to `true` after updating all the matrices.
* Sets the given local transformation matrix to the defined instance. Make sure you set
* {@link InstancedBufferAttribute.needsUpdate | .instanceMatrix.needsUpdate()} flag to `true` after updating all
* the matrices.
* Negatively scaled matrices are not supported.
* @param index The index of an instance. Values have to be in the range `[0, count]`. Expects a `Integer`
* @param matrix A 4x4 matrix representing the local transformation of a single instance.
*/
Expand Down
Loading