Artisan Grasshopper
Cluster
5 components in Gemset › Cluster.
Cluster
Creates a cluster from a GemObject
Nickname: Cluster · Tab: Gemset › Cluster
Inputs
| Name | Nickname | Type | Access | Default | Description |
|---|---|---|---|---|---|
| Gem | Gem | GemObject | item | — | Gem object to create the cluster for |
| Gems Params (optional) | Gems | Generic | item | — | Cluster gem parameters |
| Prongs Params (optional) | Prongs | Generic | item | — | Cluster prongs parameters |
| Main Gem Rail Params (optional) | Main Gem Rail | Generic | item | — | Cluster Main Gem Rail parameters |
| Cluster JSON (optional) | JSON | Text | item | — | JSON representation of a Cluster |
| Computation Mode (optional) | Computation Mode | Text | item | RENDER | Computation mode: RENDER or MANUFACTURING. Defaults to RENDER. |
| Center Prongs Params | Center Prongs | Generic | item | — | The centre stone’s own prongs (Cluster - Center Prongs Params). Off unless enabled |
Outputs
| Name | Nickname | Type | Access | Description |
|---|---|---|---|---|
| Breps | Breps | Brep | list | Brep parts of the cluster |
| Gems | Gems | GemObject | list | Gem objects |
| Meshes | Gems Meshes | Geometry | list | Gem Meshes |
| Magnet Top | Magnet Top | Plane | item | Top center of the bounding box |
| Magnet Bottom | Magnet Bot. | Plane | item | Bottom center of the bounding box |
| Magnet North | Magnet North | Plane | item | North center of the bounding box |
| Magnet South | Magnet South | Plane | item | South center of the bounding box |
| Magnet West | Magnet West | Plane | item | West center of the bounding box |
| Magnet East | Magnet East | Plane | item | East center of the bounding box |
| Scheme | Scheme | Generic | item | Cluster scheme with reader-compatible keys |
| Semantic | Semantic | Text | item | Semantic text description of the cluster |
| Center Prongs | Center Prongs | Brep | list | Prongs that hold the centre stone (the internal ones), not included in Breps |
Cluster - Center Prongs Params
The cluster centre stone’s own prongs (the Halo’s): round, Double, Triple, Claw or custom, curving into the main gem rail
Nickname: Cluster Center Prongs · Tab: Gemset › Cluster
Inputs
| Name | Nickname | Type | Access | Default | Description |
|---|---|---|---|---|---|
| Enable (optional) | Enable | Boolean | item | false | Add the centre stone’s own prongs (off by default) |
| Mode (optional) | Mode | Text | item | — | DEFAULT (round section) or CUSTOM (the Profile section) |
| Cap Mode (optional) | Cap | Text | item | — | ROUND cap or CLAW (the Basket’s claw) |
| Prong Type (optional) | Type | Text | item | — | SINGLE, DOUBLE or TRIPLE per position (CLAW: SINGLE or DOUBLE; CUSTOM: SINGLE) |
| Number Of Prongs (optional) | Count | Integer | item | — | Prong positions round the stone |
| Diameter (optional) | Diameter | Number | item | — | Prong diameter |
| Height Over Girdle (optional) | OverGirdle | Number | item | — | Prong height above the girdle |
| Gem Inside (optional) | GemIn | Number | item | — | How far the prongs go into the stone |
| Move In Z (optional) | MoveZ | Number | item | — | Prongs moved up or down |
| Rotation (optional) | Rotation | Number | item | — | Rotation of the CUSTOM section |
| Overlap (optional) | Overlap | Number | item | — | DOUBLE / TRIPLE: how much the prongs of a pair cross (0 = they touch) |
| Cap Bump (optional) | Bump | Number | item | — | Bulge of the round cap |
| Profile (optional) | Profile | Generic | item | — | CLOSED_PROFILE Asset of the CUSTOM section |
| Claw Gem Inside (optional) | ClawIn | Number | item | — | CLAW: how far the tip reaches in toward the stone centre |
| Claw Height (optional) | ClawH | Number | item | — | CLAW: the tip moved up or down |
| Claw Tip Direction (optional) | ClawDir | Number | item | — | CLAW: degrees the hook bends down (10-60) |
| Claw Smoothness (optional) | ClawSmooth | Integer | item | — | CLAW: where the hook starts, % of the prong below the girdle (1-30) |
| Straight Bridge (optional) | Straight | Boolean | item | — | Straight (true) or curved run into the main gem rail |
| Extension For Manufacturing (optional) | MfgExt | Number | item | — | Prong extension in MANUFACTURING mode |
| Connector (optional) | Connector | Generic | item | — | Dictionary from a Reader Connector output (base values). Individual inputs override. |
Outputs
| Name | Nickname | Type | Access | Description |
|---|---|---|---|---|
| Center Prongs Params | Center Prongs | Generic | item | Dictionary of parameters (the Connector values plus the connected inputs) |
Cluster - Gems Parameters
Define the gem parameters for a cluster
Nickname: Cluster Gems · Tab: Gemset › Cluster
Inputs
| Name | Nickname | Type | Access | Default | Description |
|---|---|---|---|---|---|
| Gem Size | Gem Size | Number | item | 1.6 | Gem size |
| Min Distance | Min Distance | Number | item | 0.1 | Minimum distance between gems |
| Distance To Gem | Distance To Gem | Number | item | 2.0 | Distance to central gem |
| Z Position | Z Position | Number | item | -0.5 | Z position of gems |
| Rotation | Rotation | Number | item | 0.0 | Rotation |
| Fillet Factor | Fillet Factor | Number | item | 0.3 | Fillet factor |
| Upper Rail Diameter | Upper Rail Diameter | Number | item | 1.0 | Upper rail diameter |
| Upper Rail Move In Z | Upper Rail Move In Z | Number | item | -0.4 | Z offset for upper rail |
| Upper Rail Thread Diameter | Upper Rail Thread Diameter | Number | item | 0.3 | Thread diameter upper rail |
| Lower Rail Enable | Lower Rail Enable | Boolean | item | false | Enable lower rail |
| Lower Rail Diameter | Lower Rail Diameter | Number | item | 1.0 | Lower rail diameter |
| Lower Rail Move In Z | Lower Rail Move In Z | Number | item | -0.8 | Z offset for lower rail |
| Lower Rail Thread Diameter | Lower Rail Thread Diameter | Number | item | 0.3 | Thread diameter lower rail |
| Connector (optional) | Connector | Generic | item | — | Dictionary from the Reader Connector output. Individual inputs override. |
Outputs
| Name | Nickname | Type | Access | Description |
|---|---|---|---|---|
| Gems Parameters | Gems | Generic | item | Cluster gems parameters |
Cluster - Main Gem Rail Parameters
Define the main gem rail parameters for a cluster
Nickname: Cluster Main Gem Rail · Tab: Gemset › Cluster
Inputs
| Name | Nickname | Type | Access | Default | Description |
|---|---|---|---|---|---|
| Enable | Enable | Boolean | item | false | Enable gem base |
| Width | Width | Number | item | 4.0 | Base width |
| Height | Height | Number | item | 4.0 | Base height |
| Rotation | Rotation | Number | item | 1.0 | Base rotation |
| Thread Diameter | Thread Diameter | Number | item | 1.1 | Thread diameter |
| Move In Z | Move In Z | Number | item | -4.0 | Z offset |
| Rail Inside Gem % | Rail Inside Gem % | Number | item | 1.0 | Rail inside gem percentage |
| Bend Height | Bend Height | Number | item | 0.0 | Bend height |
| Bend Rotation | Bend Rotation | Number | item | 0.0 | Bend rotation |
| Connector (optional) | Connector | Generic | item | — | Dictionary from the Reader Connector output. Individual inputs override. |
Outputs
| Name | Nickname | Type | Access | Description |
|---|---|---|---|---|
| GemBase Parameters | GemBase | Generic | item | Cluster gem base parameters |
Cluster - Prongs Parameters
Define the prong parameters for a cluster
Nickname: Cluster Prongs · Tab: Gemset › Cluster
Inputs
| Name | Nickname | Type | Access | Default | Description |
|---|---|---|---|---|---|
| Number | Number | Integer | item | 4 | Number of prongs |
| Prongs Type | Prongs Type | Text | item | STRAIGHT | Type of prongs |
| Int Diameter | Int Diameter | Number | item | 0.8 | Internal prong diameter |
| Int Distance | Int Distance | Number | item | 0.5 | Internal prong distance |
| Int Height Over Girdle | Int Height Over Girdle | Number | item | 0.5 | Height over girdle |
| Int Height Under Girdle | Int Height Under Girdle | Number | item | 0.5 | Height under girdle |
| Int Move In Z | Int Move In Z | Number | item | 0.0 | Z offset |
| Int Gems Extension | Int Gems Extension | Number | item | 0.5 | Extension for manufacturing |
| Ext Diameter | Ext Diameter | Number | item | 0.8 | External prong diameter |
| Ext Distance | Ext Distance | Number | item | 0.5 | External prong distance |
| Ext Height Over Girdle | Ext Height Over Girdle | Number | item | 0.5 | Height over girdle |
| Ext Move In Z | Ext Move In Z | Number | item | 0.0 | Z offset |
| Ext Gems Extension | Ext Gems Extension | Number | item | 0.5 | Extension for manufacturing |
| Central Diameter | Central Diameter | Number | item | 0.8 | Central prong diameter |
| Central Gem Inside | Central Gem Inside | Number | item | 0.0 | Gem inside percentage |
| Central Height Over Girdle | Central Height Over Girdle | Number | item | 0.5 | Height over girdle |
| Central Move In Z | Central Move In Z | Number | item | 0.0 | Z offset |
| Central Gems Extension | Central Gems Extension | Number | item | 0.5 | Extension for manufacturing |
| Connector (optional) | Connector | Generic | item | — | Dictionary from the Reader Connector output. Individual inputs override. |
Outputs
| Name | Nickname | Type | Access | Description |
|---|---|---|---|---|
| Prongs Parameters | Prongs | Generic | item | Cluster prongs parameters |