forge-svf-utils

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"svf/materials" | 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="_svf_materials_.html">"svf/materials"</a> </li> </ul> <h1>External module "svf/materials"</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <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 tsd-is-not-exported"> <h3>Modules</h3> <ul class="tsd-index-list"> <li class="tsd-kind-module tsd-parent-kind-external-module tsd-is-not-exported"><a href="_svf_materials_.svfinternal.html" class="tsd-kind-icon">Svf<wbr>Internal</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_svf_materials_.html#parsebooleanproperty" class="tsd-kind-icon">parse<wbr>Boolean<wbr>Property</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_svf_materials_.html#parsecolorproperty" class="tsd-kind-icon">parse<wbr>Color<wbr>Property</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_svf_materials_.html#parsematerials" class="tsd-kind-icon">parse<wbr>Materials</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_svf_materials_.html#parsescalarproperty" class="tsd-kind-icon">parse<wbr>Scalar<wbr>Property</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_svf_materials_.html#parsesimplephongmaterial" class="tsd-kind-icon">parse<wbr>Simple<wbr>Phong<wbr>Material</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_svf_materials_.html#parsetextureproperty" class="tsd-kind-icon">parse<wbr>Texture<wbr>Property</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="parsebooleanproperty" class="tsd-anchor"></a> <h3>parse<wbr>Boolean<wbr>Property</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">parse<wbr>Boolean<wbr>Property<span class="tsd-signature-symbol">(</span>material<span class="tsd-signature-symbol">: </span><a href="../interfaces/_svf_materials_.svfinternal.imaterial.html" class="tsd-signature-type">IMaterial</a>, prop<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, defaultValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/materials.ts#L111">svf/materials.ts:111</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>material: <a href="../interfaces/_svf_materials_.svfinternal.imaterial.html" class="tsd-signature-type">IMaterial</a></h5> </li> <li> <h5>prop: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>defaultValue: <span class="tsd-signature-type">boolean</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="parsecolorproperty" class="tsd-anchor"></a> <h3>parse<wbr>Color<wbr>Property</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">parse<wbr>Color<wbr>Property<span class="tsd-signature-symbol">(</span>material<span class="tsd-signature-symbol">: </span><a href="../interfaces/_svf_materials_.svfinternal.imaterial.html" class="tsd-signature-type">IMaterial</a>, prop<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, defaultValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/materials.ts#L127">svf/materials.ts:127</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>material: <a href="../interfaces/_svf_materials_.svfinternal.imaterial.html" class="tsd-signature-type">IMaterial</a></h5> </li> <li> <h5>prop: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>defaultValue: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="parsematerials" class="tsd-anchor"></a> <h3>parse<wbr>Materials</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">parse<wbr>Materials<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_svf_schema_.imaterial.html" class="tsd-signature-type">IMaterial</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/materials.ts#L47">svf/materials.ts:47</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Parses materials from a binary buffer, typically stored in a file called 'Materials.json.gz', referenced in the SVF manifest as an asset of type 'ProteinMaterials'.</p> </div> <dl class="tsd-comment-tags"> <dt>generator</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>buffer: <span class="tsd-signature-type">Buffer</span></h5> <div class="tsd-comment tsd-typography"> <p>Binary buffer to parse.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_svf_schema_.imaterial.html" class="tsd-signature-type">IMaterial</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4> <p>Instances of parsed materials, or null if there are none (or are not supported).</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="parsescalarproperty" class="tsd-anchor"></a> <h3>parse<wbr>Scalar<wbr>Property</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">parse<wbr>Scalar<wbr>Property<span class="tsd-signature-symbol">(</span>material<span class="tsd-signature-symbol">: </span><a href="../interfaces/_svf_materials_.svfinternal.imaterial.html" class="tsd-signature-type">IMaterial</a>, prop<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, defaultValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/materials.ts#L119">svf/materials.ts:119</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>material: <a href="../interfaces/_svf_materials_.svfinternal.imaterial.html" class="tsd-signature-type">IMaterial</a></h5> </li> <li> <h5>prop: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>defaultValue: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="parsesimplephongmaterial" class="tsd-anchor"></a> <h3>parse<wbr>Simple<wbr>Phong<wbr>Material</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">parse<wbr>Simple<wbr>Phong<wbr>Material<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="../interfaces/_svf_materials_.svfinternal.imaterialgroup.html" class="tsd-signature-type">IMaterialGroup</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_svf_schema_.imaterial.html" class="tsd-signature-type">IMaterial</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/materials.ts#L69">svf/materials.ts:69</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>group: <a href="../interfaces/_svf_materials_.svfinternal.imaterialgroup.html" class="tsd-signature-type">IMaterialGroup</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_svf_schema_.imaterial.html" class="tsd-signature-type">IMaterial</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="parsetextureproperty" class="tsd-anchor"></a> <h3>parse<wbr>Texture<wbr>Property</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">parse<wbr>Texture<wbr>Property<span class="tsd-signature-symbol">(</span>material<span class="tsd-signature-symbol">: </span><a href="../interfaces/_svf_materials_.svfinternal.imaterial.html" class="tsd-signature-type">IMaterial</a>, group<span class="tsd-signature-symbol">: </span><a href="../interfaces/_svf_materials_.svfinternal.imaterialgroup.html" class="tsd-signature-type">IMaterialGroup</a>, prop<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_svf_schema_.imaterialmap.html" class="tsd-signature-type">IMaterialMap</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/petrbroz/forge-svf-utils/blob/678f05e/src/svf/materials.ts#L136">svf/materials.ts:136</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>material: <a href="../interfaces/_svf_materials_.svfinternal.imaterial.html" class="tsd-signature-type">IMaterial</a></h5> </li> <li> <h5>group: <a href="../interfaces/_svf_materials_.svfinternal.imaterialgroup.html" class="tsd-signature-type">IMaterialGroup</a></h5> </li> <li> <h5>prop: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_svf_schema_.imaterialmap.html" class="tsd-signature-type">IMaterialMap</a> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">null</span> </h4> </li> </ul> </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="_gltf_writer_.html">"gltf/writer"</a> </li> <li class=" tsd-kind-external-module"> <a href="_index_.html">"index"</a> </li> <li class=" tsd-kind-external-module"> <a href="_svf_fragments_.html">"svf/fragments"</a> </li> <li class=" tsd-kind-external-module"> <a href="_svf_geometries_.html">"svf/geometries"</a> </li> <li class=" tsd-kind-external-module"> <a href="_svf_input_stream_.html">"svf/input-<wbr>stream"</a> </li> <li class="current tsd-kind-external-module"> <a href="_svf_materials_.html">"svf/materials"</a> <ul> <li class=" tsd-kind-module tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_svf_materials_.svfinternal.html">Svf<wbr>Internal</a> </li> </ul> </li> <li class=" tsd-kind-external-module"> <a href="_svf_meshes_.html">"svf/meshes"</a> </li> <li class=" tsd-kind-external-module"> <a href="_svf_packfile_reader_.html">"svf/packfile-<wbr>reader"</a> </li> <li class=" tsd-kind-external-module"> <a href="_svf_propdb_reader_.html">"svf/propdb-<wbr>reader"</a> </li> <li class=" tsd-kind-external-module"> <a href="_svf_reader_.html">"svf/reader"</a> </li> <li class=" tsd-kind-external-module"> <a href="_svf_schema_.html">"svf/schema"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_svf_materials_.html#parsebooleanproperty" class="tsd-kind-icon">parse<wbr>Boolean<wbr>Property</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_svf_materials_.html#parsecolorproperty" class="tsd-kind-icon">parse<wbr>Color<wbr>Property</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_svf_materials_.html#parsematerials" class="tsd-kind-icon">parse<wbr>Materials</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_svf_materials_.html#parsescalarproperty" class="tsd-kind-icon">parse<wbr>Scalar<wbr>Property</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_svf_materials_.html#parsesimplephongmaterial" class="tsd-kind-icon">parse<wbr>Simple<wbr>Phong<wbr>Material</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_svf_materials_.html#parsetextureproperty" class="tsd-kind-icon">parse<wbr>Texture<wbr>Property</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>