Skip to content

Latest commit

 

History

History
144 lines (106 loc) · 7.09 KB

i3s_converter_ReadMe.md

File metadata and controls

144 lines (106 loc) · 7.09 KB
Raw

i3s_converter.exe

Quick Links

Introduction
Running the executable
Subcommands
Options
Examples
Notes
Version History
Licensing

Introduction

i3s_converter a command line tool for

  • Validating a 1.6 Scene Layer Package (slpk)
  • Convert a 1.4-1.6 slpk to 1.8
  • Extract a 1.8 slpk or a 2.0 slpk with layer type of Point Cloud.
  Validate Convert Extract
3DObject supported supported supported
Integrated Mesh supported supported supported
Point supported supported supported
Pointcloud supported   supported
Building supported supported supported

Note: 1.9 maintains backwards compatibility with 1.6. The resultant 1.9 slpk will be larger in size than the input slpk. This is due to the creation of Draco-compressed geometries and DXT-compressed textures. All of these features are important for increased performance. If output slpk size is a limiting factor, the -x option can be used to skip writing DXT textures, but this may result in slower drawing performance.

When extracing or converting, the following formats are available:

  • Archived: *.slpk
  • Filesystem : *.eslpk
  • Cloud : *.i3srest

Cloud storage options supported:

  • Microsoft Azure Blob
  • Amazon Web Services S3
  • Alibaba OSS

Running the executable

Open Command Prompt

  1. Win+R

  2. Enter cmd into pop-up window

Run the executable

  1. Specify the .exe path

  • Drag and drop the .exe into the command prompt window (absolute path) exe_abs_path OR

  • cd into the directory that contains the .exe (relative path)

    • Use: i3s_converter
      exe_cwd_path

  1. Specify the slpk path

    • Use relative path if executable is in same directory as slpk

    • Otherwise use absolute path

min_required

This is the minumum required to use the converter with an slpk.

Subcommands

**Short name is interchangeable with long name, so either may be used for an action. For example,
i3s_converter.exe -e myFile.slpk
is the equivalent to
i3s_converter.exe --extract myFile.slpk

Subcommand Short Subcommand Long Action
-b --converter-info Show converter version
-e [infile.slpk] --extract [infile.slpk] Extract slpk to eslpk
-h --help Show usage
-i [infile.slpk] --slpk-info [infile.slpk] Show basic layer info
-u [infile.slpk] --convert [in-slpk] Convert and/or upgrade slpk to current i3s version.
-v [infile.slpk] --validate [in-slpk] Validate slpk
--convert-and-extract [in-slpk] Convert to 1.7 extracted slpk

Options

Option Short Option Long Action
-a [key] --access-key [key] AWS S3 access key / Azure Account / Alibaba Account
-d [dir] --dest [output-directory] Change output directory. Will create it if it doesn't exist
-k --create-ktx2-textures Create Basis Universal texture from input
-j [log_name] --json [log_name] Set log name
-n --drop-normals Drop all normals. Client will recreate (Draco geometry buffer only)
-o [outfile] --output-name [outfile] 1.8 slpk name
-r --region Region where bucket is located (S3/OSS).
-s [key] --secret-key [key] AWS S3/Alibaba OSS secret key or Azure account key
-t [num threads] --thread-count [num threads] Number of threads to use when converting, default is 1
-x --drop-dxt Don't write DXT textures
--endpoint-url Endpoint url of object store.
--aws-profile AWS Profile in %USERPROFILE%\.aws\credentials
--date-format Expected date format of date field. Required to correctly convert date formats into ECMA ISO8601. Date always needs to be in uppercase and time in lower case. If not specified the default US date format "MM/DD/YYYY hh:mm:ss" is assumed. Only dates in the Gregorian calendar are supported.
--utc-offset Offset from UTC of date fields. Expected format is +hh:mm for positive or -hh:mm for negative offset. If not set, time zone setting of the device will be used.

Supported cloud schemes:

  • AWS S3: s3
  • Azure Blob: az
  • Alibaba OSS: oss

Examples

Examples can be found here, which show various uses of the i3s_converter.

Notes

  • Only the first 10 warnings/errors are output to the command line.

  • Any output files are written out relative to the current working directory, unless -d flag is used.

  • To avoid having to specify the absolute path to the .exe

    • cd to the directory that contains the .exe
    • add the .exe as a PATH environment variable

  • 1.7 slpks and log files will be overwritten when tool is re-run with the same input

  • The number of threads to run the extraction or conversion on. Increasing the number of threads typically reduces execution time. If unsure, base of off number of CPU cores and I/O bandwidth of your machine.

Licensing

Copyright 2020 ESRI

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.