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

Allow exporting children of skipped nodes in glTF exporter #16017

Merged
merged 1 commit into from
Dec 19, 2024
Merged

Allow exporting children of skipped nodes in glTF exporter #16017

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
179 changes: 93 additions & 86 deletions packages/dev/serializers/src/glTF/2.0/glTFExporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -922,12 +922,7 @@ export class GLTFExporter {
this._exportBuffers(babylonRootNodes, state);

for (const babylonNode of babylonRootNodes) {
if (this._shouldExportNode(babylonNode)) {
const nodeIndex = await this._exportNodeAsync(babylonNode, state);
if (nodeIndex !== null) {
nodes.push(nodeIndex);
}
}
await this._exportNodeAsync(babylonNode, nodes, state);
}

return nodes;
Expand All @@ -940,11 +935,7 @@ export class GLTFExporter {
morphTargetsToMeshesMap: Map<MorphTarget, Mesh[]>,
state: ExporterState
): void {
if (!this._shouldExportNode(babylonNode)) {
return;
}

if (babylonNode instanceof Mesh && babylonNode.geometry) {
if (this._shouldExportNode(babylonNode) && babylonNode instanceof Mesh && babylonNode.geometry) {
const vertexBuffers = babylonNode.geometry.getVertexBuffers();
if (vertexBuffers) {
for (const kind in vertexBuffers) {
Expand Down Expand Up @@ -1175,13 +1166,94 @@ export class GLTFExporter {

/**
* Processes a node to be exported to the glTF file
* @returns A promise that resolves with the node index when the processing is complete, or null if the node should not be exported
* @returns A promise that resolves once the node has been exported
* @internal
*/
private async _exportNodeAsync(babylonNode: Node, state: ExporterState): Promise<Nullable<number>> {
private async _exportNodeAsync(babylonNode: Node, parentNodeChildren: Array<number>, state: ExporterState): Promise<void> {
let nodeIndex = this._nodeMap.get(babylonNode);
if (nodeIndex !== undefined) {
return nodeIndex;
if (!parentNodeChildren.includes(nodeIndex)) {
parentNodeChildren.push(nodeIndex);
}
return;
}

const node = await this._createNodeAsync(babylonNode, state);

if (node) {
nodeIndex = this._nodes.length;
this._nodes.push(node);
this._nodeMap.set(babylonNode, nodeIndex);
state.pushExportedNode(babylonNode);
parentNodeChildren.push(nodeIndex);

// Process node's animations once the node has been added to nodeMap (TODO: This should be refactored)
const runtimeGLTFAnimation: IAnimation = {
name: "runtime animations",
channels: [],
samplers: [],
};
const idleGLTFAnimations: IAnimation[] = [];

if (!this._babylonScene.animationGroups.length) {
_GLTFAnimation._CreateMorphTargetAnimationFromMorphTargetAnimations(
babylonNode,
runtimeGLTFAnimation,
idleGLTFAnimations,
this._nodeMap,
this._nodes,
this._dataWriter,
this._bufferViews,
this._accessors,
this._animationSampleRate,
state.convertToRightHanded,
this._options.shouldExportAnimation
);
if (babylonNode.animations.length) {
_GLTFAnimation._CreateNodeAnimationFromNodeAnimations(
babylonNode,
runtimeGLTFAnimation,
idleGLTFAnimations,
this._nodeMap,
this._nodes,
this._dataWriter,
this._bufferViews,
this._accessors,
this._animationSampleRate,
state.convertToRightHanded,
this._options.shouldExportAnimation
);
}
}

if (runtimeGLTFAnimation.channels.length && runtimeGLTFAnimation.samplers.length) {
this._animations.push(runtimeGLTFAnimation);
}
idleGLTFAnimations.forEach((idleGLTFAnimation) => {
if (idleGLTFAnimation.channels.length && idleGLTFAnimation.samplers.length) {
this._animations.push(idleGLTFAnimation);
}
});
}

// Begin processing child nodes once parent has been added to the node list
const children = node ? [] : parentNodeChildren;
for (const babylonChildNode of babylonNode.getChildren()) {
await this._exportNodeAsync(babylonChildNode, children, state);
}

if (node && children.length) {
node.children = children;
}
}

/**
* Creates a glTF node from a Babylon.js node. If skipped, returns null.
* @internal
*/
private async _createNodeAsync(babylonNode: Node, state: ExporterState): Promise<Nullable<INode>> {
if (!this._shouldExportNode(babylonNode)) {
return null;
}

const node: INode = {};
Expand Down Expand Up @@ -1232,88 +1304,23 @@ export class GLTFExporter {
this._nodesCameraMap.get(gltfCamera)?.push(parentNode);
return null; // Skip exporting this node
}
} else {
if (state.convertToRightHanded) {
ConvertToRightHandedNode(node);
RotateNode180Y(node);
}
this._nodesCameraMap.get(gltfCamera)?.push(node);
}
if (state.convertToRightHanded) {
ConvertToRightHandedNode(node);
RotateNode180Y(node);
}
this._nodesCameraMap.get(gltfCamera)?.push(node);
bghgary marked this conversation as resolved.
Show resolved Hide resolved
}
}

// Apply extensions to the node. If this resolves to null, it means we should skip exporting this node (NOTE: This will also skip its children)
// Apply extensions to the node. If this resolves to null, it means we should skip exporting this node
const processedNode = await this._extensionsPostExportNodeAsync("exportNodeAsync", node, babylonNode, this._nodeMap, state.convertToRightHanded);
if (!processedNode) {
Logger.Warn(`Not exporting node ${babylonNode.name}`);
return null;
}

nodeIndex = this._nodes.length;
this._nodes.push(node);
this._nodeMap.set(babylonNode, nodeIndex);
state.pushExportedNode(babylonNode);

// Process node's animations once the node has been added to nodeMap (TODO: This should be refactored)
const runtimeGLTFAnimation: IAnimation = {
name: "runtime animations",
channels: [],
samplers: [],
};
const idleGLTFAnimations: IAnimation[] = [];

if (!this._babylonScene.animationGroups.length) {
_GLTFAnimation._CreateMorphTargetAnimationFromMorphTargetAnimations(
babylonNode,
runtimeGLTFAnimation,
idleGLTFAnimations,
this._nodeMap,
this._nodes,
this._dataWriter,
this._bufferViews,
this._accessors,
this._animationSampleRate,
state.convertToRightHanded,
this._options.shouldExportAnimation
);
if (babylonNode.animations.length) {
_GLTFAnimation._CreateNodeAnimationFromNodeAnimations(
babylonNode,
runtimeGLTFAnimation,
idleGLTFAnimations,
this._nodeMap,
this._nodes,
this._dataWriter,
this._bufferViews,
this._accessors,
this._animationSampleRate,
state.convertToRightHanded,
this._options.shouldExportAnimation
);
}
}

if (runtimeGLTFAnimation.channels.length && runtimeGLTFAnimation.samplers.length) {
this._animations.push(runtimeGLTFAnimation);
}
idleGLTFAnimations.forEach((idleGLTFAnimation) => {
if (idleGLTFAnimation.channels.length && idleGLTFAnimation.samplers.length) {
this._animations.push(idleGLTFAnimation);
}
});

// Begin processing child nodes once parent has been added to the node list
for (const babylonChildNode of babylonNode.getChildren()) {
if (this._shouldExportNode(babylonChildNode)) {
const childNodeIndex = await this._exportNodeAsync(babylonChildNode, state);
if (childNodeIndex !== null) {
node.children ||= [];
node.children.push(childNodeIndex);
}
}
}

return nodeIndex;
return node;
}

private _exportIndices(
Expand Down
22 changes: 22 additions & 0 deletions packages/dev/serializers/test/integration/glTFSerializer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,5 +607,27 @@ describe("Babylon glTF Serializer", () => {
expect(node.rotation).toEqual(transformsRH.rotation);
});
});

it("should reparent children of unexported node to nearest ancestor", async () => {
const assertionData = await page.evaluate(async () => {
const parent = BABYLON.MeshBuilder.CreateBox("parent");
const child = BABYLON.MeshBuilder.CreateBox("child");
child.parent = parent;
BABYLON.MeshBuilder.CreateBox("grandchild1").parent = child;
BABYLON.MeshBuilder.CreateBox("grandchild2").parent = child;
const glTFData = await BABYLON.GLTF2Export.GLTFAsync(window.scene!, "test", {
shouldExportNode: (node) => node.name.startsWith("grandchild"),
});
const jsonString = glTFData.files["test.gltf"] as string;
return JSON.parse(jsonString);
});
expect(assertionData.nodes).toHaveLength(2);
expect(assertionData.nodes[0].name).toContain("grandchild");
expect(assertionData.nodes[1].name).toContain("grandchild");
expect(assertionData.scenes).toHaveLength(1);
expect(assertionData.scenes[0].nodes).toHaveLength(2);
expect(assertionData.scenes[0].nodes).toContain(0);
expect(assertionData.scenes[0].nodes).toContain(1);
});
});
});