Grasshopper Docs

Community documentation for Grasshopper add-ons & plugins


ADDON. Version 2019-Aug-05. Released on 2019-Aug-05. Provides 53 components. Created by Andrew Heumann. Features 2 video tutorials.
Extends Grasshopper's ability to create and reference geometry including lights, blocks, and text objects. Also enables access to information about the active Rhino document, pertaining to materials, layers, linetypes, and other settings.
Document Info
Document Modifications
Texture Mapping


Explode Blocks (BlockExplode)
Explodes a set of Instance Objects into their proper geometry
Explode Blocks Recursively (BlockExplode R)
Recursively explodes a set of Instance Objects into their proper geometry, structured in a Data Tree according to block nesting.
Dynamic Geometry Pipeline (DPipeline)
Defines a Geometry Pipeline from Rhino to Grasshopper, with variable filters for name, object type, and layer.
Hatch Explode (HatchExp)
Gets the geometry and properties of a referenced hatch object
LightProperties (LightProps)
Reads Light Properties from a Rhino.DocObjects.LightObject
Object Attributes (ObjAtts)
Access the individual attributes of a RhinoObject or an ObjectAttributes type.
Reinstate Tree (ReTree)
This component works to bring back data tree structure for referenced geometry that has been baked with "Bake Geometry" with the "Preserve Trees" option enabled.
Objects By Selection (SelObj)
Gets the currently selected objects in Rhino
Sort Objects By Type (SortByType)
Sorts a set of Rhino Objects by type and extracts the Geometry for types that already exist in Grasshopper.
Text Object Info (TxtObjInfo)
Gets the location, orientation plane, alignment, and text from a referenced text object.


Clickable Mesh (ClickM)
Allows you to click in the Rhino Viewport to select from a list of meshes. WARNING! This will harvest ALL Rhino mouse clicks - while enabled you will not be able to use Rhinoas normal.
Convert To Document Units (DocUnits)
Parses a formatted distance string (like 5'-10") and converts it to numerical format in the active document units.
DeleteOnLayer (DelOnLay)
Deletes all objects on specified Layers, then passes true. Useful for appearing to change an object directly in a Rhino document, in order to take advantage of advanced display capabilities.
Deserialize Image from String (Str2Img)
Converts a Base-64 encoded string representing an image to a temp image file and returns the path.
Directory Contents (Dir)
Lists the files in a specified directory.
Filter By Item (IFilter)
Filter a list or lists by a guide list and a subset of that guide list.
Dispatch Multiple (MDispatch)
Dispatch multiple lists at a time. Only retrieves true values - use invert to get the others.
Read 3dm File (3dm)
Reads objects from an external .3dm file
Save Viewport To File (SaveView)
Saves a viewport screenshot or render to a specified filepath.
Serialize Image to String (Img2Str)
Converts an image file into a text string that can be embedded in your file. Don't use it for large images!


Render Curve to Screen (CrvToScreen)
Displays a Curve object in a fixed position on screen
Custom Preview Lineweights (PreviewLW)
Custom Preview with Lineweights
Custom Preview Materials (PreviewMat)
Custom Preview with Materials
Render Mesh to Screen (MeshToScreen)
Displays a Mesh object in a fixed position on screen
Render Point to Screen (PtToScreen)
Displays a Point object in a fixed position on screen
Screen-Oriented Mesh (ScreenMesh)
Displays a Mesh object that remains consistently oriented relative to the screen
Screen-Oriented Text (ScreenText)
Displays text that remains consistently oriented relative to the screen
Screen-To-World Tag (S2WTag)
Creates a special display tag anchored to a location on screen and a location in your model.
Render Text to Screen (TextToScreen)
Displays a text object in a fixed position on screen


Bake Geometry (Bake)
Bake geometry to the document with the specified attributes
CreateAttributes (CreateAtts)
Create Object Attributes
Create Hatch Objects with specified pattern, scale, rotation, and attributes
Create Light Object. So far works well for point lights and directional lights
Define Block (DefBlock)
This component allows you to define or replace a block definition.
JustifiedText3d (Justified Text)
Creates 3d Text objects with specified size, location, alignment, and font.
Places a specified block with the desired transform

Document Info

Font Table (Fonts)
Retrieves the list of system fonts.
Hatch Table (HatchTable)
Gets the hatches from the active Rhino Document
Layer Table (LayerTable)
Gets the list of layers in the active document
Linetype Table (LT Table)
Gets the linetypes from the active Rhino Document
Material Table (MatTable)
Accesses the render materials in the document
Named Views and Display Modes (ViewsAndModes)
Gets a list of the Named Views and Display Modes in this document
Viewport Properties (Viewports)
Get a list of viewports and their properties

Texture Mapping

BoxMapping (BoxMap)
Applies a box texture mapping to a mesh.
Custom Mapping (Custom Map)
Applies per-vertex mesh texture coordinates to a mesh
CylinderMapping (CylinderMap)
Applies a cylindrical texture mapping to a mesh.
PlanarMapping (PlanarMap)
Applies a planar texture mapping to a mesh.
SphericalMapping (SphericalMap)
Applies a spherical texture mapping to a mesh.
SurfaceMapping (SurfaceMap)
Applies a surface UV texture mapping to a mesh.

Document Modifications

Create/Modify Layers (Layers)
Create and Modify Rhino Layers
Create/Modify Materials (Materials)
Create or Edit document Render Materials.
Modify Object Attributes (ModAtts)
Use this component to modify the object attributes of geometry in Rhino.
Modify Viewport (Mod Viewport)
Use this component to restore a named view in a viewport, set its display mode, or set its camera.

Video Tutorials

Site design © Robin Rodricks.   Human and associated data © 2023 Andrew Heumann.  
Rhinoceros and Grasshopper are registered trademarks of Robert McNeel & Associates.  Hosted by GitHub

Report an Issue  |  Terms of Service