RapidCompact Optimize Endpoint Configuration Schema v1.4

Type: object

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

 No Additional Properties

root workflowSettings

root workflowSettings oneOf Polygon Count Target
Type: object

Specifies a target mesh resolution via a number of polygons

 No Additional Properties

root workflowSettings oneOf Polygon Count Target targetMeshResolution

Maximum polygonal resolution for mesh

root workflowSettings oneOf Polygon Count Target targetMeshResolution oneOf item 0
Type: object

root workflowSettings oneOf Polygon Count Target targetMeshResolution oneOf item 0 faceCount
Type: integer

Target face count, as absolute number

Value must be greater or equal to 1

root workflowSettings oneOf Polygon Count Target targetMeshResolution oneOf item 1
Type: object

root workflowSettings oneOf Polygon Count Target targetMeshResolution oneOf item 1 facePercentage
Type: number

Target face count, as percentage of original number of faces

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

root workflowSettings oneOf Polygon Count Target targetTextureResolution
Type: object

Target texture resolution for different maps

root workflowSettings oneOf Polygon Count Target targetTextureResolution baseColor
Type: integer

Desired resolution for base color map

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

root workflowSettings oneOf Polygon Count Target targetTextureResolution emissive
Type: integer

Desired resolution for emissive map

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

root workflowSettings oneOf Polygon Count Target targetTextureResolution normal
Type: integer

Desired resolution for normal map

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

root workflowSettings oneOf Polygon Count Target targetTextureResolution orm
Type: integer

Desired resolution for ORM map

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

root workflowSettings oneOf Target MB Size
Type: object

Target asset file size, in MB

 No Additional Properties

root workflowSettings oneOf Target MB Size targetMBSize
Type: number

Value must be greater or equal to 0.001

root workflowSettings oneOf Target Size
Type: object

Alias for Target MB Size

 No Additional Properties

root workflowSettings oneOf Target Size targetSize
Type: number

Value must be greater or equal to 0.001

root sceneManipulation
Type: object
No Additional Properties

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 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 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"
  • "usdz"
  • "obj"
  • "stl"
  • "ply"
  • "ctm"

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"

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"

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"

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"

root compressionAndExport fileExports fileExports items scaleFactor
Type: number

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