# Ptarmigan Rhino
## PTARMIGAN-Plugins
All documentation for Rhino Commands will be here.
## Rhino Commands
***
### AutoName
Data Type: All
Names objects based on a given selection order. Prompts a naming convention and the starting value (default is 1) and a step value (default is 1).
*\*For now, it only accepts integers and not numbers with decimals.*\
*\*You must delete layers created with this command to re-run with same naming convention.*
Output: Geometry with random colors, based in given parameters.
Command Line Options (AutoName)
{% stepper %}
{% step %}
#### Name/Abbreviation for Part
Add the name/abbreviations for all the selected parts.
{% endstep %}
{% step %}
#### Select in Order of Labels
Select objects in the order you want them named.
{% endstep %}
{% step %}
#### Start Value
Starting Value. Default is 1.
{% endstep %}
{% step %}
#### Step Value
Step Value. Default is 1.
This will sequentially loop as a = a + step\_value. Changing the default value adds integer spacing between names.
{% endstep %}
{% endstepper %}
***
### DetailDisplay
Data Type: Detail
Changes the display mode of multiple details. You can also change it in properties but this gives another option for making all details match the same display mode. You can use the `SelDetailsInDoc` command and in properties panel to change it or use this command to type it out.
{% stepper %}
{% step %}
#### Select Detail
Select Details in layout.
{% endstep %}
{% step %}
#### Type the name of the display mode
Name must be the same as the named display you want to choose. Default is in Shaded.
{% endstep %}
{% step %}
#### Display Mode Changes
Outputs the display mode typed into the string box.
{% endstep %}
{% endstepper %}
***
### DetailLock
Data Type: Detail
Locks detail viewport for details that are selected.
{% stepper %}
{% step %}
#### Select Detail
Data Type: Detail
Puts the details selected into a scale factor.
For scale factor information. please visit here:
{% stepper %}
{% step %}
#### **Select Detail**
Select Details in layout
{% endstep %}
{% step %}
#### **Scale Factor**
Default is 1. Should always be 1 unless needed to be changed for some reason.
{% endstep %}
{% step %}
#### **Choose Scale Type**
3 types of ways to give the scale value that is appropriate for your detail view
* Drawing Scale: Type in the drawing scale factor in this format Example: 1/2" = 1'-0" would be just typed as ½ or 0.5
* Scale Factor: Type in scale factor. It will be only a whole number Example: `1/8" = 1'-0"` `8/1 x 12 = Scale Factor 96`
* Viewport Scale: Basically the reciprocal of the scale factor calculated. Example: Scale factor of 96 is a viewport scale of 1/196.
{% endstep %}
{% endstepper %}
***
### DetailScaleFactor
Data Type: Detail
Takes text that is written by attribute user text and adds scale factor of the selected detail.
For scale factor information. please visit here:
{% stepper %}
{% step %}
#### **Select Detail**
Select Details and blocks.\
\
Note: Make sure it is in the same selection order!
{% endstep %}
{% step %}
#### **Select Detail**
Select Details you want to use.
{% endstep %}
{% step %}
#### **Select Blocks with Attribute User Text**
{% endstep %}
{% endstepper %}
Output: Sets the selected details into a specific scale factor.
***
### DetailUnlock
Data Type: Detail
Unlocks selected details. Works well in combination with `SelDetailsinDoc` command.
Output: Unlocks selected details.
{% stepper %}
{% step %}
#### Select Detail
Data Type: All
Creates a table of contents based on the title of each layout and the corresponding page numbers.
Output: List of page names and numbers as text objects.
Command Line Options (LayoutNames)
{% stepper %}
{% step %}
#### Pick Point
Pick point to start the array of page names & numbers. The pick point should be
```
x = margin
```
```
y = column-width/2
```
If pick point is not on the template, here are the dimensions for placement:
{% endstep %}
{% step %}
#### Group Text? (Group=Yes)
Option to group all the text generated by the command. Group=Yes will group everything; Group=No keeps them separated.
{% endstep %}
{% endstepper %}
***
### MoveToNewLayer
Data Type: All
Moves selected objects to a new layer.
Output: New layer with all the parts inside.
Command Line Options
```
New layer name. For child layers, format like layer01::layer02
```
Type in new layer name. For child layers, use layer01::layer02 format.
***
### NamesToLayers
Data Type: All
Creates layers based on the object's name. Example names: LA1, LA6, LA7, LA8.
Output: Objects with new layers based on object names and random color layers. Gives list output of the names used like this: \['LA1', 'LA7', 'LA6', 'LA8']
Command Line Options
* None
***
### Random Colors
Data Type: All
Gives a random color for each object selected. Colors range from 5-255 using RGB channels as the method for randomization (0-4 excluded because they appeared too close to white). Other combinations like True, True, False still output a random color (not a gradient of the two channels).
Output: Geometry with random colors based on given parameters.
Command Line Options (Random Colors)
{% tabs %}
{% tab title="RandomRed=True RandomGreen=True RandomBlue=True" %}
Random colors between ranges of 0-255 of the RGB channels.
{% endtab %}
{% tab title="RandomRed=True RandomGreen=False RandomBlue=False" %}
Random red gradient (random values on Red channel).
{% endtab %}
{% tab title="RandomRed=False RandomGreen=True RandomBlue=False" %}
Random green gradient (random values on Green channel).
{% endtab %}
{% tab title="RandomRed=False RandomGreen=False RandomBlue=True" %}
Random blue gradient (random values on Blue channel).
{% endtab %}
{% endtabs %}
***
### ResetPageViews
Data Type: Layout
Resets the page view to a "ZoomSelect" of the page boundaries.\
\&#xNAN;*Note: Only works for 11x17" landscape. Update will include multiple page sizes.*
Output: Layouts back in a default position.
***
### SelDetailsInDoc
Data Type: Detail
Selects details throughout the entire rhino file. Differs from `SelDetail` because `SelDetail` only selects within the active sheet.
Output: Selection of all details within document.
***
### SelSameArea
Data Type: Surface, PolySurface, Mesh, Solids
Selects objects with the same area. Tolerance is 0.001 units.
Output: Selection of objects that are the same area or sets of objects that share the same area. Reports the area calculated in the command line.
Command Line Options (SelSameArea)
{% stepper %}
{% step %}
#### Select surface, polysurfaces, hatches, closed planar curves or polygon meshes for area calculation
Select the objects within the object types.
{% endstep %}
{% step %}
#### Boolean options: `Check_All_Selected_Objects`=False
All objects means measure everything and find objects with the same area. Example: if 6 cubes have area 1 and 5 cubes have area 4, it will select the 6 cubes and the 5 cubes — essentially grouping objects that share the same area.
{% endstep %}
{% step %}
#### Select object
Select the object to measure and find duplicates.
{% endstep %}
{% endstepper %}
***
### SelSameLength
Data Type: Curve
Selects curves with the same length within document tolerances.
Command Line Options (SelSameArea)
{% stepper %}
{% step %}
#### Select Curves for Length Calculation
Select the objects within the object types.
{% endstep %}
{% step %}
#### Boolean options: `Check_All_Selected_Objects`=False
All objects means measure everything and find objects with the same area. Example: if 6 cubes have area 1 and 5 cubes have area 4, it will select the 6 cubes and the 5 cubes — essentially grouping objects that share the same area.
{% endstep %}
{% step %}
#### Select object
Select the object to measure and find duplicates.
{% endstep %}
{% endstepper %}
***
### Ptarmigan
Data Type: None
Outputs the name of the plugin and version. Used for debugging and version corrections.
Output: Dialogue box showing Ptarmigan plugin version.
Command Line Options
* None
***
### UnHideAll
Data Type: None
Unhides all objects, including layers that are turned off.
Output: All objects unhidden in document.
Command Line Options
* None
***
### UP2
Data Type: None
Scales objects up by 2%.
\*Note: this is is used for accounting for shrinkage of casted parts.
Output: Scaled objects by 2%.
Command Line Options (UP2)
{% stepper %}
{% step %}
#### Select Object
Select the objects you want scaled up 2%.
{% endstep %}
{% step %}
#### Origin
Pick point to scale from.
{% endstep %}
{% step %}
#### Copy=No
Choose to copy the original object before scaling. Good to reference off of. Default is "No".
{% endstep %}
{% endstepper %}
***
### UP3
Data Type: None
Scales objects up by 3%.
\*Note: this is is used for accounting for shrinkage of casted parts.
Output: Scaled objects by 3%.
Command Line Options (UP3)
{% stepper %}
{% step %}
#### Select Object
Select the objects you want scaled up 3%.
{% endstep %}
{% step %}
#### Origin
Pick point to scale from.
{% endstep %}
{% step %}
#### Copy=No
Choose to copy the original object before scaling. Good to reference off of. Default is "No".
{% endstep %}
{% endstepper %}
***
### VolumeToDot
Data Type: Closed PolySurfaces, Closed Meshes
Creates a dot object on objects that have a volume with the cubic units.
Output: Dot objects with the volume information or marking objects red if they do not meet the requirements.
Command Line Options (VolumeToDot)
{% stepper %}
{% step %}
#### Select PolySrf
Select objects that are closed.
{% endstep %}
{% step %}
#### Report
Displays: "# objects were successfully calculated. 0 Are Marked in Red" — a report of how many objects were calculated. Objects that are open will be marked red.
{% endstep %}
{% endstepper %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://clarkchengdesign.gitbook.io/documentation/ptarmigan-rhino.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
