Part
Overview
Part is one main item of the configurator.
Part can be added to a Structure Logic, like Linear Structure or Free Placement Structure, Product, Item List, Accessory Slot and of course to a part.
To add a part, select it from the context menu of the item that supports adding it
The part provides the following context menu:
Base property
The Base properties of the Part cover thumbnail, name, description and link to the 3D asset which are rendered in the planner. There are control parameters for positioning the 3D asset in the scene and toggles that specify if the part can be selected, shown in measurements and if the part is hidden.
Root Properties
| Property Name | Type | Localized | Description |
|---|---|---|---|
| ThumbnailImageAssetId | PNG/JPEG Asset | N | Thumbnail used for the part to visualise on the Planner |
| ThreeDModelAssetId | GLTF Asset | N | 3D model asset for the part |
| Size | Vector | N | Size of the bounding box of the 3D model. Size of the actual 3D model will not be affected. You can restore the original value coming from the 3D asset by clicking the reset button if you edit this |
| Offset | Vector | N | Offset of the 3D model from the positioning point. Useful if the 3D model is not centered properly |
| Rotation | Degrees | N | Rotation of the 3D model, useful to align the 3D model in case it is not perfectly aligned at creation time |
| Measurable | Toggle | N | Toggle to enable/disable if the part is shown in measurements |
| Selectable | Toggle | N | Toggle to enable/disable if this item can be selected in the planner view |
| DisplayName | Text field | Y | The short name shown for this part in the Planner, if empty Product title used |
| Description | Text field | Y | The short text shown for this part in the Planner |
| Hidden | Toggle | N | Toggle to hide/make visible the part. Useful to hide parts not needed in composition for example due to editing or other purposes. |
| ElementSelectionMask | Toggle | N | Toggle to apply a selection mask on the part. Makes it easier to select thin parts, especially on touch screens. Also improves performance if the part contains complex geometry. |
Optional property sets
ScalingPlaneGroup
| Property Name | Type | Localized | Description |
|---|---|---|---|
| TargetSize | Scripting | N | |
| PlaneNormal | Vector | N | |
| ScaleTextures | Toggle | N | Should the linked materials be scaled appropriately as well |
| ScalingPlanes | Parameter set | N |
Each Scaling Plane has the following properties
| Property Name | Type | Localized | Description |
|---|---|---|---|
| planePoint | Vector | N | |
| weight | Number | N |
LinearStructureProperties
The property set defines the following properties for both 'Left' and 'Right' of the part.
| Property Name | Type | Localized | Description |
|---|---|---|---|
| Enabled | Toggle | N | A toggle to turn on/off the side of the part. Used to define parts that end the composition. |
| Alignment | Vector | N | Positioning the connector placement in 3D space. Used to place the connector on the right placement on the 3D space |
| Offset | Vector | N | |
| AlignedOffset | Vector | N | |
| Rotation | Degrees | N | Rotation of the connection point. Used for angled parts to change the direction of the connection point. Note that this rotation affects the alignment of the connector after rotation |
Additionally, the property set defines these properties.
| Property Name | Type | Localized | Description |
|---|---|---|---|
| IsStartingOption | Toggle | N | Determines if the part can be used as the first part in the structure. A linear structure must have at least one part which has this enabled. |
Plug
Plug is a counter part to an Accessory slot. It defines the connection point of the accessory part itself and permits using very different accessories in an accessory slot. The plug allows the accessory to define the place where it 'plugs into the (accessory) slot'. It is commonly used with accessories that are placed differently on the parent part and adjusting placement of the accessory slot would not be useful as the accessories need to have different parameters for correct placement. Without a specific plug component on the accessory, the default placement will be used.
| Property Name | Type | Localized | Description |
|---|---|---|---|
| Alignment | Vector | N | The placement of the plug connection point in respective to the part it is defined with. |
| Offset | Vector | N | |
| AlignedOffset | Vector | N | |
| Rotation | Degrees | N | Rotation of the plug connection point in respect to the part it is defined with. Useful for angled accessories or where the 3D model isn't perfectly aligned |
FreePlacedOptionProperties
Connection point
| Property Name | Type | Localized | Description |
|---|---|---|---|
| Alignment | Vector | N | |
| Offset | Vector | N | |
| AlignedOffset | Vector | N | |
| Rotation | Degrees | N | Rotation of the connection point on the item. Note that rotation affects the alignment of the connection point after rotation |
SalesCodeMapping
SalesCodeMapping property set is used to define the logic to determining SKU (Stock-Keeping Unit) codes used for integrations and Summary. When integrating the 3D ecommerce configurator with eCommerce platforms, both must explicitly know the same set of SKUs in order for the configurator to be able to show proper prices and map the composition configuration to an order (Add To Cart)
| Property Name | Type | Localized | Description |
|---|---|---|---|
| Amount | Scripting | N | The defaul number of units each item where this property is defined will be counted, typically 1, but occasionally something else based on logic |
| CaseGroups | Logic Fields | N | For each logic group, a selection of case split logic rules in the rule field that define an outcome code into the code field. * denotes applies to all definition A case-split can be based on scripting logic, a child condition (eg. material slot or accessory slot selection), Multiple case groups perform an composed SKU code. Refer to Sales Code Mapping for more information |
CustomMeasure
| Property Name | Type | Localized | Description |
|---|---|---|---|
| StartPoint | Vector/scriptable | N | Starting point of the measurement line. Can be dynamic based on scripting |
| EndPoint | Vector/scriptable | N | Ending point of the measurement line. Can be dynamic based on scripting |
| Enabled | Toggle/scriptable | N | Toggle to enable/disable this custom measure. Can be dynamic based on scripting |
CustomProperties
Custom Property set (or sets) allow definition of logic that defines something that otherwise isnt predefined in the system logic.
| Property Name | Type | Localized | Description |
|---|---|---|---|
| Name | Text field | Y | The name of the custom property. It can be reffered to in scriting from elsewhere |
| Value | Scripting | N | Value or scripting logic that the property has |
ValidationRule
Validation rule property set is used to define logic that can be useful to ensuring the the item where the validation rule is will follow define rules.
| Property Name | Type | Localized | Description |
|---|---|---|---|
| DisplayMessage | Text Field | Y | Text that is shown on the Planner when the conditions of the rule are true |
| Level | Radio Button | N | Selection should the rule show error, suggestion or indicating something is missing |
| Trigger | Scripting | N | The logic that defines the validation rule |
ClassificationTag
Classification tag allows the configurator to define a name in the system that can be referred to in other logic components through the scripting system
| Property Name | Type | Localized | Description |
|---|---|---|---|
| Tag | Text field | N | A label that is associated with the item it's been configured to |