3D Processing Settings
What are 3D Processing Settings?
RapidPipeline 3D Processing Configuration Settings adhere to the adhere to the 3D Processing Schema and are designed to achieve any 3D processing goal. They operate directly on a 3D model and are able to alter the entire structure or re-create meshes, materials, UVs, texture maps and other 3D model properties.
See here for a more exhaustive list of all available settings and how they relate to the 3D Processing Schema.
Settings Categories and Guides
There are 7 major categories of 3D Processing Settings:
See the Settings Guides below, going through each of the main settings categories and all the features and 3d processing settings they contain.
3D Processing Schema
Introduction
RapidPipeline 3D Processor schemas are a set of rules that represent and validate the structure and format of RapidPipeline's 3D processing functionalities.
RapidPipeline maintains this semantic normalization by using schemas. Schemas are the standard way of describing data processes in RapidPipeline, allowing all data that conforms to schemas to be reused across all different tools and interfaces without conflicts.
In addition to describing the structure of data, schemas apply constraints and expectations to data so it can be validated as it moves between systems. These standard definitions allow data to be interpreted consistently, regardless of origin, and remove the need for translation across applications.
Available Versions and Compatibility
The 3D Processing Schemas are utilized by multiple RapidPipeline Software Packages & Interfaces as validation for JSON Settings files . Generally the most recent schema version will be adopted and applied within all interfaces.
Newer 3D Processing Schemas are only compatible with the corresponding newer 3D Processor CLI versions. Settings created against the newer schemas might not validate with older versions of the 3D Processor!
See the corresponding schemas and software releases below.
Web Platform
The RapidPipeline Platform and API are usually always on the latest Schema version.
3D Processor CLI
| CLI Version | 3D Processing Schema (link) | Description |
|---|---|---|
| v7.4.0 | 3D Processing Schema v1.4 | Direct operations on the 3D Data, such as Optimization, Compression, etc. |
| v7.3.0 | 3D Processing Schema v1.3 | Direct operations on the 3D Data, such as Optimization, Compression, etc. |
| v7.2.0 | 3D Processing Schema v1.2 | Direct operations on the 3D Data, such as Optimization, Compression, etc. |
| v7.1.0 - v7.1.1 | 3D Processing Schema v1.1 | Direct operations on the 3D Data, such as Optimization, Compression, etc. |
| v7.0.0 | 3D Processing Schema v1.0 | Direct operations on the 3D Data, such as Optimization, Compression, etc. |
Integrations
| Integration & Version | 3D Processing Schema (link) | Remarks |
|---|---|---|
| Blender Add-On v0.2.4 | 3D Processing Schema v1.4 | Supports RapidPipeline Actions, 3D Processor Settings are now presented as Expert Mode |
| Blender Add-On v0.2.3 | 3D Processing Schema v1.3 | First experimental version of RapidPipeline Actions. Uses 3D Processing Settings validated against v1.3 schema. |
| Blender Add-On v0.2.2 | 3D Processing Schema v1.2 | Uses 3D Processing Settings validated against v1.2 schema. |
| Blender Add-On v0.2.1 | 3D Processing Schema v1.1 | Uses 3D Processing Settings validated against v1.1 schema. |
| Blender Add-On v0.2.0 | 3D Processing Schema v1.0 | Uses 3D Processing Settings validated against v1.0 schema. |
Data Categories and Types
Data within the 3D Processing Settings JSON Files can be divide into 3 high-level categories :
Settings Group
Operation
Categories and states are high-level concepts and serve only documentation purposes. They can not be found within the 3D Processor Schema or defined within the JSON Settings files themselves.
Each Category has a specific Type and an optional State:
Types: Define the kind of data type for any value in JSON.
object,string,boolean,number,array
State: Define special behavior and usage within the settings JSON for any value.
toggle= this state indicates that a setting, group or operation has to be specified ("toggled") in order to have any effect.
Settings, settings groups or operations without the toggle state, have always a default behavior, either directly or via children, no matter if they are specified or not (= omitted).
For example if the import object is not specified, imported CAD data is still tessellated via the CAD settings group child object and it's tessellationResolution setting using the default resolution fine.
oneOf choices
In addition within the 3D Processor Settings Documentation oneOf choices are indicated by the following tag:
Properties with the oneOfChoice tag indicate that the respective choice has to be specified within the configuration to have an effect and multiple oneOf tagged properties within the same parent object are not allowed.
Associations between the categories:
Setting- possible types:
string,boolean,number,array - possible states:
toggle
Settings can be of any available type other than object and can sometimes be of state toggle. Settings can not hold any nested data, as they are no objects.
Settings Group
- possible types:
object - possible states:
toggle
Settings Groups are always of type object and can be of state toggle.
Settings Groups can hold different nested data, such as Settings, other Settings Groups or even Operations.
Operation
- possible types:
object,array - possible states:
toggle
Operations are usually of type object and mostly of state toggle. Operations are similar to Settings Groups but trigger active functionality within the 3D Processor.
Examples:
import Settings Group
type : object
export Operation
type : array
state: toggle
Even though the export operation is of state toggle it is also required as per 3D Processor Schema. That means that within one settings file the export object does not have to be specified as long as another configuration holds that property or an --export command (from CLI v7.2.0 on) is utilized.
Settings Preset Files
A set of 3D processing configuration settings in the RapidPipeline Web Platform is described as a 3D Processor Preset.
In order to try out some example presets the 3D Processor Presets in the RapidPipeline Web Platform can be utilized.
To download a preset in editable JSON format, activate Preview New Settings with the radio button and download the respective settings JSON files via the Actions menu:
These JSON settings files can be ingested by the RapidPipeline Integrations (e.g. Blender Add-On) or the RapidPipeline 3D Processor CLI.
Learn more about how to ingest the JSON settings files with the 3D Processor CLI here.
Further Documentation
For the full Documentation on all available data operations commands and system settings, please refer to the CLI Commands Guide and 3D Processor System Schema & Settings.
The 3D Processor is available for multiple interfaces: