Skip to content

Commit

Permalink
Layout tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
xeolabs committed Dec 24, 2023
1 parent 7516b9d commit 0cf3b5c
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 18 deletions.
22 changes: 15 additions & 7 deletions _includes/cliInvocationCard.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
<p>First, we convert each IFC file using our <code>ifc2gltfcxconverter</code> tool. Contact us <a
<p>The <code>ifc2gltfcxconverter</code> tool is the first stage of our pipeline and converts IFC into
glTF and JSON-encoded IFC metadata. Contact us <a
href="https://xeokit.io/for-business">here</a> if you would like to evaluate this tool.</p>

<pre class="mt-4 mb-1 mb-5" style="background-color: #1b1e21; color: #3dff08; padding: 15px;">ifc2gltfcxconverter -i model.ifc -o model.glb -m model.json -s @@ifc2gltfFileSize -t @@ifc2gltfTileSize -e 3
</pre>

<p>This creates a set of <code>glb</code> and JSON files that contain the IFC geometry and metadata, along with a JSON manifest that
<p>This creates a set of <code>glb</code> and JSON files that contain the IFC geometry and metadata, along with a JSON
manifest that
lists them, as shown below. The
tool splits the IFC into a
set of files like this so that they are processed more reliably by the next step, and ulltimately loaded more reliably into
tool splits the IFC into multiple files like this so that they may be processed more reliably by the next step, and ulltimately loaded more
reliably into
xeokit's browser-based viewer.</p>
<p>Note the tool's <code>-s</code> option, which specifies that output <code>glb</code> files should be a maximum of <code>@@ifc2gltfFileSize</code>Mb
<p>Note the tool's <code>-s</code> option, which specifies that output <code>glb</code> files should be a maximum of
<code>@@ifc2gltfFileSize</code>Mb
each, in this case. Also, the <code>-t</code> option splits the 3D geometry coordinates into tiled regions of size
<code>@@ifc2gltfFileSize x @@ifc2gltfFileSize x @@ifc2gltfFileSize</code>. That enables
the xeokit viewer to render the geometry accurately without rounding jitter. </p>
Expand All @@ -27,15 +30,20 @@
└── model.json
</pre>

<p>Next, we process that manifest using <a href="https://github.com/xeokit/xeokit-convert">convert2xkt</a>. This is a
<h2 style="margin-bottom: 1em">convert2xkt</h2>

<p>The <a href="https://github.com/xeokit/xeokit-convert">convert2xkt</a> tool is the second stage of our pipeline, and
converts glTF into XKT,
which we can view in the browser with xeokit. This is a
NodeJS-based CLI tool often needs us to allocate it some extra memory. Thanks to splitting our files, our NodeJS
process is not overwhelmed by any memory stress!</p>

<pre class="mt-4 mb-1 mb-5" style="background-color: #1b1e21; color: #3dff08; padding: 15px;">
node --max-old-space-size=14000 convert2xkt -n -a model.glb.manifest.json -o model.xkt.manifest.json</pre>

<p>That converts the <code>glb</code> and JSON files into a set of XKT files, along with a JSON manifest that
lists them, as shown below. XKT is xeokit's web-friendly native binary model format, designed to load quickly into its web viewer.
lists them, as shown below. XKT is xeokit's web-friendly native binary model format, designed to load quickly into
its web viewer.
</p>

<pre class="mt-4 mb-1 mb-5" style="background-color: #1b1e21; color: #3dff08; padding: 15px;">.
Expand Down
7 changes: 5 additions & 2 deletions _pages/tests.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,14 @@ <h1> Pipeline Setup</h1>
</div>
<div class="row mb-5">
<div class="col-12 mx-auto left-text">
<h2 style="margin-bottom: 1em">CLI Tool Usage</h2>


<p>We ran our converter tools on each IFC file in our test collection using the CLI commands shown
below.
For each IFC file, we substitute "model" with the name of that file.</p>

<h2 style="margin-bottom: 1em">ifc2gltfcxconverter</h2>

@@include('../_includes/cliInvocation.html')
<br>
</div>
Expand All @@ -132,7 +134,8 @@ <h2 style="margin-bottom: 1em">ifc2gltfcxconverter Arguments</h2>

<h2 style="margin-bottom: 1em">convert2xkt Arguments</h2>

<p>The table below provides a compreensive list of the arguments we're providing to
<p>The table below provides a
comprehensive list of the arguments we're providing to
<code>convert2xkt</code>.</p>

<table class="table table-sm table-hover table-striped table-bordered mb-0">
Expand Down
29 changes: 20 additions & 9 deletions tests.html
Original file line number Diff line number Diff line change
Expand Up @@ -223,24 +223,29 @@ <h1> Pipeline Setup</h1>
</div>
<div class="row mb-5">
<div class="col-12 mx-auto left-text">
<h2 style="margin-bottom: 1em">CLI Tool Usage</h2>


<p>We ran our converter tools on each IFC file in our test collection using the CLI commands shown
below.
For each IFC file, we substitute "model" with the name of that file.</p>

<p>First, we convert each IFC file using our <code>ifc2gltfcxconverter</code> tool. Contact us <a
<h2 style="margin-bottom: 1em">ifc2gltfcxconverter</h2>

<p>The <code>ifc2gltfcxconverter</code> tool is the first stage of our pipeline and converts IFC into
glTF and JSON-encoded IFC metadata. Contact us <a
href="https://xeokit.io/for-business">here</a> if you would like to evaluate this tool.</p>

<pre class="mt-4 mb-1 mb-5" style="background-color: #1b1e21; color: #3dff08; padding: 15px;">ifc2gltfcxconverter -i model.ifc -o model.glb -m model.json -s 5 -t 200 -e 3
</pre>

<p>This creates a set of <code>glb</code> and JSON files that contain the IFC geometry and metadata, along with a JSON manifest that
<p>This creates a set of <code>glb</code> and JSON files that contain the IFC geometry and metadata, along with a JSON
manifest that
lists them, as shown below. The
tool splits the IFC into a
set of files like this so that they are processed more reliably by the next step, and ulltimately loaded more reliably into
tool splits the IFC into multiple files like this so that they may be processed more reliably by the next step, and ulltimately loaded more
reliably into
xeokit's browser-based viewer.</p>
<p>Note the tool's <code>-s</code> option, which specifies that output <code>glb</code> files should be a maximum of <code>5</code>Mb
<p>Note the tool's <code>-s</code> option, which specifies that output <code>glb</code> files should be a maximum of
<code>5</code>Mb
each, in this case. Also, the <code>-t</code> option splits the 3D geometry coordinates into tiled regions of size
<code>5 x 5 x 5</code>. That enables
the xeokit viewer to render the geometry accurately without rounding jitter. </p>
Expand All @@ -258,15 +263,20 @@ <h2 style="margin-bottom: 1em">CLI Tool Usage</h2>
└── model.json
</pre>

<p>Next, we process that manifest using <a href="https://github.com/xeokit/xeokit-convert">convert2xkt</a>. This is a
<h2 style="margin-bottom: 1em">convert2xkt</h2>

<p>The <a href="https://github.com/xeokit/xeokit-convert">convert2xkt</a> tool is the second stage of our pipeline, and
converts glTF into XKT,
which we can view in the browser with xeokit. This is a
NodeJS-based CLI tool often needs us to allocate it some extra memory. Thanks to splitting our files, our NodeJS
process is not overwhelmed by any memory stress!</p>

<pre class="mt-4 mb-1 mb-5" style="background-color: #1b1e21; color: #3dff08; padding: 15px;">
node --max-old-space-size=14000 convert2xkt -n -a model.glb.manifest.json -o model.xkt.manifest.json</pre>

<p>That converts the <code>glb</code> and JSON files into a set of XKT files, along with a JSON manifest that
lists them, as shown below. XKT is xeokit's web-friendly native binary model format, designed to load quickly into its web viewer.
lists them, as shown below. XKT is xeokit's web-friendly native binary model format, designed to load quickly into
its web viewer.
</p>

<pre class="mt-4 mb-1 mb-5" style="background-color: #1b1e21; color: #3dff08; padding: 15px;">.
Expand Down Expand Up @@ -368,7 +378,8 @@ <h2 style="margin-bottom: 1em">ifc2gltfcxconverter Arguments</h2>

<h2 style="margin-bottom: 1em">convert2xkt Arguments</h2>

<p>The table below provides a compreensive list of the arguments we're providing to
<p>The table below provides a
comprehensive list of the arguments we're providing to
<code>convert2xkt</code>.</p>

<table class="table table-sm table-hover table-striped table-bordered mb-0">
Expand Down

0 comments on commit 0cf3b5c

Please sign in to comment.