lume
Version:
57 lines • 1.71 kB
TypeScript
import { type ElementAttributes } from '@lume/element';
import { Element3D, type Element3DAttributes } from '../core/Element3D.js';
import type { ElementWithBehaviors } from '../behaviors/ElementWithBehaviors.js';
import type { ObjModelBehavior, ObjModelBehaviorAttributes } from '../behaviors/index.js';
export type ObjModelAttributes = Element3DAttributes | ObjModelBehaviorAttributes;
/**
* @element lume-obj-model
* @class ObjModel -
*
* Defines the `<lume-obj-model>` element, short for `<lume-element3d
* has="obj-model">`, for loading 3D models in the OBJ format (`.obj` files
* paired with `.mtl` files).
*
* HTML Example:
*
* ```html
* <lume-scene>
* <lume-obj-model id="myModel" obj="path/to/model.obj" mtl="path/to/model.mtl"></lume-obj-model>
* </lume-scene>
* <script>
* myModel.on('MODEL_LOAD', () => console.log('loaded'))
* </script>
* ```
*
* JavaScript Example:
*
* ```js
* const scene = new Scene
* scene.webgl = true
* document.body.append(scene)
* const model = new ObjModel
* model.obj = 'path/to/model.obj'
* model.mtl = 'path/to/model.mtl'
* model.on('MODEL_LOAD', () => console.log('loaded'))
* scene.add(model)
* ```
*/
export declare class ObjModel extends Element3D {
initialBehaviors: {
model: string;
};
}
export interface ObjModel extends ElementWithBehaviors<ObjModelBehavior, ObjModelBehaviorAttributes> {
}
declare module 'solid-js' {
namespace JSX {
interface IntrinsicElements {
'lume-obj-model': ElementAttributes<ObjModel, ObjModelAttributes>;
}
}
}
declare global {
interface HTMLElementTagNameMap {
'lume-obj-model': ObjModel;
}
}
//# sourceMappingURL=ObjModel.d.ts.map