UNPKG

forge-svf-utils

Version:

Utilities for working with Autodesk Forge SVF file format.

400 lines 22 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>IMaterial | forge-svf-utils</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">forge-svf-utils</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/_svf_schema_.html">&quot;svf/schema&quot;</a> </li> <li> <a href="_svf_schema_.imaterial.html">IMaterial</a> </li> </ul> <h1>Interface IMaterial</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">IMaterial</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_svf_schema_.imaterial.html#ambient" class="tsd-kind-icon">ambient</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_svf_schema_.imaterial.html#diffuse" class="tsd-kind-icon">diffuse</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_svf_schema_.imaterial.html#emissive" class="tsd-kind-icon">emissive</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_svf_schema_.imaterial.html#glossiness" class="tsd-kind-icon">glossiness</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_svf_schema_.imaterial.html#maps" class="tsd-kind-icon">maps</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_svf_schema_.imaterial.html#metal" class="tsd-kind-icon">metal</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_svf_schema_.imaterial.html#opacity" class="tsd-kind-icon">opacity</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_svf_schema_.imaterial.html#reflectivity" class="tsd-kind-icon">reflectivity</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_svf_schema_.imaterial.html#specular" class="tsd-kind-icon">specular</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="ambient" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> ambient</h3> <div class="tsd-signature tsd-kind-icon">ambient<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/schema.ts#L108">svf/schema.ts:108</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="diffuse" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> diffuse</h3> <div class="tsd-signature tsd-kind-icon">diffuse<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/schema.ts#L106">svf/schema.ts:106</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="emissive" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> emissive</h3> <div class="tsd-signature tsd-kind-icon">emissive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/schema.ts#L109">svf/schema.ts:109</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="glossiness" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> glossiness</h3> <div class="tsd-signature tsd-kind-icon">glossiness<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/schema.ts#L110">svf/schema.ts:110</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="maps" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> maps</h3> <div class="tsd-signature tsd-kind-icon">maps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/schema.ts#L114">svf/schema.ts:114</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="metal" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> metal</h3> <div class="tsd-signature tsd-kind-icon">metal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/schema.ts#L113">svf/schema.ts:113</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="opacity" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> opacity</h3> <div class="tsd-signature tsd-kind-icon">opacity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/schema.ts#L112">svf/schema.ts:112</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="reflectivity" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> reflectivity</h3> <div class="tsd-signature tsd-kind-icon">reflectivity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/schema.ts#L111">svf/schema.ts:111</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="specular" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> specular</h3> <div class="tsd-signature tsd-kind-icon">specular<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/schema.ts#L107">svf/schema.ts:107</a></li> </ul> </aside> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_gltf_writer_.html">"gltf/writer"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_index_.html">"index"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_svf_fragments_.html">"svf/fragments"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_svf_geometries_.html">"svf/geometries"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_svf_input_stream_.html">"svf/input-<wbr>stream"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_svf_materials_.html">"svf/materials"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_svf_meshes_.html">"svf/meshes"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_svf_packfile_reader_.html">"svf/packfile-<wbr>reader"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_svf_propdb_reader_.html">"svf/propdb-<wbr>reader"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_svf_reader_.html">"svf/reader"</a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_svf_schema_.html">"svf/schema"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-enum tsd-parent-kind-external-module"> <a href="../enums/_svf_schema_.assettype.html" class="tsd-kind-icon">Asset<wbr>Type</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.ifragment.html" class="tsd-kind-icon">IFragment</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.igeometrymetadata.html" class="tsd-kind-icon">IGeometry<wbr>Metadata</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.ilines.html" class="tsd-kind-icon">ILines</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.imaterial.html" class="tsd-kind-icon">IMaterial</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_svf_schema_.imaterial.html#ambient" class="tsd-kind-icon">ambient</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_svf_schema_.imaterial.html#diffuse" class="tsd-kind-icon">diffuse</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_svf_schema_.imaterial.html#emissive" class="tsd-kind-icon">emissive</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_svf_schema_.imaterial.html#glossiness" class="tsd-kind-icon">glossiness</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_svf_schema_.imaterial.html#maps" class="tsd-kind-icon">maps</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_svf_schema_.imaterial.html#metal" class="tsd-kind-icon">metal</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_svf_schema_.imaterial.html#opacity" class="tsd-kind-icon">opacity</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_svf_schema_.imaterial.html#reflectivity" class="tsd-kind-icon">reflectivity</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_svf_schema_.imaterial.html#specular" class="tsd-kind-icon">specular</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.imaterialmap.html" class="tsd-kind-icon">IMaterial<wbr>Map</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.imesh.html" class="tsd-kind-icon">IMesh</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.ipoints.html" class="tsd-kind-icon">IPoints</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.iquaternion.html" class="tsd-kind-icon">IQuaternion</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.isvfmanifest.html" class="tsd-kind-icon">ISvf<wbr>Manifest</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.isvfmanifestasset.html" class="tsd-kind-icon">ISvf<wbr>Manifest<wbr>Asset</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.isvfmanifesttype.html" class="tsd-kind-icon">ISvf<wbr>Manifest<wbr>Type</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.isvfmanifesttypeset.html" class="tsd-kind-icon">ISvf<wbr>Manifest<wbr>Type<wbr>Set</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.isvfmetadata.html" class="tsd-kind-icon">ISvf<wbr>Metadata</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.isvfroot.html" class="tsd-kind-icon">ISvf<wbr>Root</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.iuvmap.html" class="tsd-kind-icon">IUVMap</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_svf_schema_.ivector3.html" class="tsd-kind-icon">IVector3</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_svf_schema_.html#matrix3x3" class="tsd-kind-icon">Matrix3x3</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_svf_schema_.html#transform" class="tsd-kind-icon">Transform</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>