Mesh

Meshes define reusable geometry (triangles, lines, or points) and are instantiated by Nodes.

Each draw call required to render a mesh is represented as a Primitive. Meshes typically have only a single Primitive, but may have more for various reasons. A mesh manages only a list of primitives — materials, morph targets, and other properties are managed on a per- primitive basis.

When the same geometry and material should be rendered at multiple places in the scene, reuse the same Mesh instance and attach it to multiple nodes for better efficiency. Where the geometry is shared but the material is not, reusing Accessors under different meshes and primitives can similarly improve transmission efficiency, although some rendering efficiency is lost as the number of materials in a scene increases.

Usage:

const primitive = doc.createPrimitive()
    .setAttribute('POSITION', positionAccessor)
    .setAttribute('TEXCOORD_0', uvAccessor);
const mesh = doc.createMesh('myMesh')
    .addPrimitive(primitive);
node.setMesh(mesh);

References:

Hierarchy

Properties

propertyType: PropertyType.MESH

Methods

  • dispatchEvent(event: BaseEvent): this

  • Dispatches an event on the GraphNode, and on the associated Graph. Event types on the graph are prefixed, "node:[type]".

  • dispose(): void

  • Removes both inbound references to and outbound references from this object. At the end of the process the object holds no references, and nothing holds references to it. A disposed object is not reusable.

  • equals(other: Property, skip?: Set<string>): boolean

  • Returns true if two properties are deeply equivalent, recursively comparing the attributes of the properties. Optionally, a 'skip' set may be included, specifying attributes whose values should not be considered in the comparison.

    Example: Two Primitives are equivalent if they have accessors and materials with equivalent content — but not necessarily the same specific accessors and materials.

  • addEventListener(type: string, listener: EventListener<T>): this
  • removeEventListener(type: string, listener: EventListener<T>): this
  • getExtension(name: string): Prop | null
  • listExtensions(): ExtensionProperty[]
  • getExtras(): Record<string, unknown>

  • Returns a reference to the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

  • setExtras(extras: Record<string, unknown>): Property

  • Updates the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

  • isDisposed(): boolean

  • Returns true if the node has been permanently removed from the graph.

  • getName(): string

  • Returns the name of this property. While names are not required to be unique, this is encouraged, and non-unique names will be overwritten in some tools. For custom data about a property, prefer to use Extras.

  • Sets the name of this property. While names are not required to be unique, this is encouraged, and non-unique names will be overwritten in some tools. For custom data about a property, prefer to use Extras.

  • listParents(): Property[]

  • Returns a list of all properties that hold a reference to this property. For example, a material may hold references to various textures, but a texture does not hold references to the materials that use it.

    It is often necessary to filter the results for a particular type: some resources, like Accessors, may be referenced by different types of properties. Most properties include the Root as a parent, which is usually not of interest.

    Usage:

    const materials = texture
    .listParents()
    .filter((p) => p instanceof Material)
  • listPrimitives(): Primitive[]
  • getWeights(): number[]
  • setWeights(weights: number[]): Mesh
Function symbol, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy. Documentation built with greendoc and published under Creative Commons Attribution 3.0.