model-viewer-module/src/features/scene-graph/texture.ts

Easily display interactive 3D models on the web and in AR!

/* @license
 * Copyright 2020 Google LLC. All Rights Reserved.
 * Licensed under the Apache License, Version 2.0 (the 'License');
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an 'AS IS' BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {Texture as ThreeTexture} from 'three';

import {Image as GLTFImage, Sampler as GLTFSampler, Texture as GLTFTexture} from '../../three-components/gltf-instance/gltf-2.0.js';

import {Texture as TextureInterface} from './api.js';
import {Image} from './image.js';
import {Sampler} from './sampler.js';
import {$sourceObject, ThreeDOMElement} from './three-dom-element.js';



const $image = Symbol('image');
const $sampler = Symbol('sampler');

/**
 * Material facade implementation for Three.js materials
 */
export class Texture extends ThreeDOMElement implements TextureInterface {
  private[$image]: Image;
  private[$sampler]: Sampler;

  constructor(
      onUpdate: () => void,
      threeTexture: ThreeTexture|null,
      gltfTexture: GLTFTexture|null = null,
      gltfSampler: GLTFSampler|null = null,
      gltfImage: GLTFImage|null = null,
  ) {
    super(
        onUpdate,
        gltfTexture ? gltfTexture : {} as GLTFTexture,
        new Set<ThreeTexture>(threeTexture ? [threeTexture] : []));

    this[$sampler] = new Sampler(onUpdate, threeTexture, gltfSampler);
    this[$image] = new Image(onUpdate, threeTexture, gltfImage);
  }

  get name(): string {
    return (this[$sourceObject] as any).name || '';
  }

  set name(name: string) {
    (this[$sourceObject] as any).name = name;
  }

  get sampler(): Sampler {
    return this[$sampler];
  }

  get source(): Image {
    return this[$image];
  }
}