RapidCompact Optimize Endpoint Configuration Schema v2.12

Type: object

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

 No Additional Properties

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root if
Type: object

root if uvUnwrapping
Type: object
root then
Type: object
No Additional Properties

root then uvUnwrapping
Type: object

root then schema
Type: object

root then compressionAndExport
Type: object
root else
Type: object

The following properties are required:

  • assetSimplification

root schema

Schema Version

Type: const

The schema version to use

Specific value: "2.12"

root uvUnwrapping

UV Unwrapping

Type: object

Unwrap UVs of an input model

 No Additional Properties

root uvUnwrapping method

Unwrapping Method

Type: enum (of string)

method to be used for UV unwrapping

Must be one of:

  • "cube"
  • "isometric"
  • "forwardBijective"
  • "fixedBoundary"
  • "fastConformal"

root uvUnwrapping uvScale

UV Scale

Type: number

Specified UV scale for unwrapping method "cube" in meters

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

root limits

Limits

Type: object

root limits faces

root limits faces oneOf item 0
Type: object
No Additional Properties

root limits faces oneOf item 0 count
Type: integer

Value must be greater or equal to 0

root limits faces oneOf item 1
Type: object
No Additional Properties

root limits faces oneOf item 1 percentage
Type: integer

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

root limits textures
Type: object
No Additional Properties

root limits textures baseColor
Type: integer Default: 2048

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

root limits textures emissive
Type: integer Default: 2048

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

root limits textures normal
Type: integer Default: 2048

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

root limits textures orm
Type: integer Default: 2048

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

root limits megabyte
Type: number

Value must be greater or equal to 0

root targets

Targets

Type: object
No Additional Properties

root targets screenspace
Type: integer

Value must be greater or equal to 0

root sceneManipulation

Scene Manipulation

Type: object
No Additional Properties

root sceneManipulation discardAnimations
Type: boolean Default: false

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 Default: false

Flag to specify if rotation to z-axis pointing upwards

root sceneManipulation centerModel
Type: boolean Default: false

Centers the model around the coordinate origin before export

root sceneManipulation removeInvisibleGeometry
Type: boolean Default: false

Flag to specify if interior invisible geometry should be removed

root sceneManipulation removeSmallFeatures

Remove small features


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

 No Additional Properties

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

root assetSimplification

Asset Simplification

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

Asset Simplification Method

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"
  • "remeshing-keep-alpha"
  • "remeshing-bake-alpha"
  • "preserveTiling"
  • "rebakePreserveNodes"
  • "preserveUVsAndNodes"
  • "dropTextures"

root assetSimplification topologySettings

Mesh and Topology Simplification

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

UVs and Atlasing

Type: object

Additional detail settings for UVs and atlasing

 No Additional Properties

root assetSimplification uvAndAtlasSettings uvStretchTolerance
Type: number Default: 0

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 uvAndAtlasSettings atlasingFactor
Type: number Default: 1

Atlas factor for determining how many atlases to bake per material

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

root assetSimplification materialAndTextureBaking

Material and Texture Baking

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

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

root assetSimplification materialAndTextureBaking normalsShading
Type: number Default: 60

Hard angle (degrees) used for normal generation (0 = everything flat, 180 = everything smooth)

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

root assetSimplification materialAndTextureBaking alphaBlendToMask
Type: boolean Default: false

Use alpha masking instead of blending when the alpha map has 40% or more black or white pixels.

root assetSimplification materialAndTextureBaking alphaMapToOpaqueThreshold
Type: number Default: 1

Consider the material opaque if the alpha map mean value is above the given value

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

root compressionAndExport

Compression and Export

Type: object

Settings for data compression and file export

 No Additional Properties

root compressionAndExport fileExports
Type: array of object

List of desired file exports

 No Additional Items

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"
  • "vrm"

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

Value must be greater or equal to 0

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 Default: 1

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

Value must be greater or equal to 0

root compressionAndExport fileExports fileExports items ktxSettings
Type: object

Finetune ktx compression settings

 No Additional Properties

root compressionAndExport fileExports fileExports items ktxSettings compressionSpeed
Type: number

compression speed for KTX (0 = fast, 5 = slow but higher quality)

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

root compressionAndExport fileExports fileExports items ktxSettings quality
Type: number

compression quality for KTX (0 = lowest quality but max compression, 255 = max quality)

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