RapidCompact Optimize Endpoint Configuration Schema v2.6

Type: object

Optimization parameters for a single assets (and possibly multiple outputs)

 No Additional Properties

root schema
Type: const

The schema version to use

Specific value: "2.6"

root limits
Type: object

root limits faces

root limits faces oneOf item 0
Type: object

root limits faces oneOf item 0 count
Type: integer
root limits faces oneOf item 1
Type: object

root limits faces oneOf item 1 percentage
Type: integer

root limits textures
Type: object

root limits textures baseColor
Type: integer

root limits textures emissive
Type: integer

root limits textures normal
Type: integer

root limits textures orm
Type: integer

root limits megabyte
Type: number

Value must be greater or equal to 0

root targets
Type: object

root targets screenspace
Type: integer

Value must be greater or equal to 0

root sceneManipulation
Type: object
No Additional Properties

root sceneManipulation discardAnimations
Type: boolean

Flag to specify if animations should be discarded before optimization. If your model contains animations and this is set to false, the model will not be optimized.

root sceneManipulation rotateZUp
Type: boolean

Flag to specify if rotation to z-axis pointing upwards

root sceneManipulation centerModel
Type: boolean

Centers the model around the coordinate origin before export

root sceneManipulation removeInvisibleGeometry
Type: boolean

Flag to specify if interior invisible geometry should be removed

root sceneManipulation removeSmallFeatures

Removes small meshes below a certain threshold in % or absolute value of the bbox size

root sceneManipulation removeSmallFeatures oneOf item 0
Type: object

The following properties are required:

  • removalCount
root sceneManipulation removeSmallFeatures oneOf item 1
Type: object

The following properties are required:

  • removalPercentage

root sceneManipulation removeSmallFeatures removalCount
Type: number

An absolute value for bounding box relative to total bounding box below which meshes are removed

Value must be greater or equal to 0

root sceneManipulation removeSmallFeatures removalPercentage
Type: number

A percentage for bounding box relative to total bounding box below which meshes are removed

Value must be greater or equal to 0 and lesser or equal to 100

Each additional property must conform to the following schema

root sceneManipulation additionalProperties
Type: object

root assetSimplification
Type: object

Specifies how the asset should be simplified, including aspects such as node merging, tiling and atlasing, baking settings and more

 No Additional Properties

root assetSimplification meshDecimation
Type: object

Methods for atlas baking, UV preservation and treatment of scene nodes

 No Additional Properties

root assetSimplification meshDecimation method
Type: enum (of string)

Must be one of:

  • "rebake"
  • "preserveTiling"
  • "rebakePreserveNodes"
  • "preserveUVsAndNodes"
  • "dropTextures"

root assetSimplification topologySettings
Type: object

Specifies detailed settings for mesh simplification

 No Additional Properties

root assetSimplification topologySettings vertexMergingDistance
Type: number

Threshold for merging closeby vertices, relative size to a normalized bounding box size

Value must be greater or equal to 0 and lesser or equal to 0.1

root assetSimplification topologySettings meshDensityEqualization
Type: number

Amount of equalization for the triangle distribution (lower values lead to better shape preservation)

Value must be greater or equal to 0 and lesser or equal to 1

root assetSimplification topologySettings boundaryPreservationFactor
Type: number

Amount of enforced preservation of mesh boundaries (balancing boundary shape vs. preservation of details elsewhere)

Value must be greater or equal to 0 and lesser or equal to 1

root assetSimplification topologySettings preserveTopology
Type: boolean

Flag to specify if topological features like holes should be preserved during decimation

root assetSimplification uvAndAtlasSettings
Type: object

Additional detail settings for UVs and atlasing

 No Additional Properties

root assetSimplification uvAndAtlasSettings uvStretchTolerance
Type: number

Stretch tolerance for UVs (balancing stretch vs. number of charts)

Value must be greater or equal to 0 and lesser or equal to 1

root assetSimplification materialAndTextureBaking
Type: object

Additional settings for texture baking

 No Additional Properties

root assetSimplification materialAndTextureBaking bakingQuality
Type: enum (of string)

Must be one of:

  • "low"
  • "medium"
  • "high"

root assetSimplification materialAndTextureBaking bakeNormalMap
Type: boolean

Flag to specify if a normal map should be baked or not

root assetSimplification materialAndTextureBaking bakeAOMap
Type: boolean

Flag to specify if an AO map should be baked or not

root assetSimplification materialAndTextureBaking aoStrength
Type: number

strength (intensity) for generated AO maps

root compressionAndExport
Type: object

Settings for data compression and file export

 No Additional Properties

root compressionAndExport fileExports
Type: array of object

List of desired file exports

Each item of this array must be:

root compressionAndExport fileExports fileExports items
Type: object

Settings for a single file export

 No Additional Properties

root compressionAndExport fileExports fileExports items fileType
Type: enum (of string)

Must be one of:

  • "glb"
  • "gltf"
  • "usd"
  • "usdz"
  • "obj"
  • "stl"
  • "ply"
  • "ctm"
  • "fbx"

root compressionAndExport fileExports fileExports items meshCompressionMethod
Type: enum (of string)

Must be one of:

  • "none"
  • "draco"
  • "dracoLossy"

root compressionAndExport fileExports fileExports items customScaling
Type: number

Alias for scaleFactor

root compressionAndExport fileExports fileExports items textureFormat
Type: object

Texture map format for export

 No Additional Properties

root compressionAndExport fileExports fileExports items textureFormat baseColor
Type: enum (of string)

Must be one of:

  • "auto"
  • "jpg"
  • "png"
  • "ktx2"
  • "ktx"
  • "ktx-basis-uastc"
  • "ktx-basis-etcs1"
  • "webp"

root compressionAndExport fileExports fileExports items textureFormat emissive
Type: enum (of string)

Must be one of:

  • "auto"
  • "jpg"
  • "png"
  • "ktx2"
  • "ktx"
  • "ktx-basis-uastc"
  • "ktx-basis-etcs1"
  • "webp"

root compressionAndExport fileExports fileExports items textureFormat normal
Type: enum (of string)

Must be one of:

  • "auto"
  • "jpg"
  • "png"
  • "ktx2"
  • "ktx"
  • "ktx-basis-uastc"
  • "ktx-basis-etcs1"
  • "webp"

root compressionAndExport fileExports fileExports items textureFormat orm
Type: enum (of string)

Must be one of:

  • "auto"
  • "jpg"
  • "png"
  • "ktx2"
  • "ktx"
  • "ktx-basis-uastc"
  • "ktx-basis-etcs1"
  • "webp"

root compressionAndExport fileExports fileExports items scaleFactor
Type: number

Custom scaling factor, if any (1 = no custom scaling)