Browse Source

Add function comments

Michael Bond 5 years ago
parent
commit
1c2b11ecfa
2 changed files with 10 additions and 1 deletions
  1. 9 0
      loaders/src/glTF/2.0/Extensions/KHR_materials_variants.ts
  2. 1 1
      package.json

+ 9 - 0
loaders/src/glTF/2.0/Extensions/KHR_materials_variants.ts

@@ -60,10 +60,16 @@ export class KHR_materials_variants implements IGLTFLoaderExtension {
         delete this._loader;
         delete this._loader;
     }
     }
 
 
+    /**
+     * Return a list of available variants for this asset.
+     */
     public getVariants(): string[] {
     public getVariants(): string[] {
         return Object.keys(this._tagsToMap);
         return Object.keys(this._tagsToMap);
     }
     }
 
 
+    /**
+     * Select a variant by providing a list of variant tag names.
+     */
     public selectVariant(variantName: string | string[]) {
     public selectVariant(variantName: string | string[]) {
         if (variantName instanceof Array) {
         if (variantName instanceof Array) {
             variantName.forEach((name) => this.selectVariantTag(name));
             variantName.forEach((name) => this.selectVariantTag(name));
@@ -72,6 +78,9 @@ export class KHR_materials_variants implements IGLTFLoaderExtension {
         }
         }
     }
     }
 
 
+    /**
+     * Select a variant by providing a single variant tag.
+     */
     public selectVariantTag(variantName: string) {
     public selectVariantTag(variantName: string) {
         // If the name is valid, switch all meshes to use materials defined by the tags
         // If the name is valid, switch all meshes to use materials defined by the tags
         const variantMappings = this._tagsToMap[variantName];
         const variantMappings = this._tagsToMap[variantName];

+ 1 - 1
package.json

@@ -110,4 +110,4 @@
         "xhr2": "^0.1.4",
         "xhr2": "^0.1.4",
         "xmlbuilder": "8.2.2"
         "xmlbuilder": "8.2.2"
     }
     }
-}
+}