Implement a renaming transform function?

[rosskevin]

Please forgive my newness to this general space.

If I wanted to implement a renaming transform function, is this a good place to do it? I'd like to allow our CAD designers to continue with their own convention, but implement some custom patterns (followed by a generic camel case fn) on the document before generating tsx.

e.g.

 <group name="14ga_A3_baseFrame_RearLogoPlate_MotionBoxMount_MKIII_v11" />

The same with materials. Our model is large, and the generated tsx could be significantly more readable with same simple name manipulation.

Is a custom @gltf-transform/functions the right thing to do? Is there something already written in that neighborhood that I could use as inspiration? Ultimately I would like to plug this into the gltfTransform call in an API usage scenario of https://github.com/rosskevin/gltfjsx

Thank you for any advice!

[donmccurdy]

Hi @rosskevin! It should be no problem to rename nodes, materials, and meshes in glTF Transform, yes. The code could be written as a transform, or not, no meaningful difference except the syntax. I usually define an operation as a transform if it operates on the entire document and if its configuration can be described well by a single options declaration. For example, joinPrimitives(prims) is a function that merges a given list of Primitives, and join() is a transform that uses joinPrimitives to combine all compatible primitives throughout the document.

Example:

// function
function renameProperties(properties: Property[], prefix: string) {
  properties.forEach((property, index) => {
    property.setName(`${prefix}_${index}`);
  });
}

// transform
function rename(options) {
 return async (document) => {
   renameProperties(document.listNodes(), 'node');
   renameProperties(document.listMaterials(), 'material');
 };
}

const document = await io.read('path/to/scene.glb');
await document.transform(rename());
await io.write('path/to/output.glb', document);

The transform is just syntax, this would have worked as well:

const document = await io.read('path/to/scene.glb');
renameProperties(document.listNodes(), 'node');
renameProperties(document.listMaterials(), 'material');
await io.write('path/to/output.glb', document);