A list of all the Grasshopper components used in MetricMonkey for advanced customisation.
Coming SoonProvides critical components for the MetricMonkey User Interface to function. In general, these components should not be modified.
Deconstructs MetricMonkey Settings into MetricMonkey Functions. Use in conjunction with the Read Settings component.
Input: Settings (MetricMonkey Settings).
Output: Functions (MetricMonkey Function).
Gets live Function data from the MetricMonkey Window.
Input: N/A.
Output: Functions (MetricMonkey Functions).
Creates and launches the MetricMonkey Window (User Interface). Right-click to disable always on top.
Input: Launch (Boolean), Location Cards (MetricMonkey Card), Context Cards (MetricMonkey Card), Site Cards (MetricMonkey Card), Design Cards (MetricMonkey Card), Generate Cards (MetricMonkey Card), Analysis Cards (MetricMonkey Card), Assistant Cards (MetricMonkey Card), and Layers Cards (MetricMonkey Card).
Output: N/A.
Reads the MetricMonkey Settings file (*csv) from the current Rhino model’s folder location. If no settings file can be found, the default settings will be used. Use in conjunction with Deconstruct Settings component.
Input: N/A.
Output: Settings (MetricMonkey Settings).
Creates/saves a *csv file with the MetricMonkey Settings of the current model every time the user saves the Rhino file. The file is named ‘MMS_YYMMDD_File name.csv’.
Input: Active (Boolean).
Output: N/A.
Creates a MetricMonkey Colour Picker field. Use in conjunction with the Custom Card component.
Input: Default Colour (Colour).
Output: Picker (MetricMonkey ColourPicker).
Creates a MetricMonkey Dropdown field. Use in conjunction with the Custom Card component.
Input: Label (Text), Default List (Data), Default Index (Integer).
Output: Dropdown (MetricMonkey Dropdown).
Creates a MetricMonkey Text Box field. Use in conjunction with the Custom Card component.
Input: Label (Text), Default Text (Text), Data Type (Integer).
Output: TextBox (MetricMonkey TextBox).
Creates a MetricMonkey Custom Card. Use in conjunction with the Launch Window component.
Input: Name (Text), Compute (Boolean), Fields (Varies), and Logo (File Path)
Output: Card (MetricMonkey Card).
Sets the list contents of a custom MetricMonkey Dropdown field.
Input:
Output: N/A.
Sets the contents of an existing Metric Monkey Text Box field.
Input:
Output: N/A.
Use to retrieve the values of custom MetricMonkey UI fields. By default it will automatically refresh when those values change.
Input:
Output:
Contains a collection of components to create MetricMonkey classes.
Creates a MetricMonkey Grid from the Crop Box showing Northing and Easting based on the Grid Projection.
Input: Grid Size (Integer), and Crop Box (Curve).
Output: Grids (MetricMonkey Grid).
Imports 2D context datasets based on the datasets selected in the Set Location card. All attributes and values are included from the source. However, keys are modified by adding a “Cadastre”, “Suburb”, or “Road” prefix.
Input: N/A.
Output: Cadastre (MetricMonkey Dataset), Suburb (MetricMonkey Dataset), and Road CL (MetricMonkey Dataset).
Imports 3D context datasets based on the datasets selected in the Set Location card. Use in conjunction with the Simplify Topography component and the Crop Context Buildings component. All keys and values are included from the source.
Input: N/A.
Output: Topography Mesh (Mesh) and Context Buildings (MetricMonkey Dataset).
Imports Planning datasets based on the datasets selected in the Set Location card. All keys and values are included from the source. However, keys are modified by adding a “LNZ”, “FSR”, “HOB” or “HER” prefix.
Input: N/A.
Output: Land Zoning (MetricMonkey Dataset), FSR (MetricMonkey Dataset), HOB (MetricMonkey Dataset), and Heritage (MetricMonkey Dataset).
Input:
Output:
Generates roads based on centreline curves, road widths and fillet radius. Curves are referenced from the MetricMonkey::Context_Roads layer.
Input: Road Dataset (MetricMonkey Dataset).
Output: Roads (MetricMonkey Dataset).
Creates a MetricMonkey Parking Zone based on a closed polycurve and entry point. Geometry is referenced from the MetricMonkey::Site_Car Parking layer. Use in conjunction with the Car Parking Properties component.
Input: N/A.
Output: Parking (MetricMonkey Parking Zone).
Creates a MetricMonkey Zone based on a closed polycurve. Polycurve is referenced from the MetricMonkey::Site_Deep Soil Zone layer.
Input: Lot (MetricMonkey Lot).
Output: Zone (MetricMonkey Zone).
Creates a MetricMonkey Lot from a closed Rhino polycurve. Polycurve is referenced from the MetricMonkey::Site_Lot layer. Use in conjunction with the Create Development and the Get Lot Properties component.
Input: N/A
Output: Lot (MetricMonkey Lot).
Creates a MetricMonkey Lot from a closed Grasshopper polycurve. Use in conjunction with the Create Development and the Get Lot Properties component.
Input: Curve (Curve), ID (Number), FSR Allowed (Number), Site Coverage Allowed (Number), Front Setback (Number), Side Setback (Number), and Rear Setback (Number).
Output: Lot (MetricMonkey Lot).
Creates a MetricMonkey Zone based on a closed polycurve. Polycurve is referenced from the MetricMonkey::Site_Open Space Zone layer.
Input: Lot (MetricMonkey Lot).
Output: Zone (MetricMonkey Zone).
Creates a MetricMonkey Pad based on a closed polycurve. Pads may overlap one another. Their z-position determines if Fill is added, or Cut removed from the topography. If the input curve is not planar, the bottom most point used as the z-value. Polycurve is referenced from the MetricMonkey::Site_Pads layer.
Input: Topography Srf (Surface), and Pad Crvs (Curve).
Output: Pad (MetricMonkey Pad), Topography Solid (Brep), Cut/fill Volume (number), Contours (Curve).
Places trees based on a point. If the point is within a Topography, the point’s height (z-value) will be automatically adjusted to intersect the topography. The trees’ size is globally controlled via the Trunk Radius, Trunk Height, Foliage Radius, and Foliage Height. Points are referenced from the MetricMonkey::Site_Trees layer. Use in conjunction with the Get Tree Properties component.
Input: Topography Srf (Surface) and Tree Pts (Points)
Output: Trees (MetricMonkey Tree)
Creates a MetricMonkey Lot based on an imported cadastre dataset. Use points to select individual lots or draw a polycurve to amalgamate multiple lots into a single lot. For individual lots, ID and FSR properties are inherited from the original dataset.
Input: Cadastre (MetricMonkey Dataset), and FSR (MetricMonkey Dataset).
Output: Lot (MetricMonkey Lot).
Creates a MetricMonkey Development from MetricMonkey Masses and Lots.
Inputs: Mass (MetricMonkey Mass), and Lot (MetricMonkey Lot).
Outputs: Development (MetricMonkey Development), Buildings (MetricMonkey Building), and Lots (MetricMonkey Lot).
Creates a MetricMonkey Mass from a closed Rhino brep. Brep is referenced from the MetricMonkey::Design_Mass layer. Use in conjunction with the Create Development and the Get Mass Properties component.
Input: N/A
Output: Mass (MetricMonkey Mass).
Creates a MetricMonkey Mass from a closed Rhino polycurve. Polycurve is referenced from the MetricMonkey::Design_Mass layer. Use in conjunction with the Create Development and the Get Mass Properties component.
Input: N/A
Output: Mass (MetricMonkey Mass).
Creates a MetricMonkey Mass from a closed Grasshopper brep. Use in conjunction with the Create Development and the Get Mass Properties component.
Input: Brep (Brep), Function (MetricMonkey Function), Hierarchy (Integer), and Efficiency Type (Integer).
Output: Mass (MetricMonkey Mass).
Creates a MetricMonkey Mass from a closed Grasshopper polycurve representing the building footprint. Use in conjunction with the Create Development and the Get Mass Properties component.
Input: Curve (Curve), Function (MetricMonkey Function), Hierarchy (Integer), Height (Number), Storeys (Integer), and Efficiency Type (Integer)
Output: Mass (MetricMonkey Mass).
Input:
Output:
Creates a MetricMonkey Stair based on a Corridor. The location is governed by the maximum dead-end distance and the maximum spacing between alternate exits. The size is based on a continuous vertical shaft given the varying floor-to-floor heights of the building. As a result, the number of flights per floor may vary. Use in conjunction with the Get Stair Properties component.
Input: Development (MetricMonkey Development), and Party Wall Grid (Curves).
Output: Stair (MetricMonkey Stair).
Contains a collection of components to deconstruct MetricMonkey classes.
Deconstructs a MetricMonkey Dataset into its constituent properties.
Input: Dataset (MetricMonkey Dataset).
Output: Keys (Text), Geometry (Geometry), and Values (Text).
Deconstructs a MetricMonkey Location Grid into its constituent properties. Use in conjunction with the Create Location Grid component.
Input: Grid (MetricMonkey Location Grid).
Output: Northing Lines (Line), Northing Value (Number), Easting Lines (Line), and Easting Values (Number).
Takes a Cadastre dataset and filters lots based on filters defined from the user interface.
Input: Cadastre Dataset (MetricMonkey Dataset).
Output:
Deconstructs a MetricMonkey Lot into its constituent properties. Use in conjunction with the Create Development component.
Input: Lot (MetricMonkey Lot)
Output: ID (Text), Curves (Curve), Surfaces (Surface), Area (Number), FSR (Number), FSR Allowed (Number), GFA Allowed (Number), Site Coverage Allowed (Number), Site Coverage (Number), and Site Coverage Delta (Number).
Deconstructs a MetricMonkey Topography into its constituent properties. Use in conjunction with the Detailed Topography component.
Input: Topography (MetricMonkey Topography).
Output:
Deconstructs a MetricMonkey Tree into its constituent properties. Use in conjunction with the Place Trees component.
Input: Trees (MetricMonkey Tree)
Output: Location (Point), Trunk (Brep), and Foliage (Brep).
Deconstructs a MetricMonkey Building into its constituent properties. Use in conjunction with the Create Development component.
Input: Building (MetricMonkey Building).
Output: ID (Text), Height (Number), MaxRL (Number), MinRL (Number), GBA (Number), GFA (Number), Plane (Plane), Geometry (Geometry), Massing (MetricMonkey Mass), Levels (MetricMonkey Level), Floorplates (MetricMonkey Floorplate), and Envelope (MetricMonkey Envelope).
Deconstructs a MetricMonkey Development into its constituent properties. Use in conjunction with the Create Development component.
Input: Development (MetricMonkey Development).
Output: Lot Area (Number), FSR (Number), GBA (Number), GFA (Number), Height (Number), MaxRL (Number), and MinRL (Number).
Deconstructs a MetricMonkey Envelope into its constituent properties. Use in conjunction with the Get Building Properties component (upstream) and the Get Item Properties component (downstream).
Input: Envelope (MetricMonkey Envelope).
Output: Roof Item (MetricMonkey Roof), Facade Item (MetricMonkey Façade), and Base Item (MetricMonkey Base).
Deconstructs a MetricMonkey Floorplate into its constituent properties. Accepts both building and massing floorplates.
Input: Floorplate (MetricMonkey Floorplate).
Output: Curve (Curve), Surface (Surface), Slab (Brep), Colour (Colour), Function (MetricMonkey Function), GBA (Number), GFA (Number), and Level (MetricMonkey Level).
Returns a MetricMonkey Function given a name. Use in conjunction with the Function Listener component.
Input: Functions (MetricMonkey Functions), and Name (Text).
Output: Function (MetricMonkey Function).
Deconstructs a MetricMonkey Function into its constituent properties.
Input: Functions (MetricMonkey Function), and Name (Text).
Output: Name (Text), Colour (Colour), Atypical Levels (MetricMonkey Levels), Atypical Heights (Number), Typical Height (Number), Slab Thickness (Number), Roof Build-Up (Number), Lift Overrun (Number), Efficiencies (Number).
Deconstructs a MetricMonkey Function into its constituent properties given a name. Use in conjunction with the Function Listener component.
Input: Functions (MetricMonkey Function), and Name (Text).
Output: Name (Text), Colour (Colour), Atypical Levels (MetricMonkey Levels), Atypical Heights (Number), Typical Height (Number), Slab Thickness (Number), Roof Build-Up (Number), Lift Overrun (Number), Efficiencies (Number).
Deconstructs a MetricMonkey Item into its constituent properties. Accepts MetricMonkey Roofs, MetricMonkey Façades, and MetricMonkey Base Items. Use in conjunction with the Get Envelope Properties component.
Input: Item (MetricMonkey Item).
Output: Geometry (Geometry), Function (Text), and Colour (Colour).
Deconstructs a MetricMonkey Level into its constituent properties.
Input: Level (MetricMonkey Level).
Output: ID (Text), Name (Text), Plane (Plane), and Parent (MetricMonkey Building).
Deconstructs a MetricMonkey building Massing into its constituent properties.
Input: Massing (MetricMonkey Mass).
Output: Height (Number), Storeys (Integer), Hierarchy (Integer), Efficiency Type (Integer), GBA (Number), GFA (Number), Function (MetricMonkey Function), Colour (Colour), Geometry (Geometry), Lot (MetricMonkey Lot), Levels (MetricMonkey Lot), Lift Overrun (Number), Floorplates (MetricMonkey Floorplate), and Roof (MetricMonkey Roof).
Deconstructs a MetricMonkey Roof into its constituent properties. Use in conjunction with the Get Mass Properties component.
Input: Roof (MetricMonkey Roof).
Output: Geometry (Geometry), and Colour (Colour).
Deconstructs a MetricMonkey Corridor into its constituent properties.
Input: Corridor (MetricMonkey Corridor).
Output: CL Curve (Curve), Wall CL Curve (Curve), Surface (Surface), Volume (Brep), and Colour (Colour).
Deconstructs a MetricMonkey Stair into its constituent properties. Use in conjunction with the Create Stairs component.
Input: Stair (MetricMonkey Stair).
Output:
Given a Source Point, it shows the area visible on a horizontal plane through 360 degrees.
Input: Obstructions (Geometry), and Radius (Number).
Output: Isovist (Surface).
Creates a Figure-Ground diagram, also known as Nolli diagram, to illustrates the relationship between built (figure) and unbuilt space (ground). Ensure that Context Buildings have been imported or referenced into the project.
Input: Context (Geometry), and Topography Surface (Geometry)
Output: Figure Ground Surface (Surface).
Input:
Output:
Input:
Output:
Input:
Output:
Input:
Output:
Input:
Output:
Performs a GIS intersection of a cadastre dataset and overlay datasets to embed off the metadata into the cadastre dataset.
Input: CadastreDataset (MetricMonkey Dataset), and Intersecting Datasets (MetricMonkey Dataset).
Output: Cadastre Dataset (MetricMonkey Dataset).
Crops and separates the Context Buildings based on the Crop Box and Mask Region. Accepts surfaces, breps, and meshes. Where possible, breps and meshes are capped to create a solid brep/mesh.
Input: Context Buildings (Geometry).
Output: Context Buildings (Geometry), and Demolished Context (Geometry).
Modifies a Topography Mesh by converting it to a Topography Surface using the Sampling Distance to determine the spacing of control points. Use in conjunction with Import 3D Context component.
Input: Topography Mesh (Mesh), and Sampling Distance (Number).
Output: Topography Srf (Surface), and Max Deviation (Number).
Modifies the simplified Topography Surface to include a high-resolution topography relative to the Lot. The lot’s bounding box is used and rounded to the nearest 5m increment, plus the Buffer Distance. Use in conjunction with the Get Topography Properties component.
Input: Simplified Topography (Surface), Topography Mesh (Mesh), Lot (MetricMonkey Lots), and Buffer Distance (Number).
Output: Topography (MetricMonkey Topography).
Generates site setback zones given the lot boundary and the front, side and rear setback values.
Input: Lot (MetricMonkey Lot).
Output: Setback Region (Geometry), Building Region(Geoemetry).
Creates an aligned dimension given two points.
Input: Start Point (point), End Point (Point), Offset (Number), Plane (Plane), and Style (Text).
Output: Dimension (Dimension).
Create or modifies a directional light in the scene.
Input: Light GUID (ID), Axis (Line), Colour (Colour), Intensity (Number), and Bake (Boolean).
Output: Light GUID (ID).
Create or modifies a point light in the scene.
Input: Light GUID (ID), Axis (Line), Colour (Colour), Intensity (Number), and Bake (Boolean).
Output: Light GUID (ID).
Creates a hatch. Use in conjunction with the Get Rhino Hatch Pattern component.
Input: Curves (Geometry), Hatch Name (Text), Angle (Number), Scale (Number), Colour (Colour), Layer Name (Text), Bake (Boolean).
Output: Boundaries (Geometry), Hatch (Geometry).
Creates a Rhino layer with attributes. If the layer already exists, attributes will be modified.
Input: Layer Name (Text), Display Colour (Colour), Linetype (Text), Material (Colour), Is Visible (Boolean), Plot Colour (Colour), Plot Weight (Number), Is Locked (Boolean), and Update (Boolean).
Output: Layer Name (Text), and Layer Index (Integer).
Custom display preview of curves.
Input: Curve (Curve), Width (Number), Colour (Colour), and Dash (Text).
Output: N/A.
Dynamically reference Rhino geometry. Automatically live streams. Right-click to enable full-layer name and/or command update.
Input: Layer Name (Text), Geometry Type (Text), and Rhino Object Name (Text).
Output: Referenced Geometry (Geometry).
Gets the Grasshopper document information. Right-click to enable live stream.
Input: Update (Boolean).
Output: File Name (Text), Author (Text), Date Created (Text), Last Time Saved (Text), File Path (Text), Components (Data), Params (Data), Third Party Assemblies GHA (Data), and Third Party Assemblies GHUSER (Data).
Get Rhino’s default list of major city locations.
Input: N/A.
Output: Locations (Text).
Deconstructs a Rhino city location into its constituent properties. Use in conjunction with the Get Locations component.
Input: Location (Text).
Output: Name (Text), Latitude (Number), Longitude (Number), and Time Zone (Number).
Gets a list of display modes in the current project.
Input: Update (Boolean).
Output: Active Display Mode (Text), and All Display Modes (Text).
Gets all hatch pattern names in the current Rhino document.
Input: Update (Boolean).
Output: Hatches (Text).
Gets a Rhino layer’s properties given its name. For nested layers use ParentLayer::NestedLayer. Right-click to enable live stream.
Input: Full Layer Name (Text).
Output: Index (Integer), Layer Name (Text), Colour (Colour), Linetype (Text), Material (Text), Is Visible (Boolean), Is Locked (Boolean), Is Deleted (Boolean), Plot Colour (Colour), and Plot Weight (Number).
Get a list of Rhino layers and their properties in the active document. Right-click to enable live stream.
Input: Update (Boolean).
Output: Layer Name (Text), Full Layer Name (Text), Colour (Colour), Linetype (Text), Material Name (Text), Is Visible (Boolean), Is Locked (Boolean), Plot Colour (Colour), Plot Weight (Number), and Is Active Layer (Boolean).
Gets selected objects from the current Rhino document. Right-click to enable live stream.
Input: Update (Boolean).
Output: Referenced Geometry (Geometry).
Get the units of the active Rhino document. Right-click to enable live stream.
Input: Update (Boolean), and Conversion Factor (Integer).
Output: Document Units (Text), Document Units Abbreviations (Text), Units Index (Integer), All Units (Text), Conversion Factor (Number).
Sets the active (current) layer in the Rhino document.
Input: Update (Boolean), and Layer Name (Text).
Output: Successful (Boolean), Previous Active Layer (Text).
Sets the project location based on a given latitude and longitude.
Input: Latitude (Number), and Longitude (Number).
Output: N/A.
Sets a viewport’s display mode and camera.
Input: Viewport Name (Text), Display Mode (Text), Camera Location (Point), Camera Target (Point), Camera Projection (Boolean), Camera Lens Length (Number), and Camera Up Vector (Vector).
Output: N/A.
Reads potential Coordinate Reference System (CRS) values from a category.
Input: Projection Category (Text), Is Geographic (Boolean).
Output: Coordinate Reference System (Text).
Reads data from ASCII files that have an ESRI format. The component does not do unit conversion.
Input: File Path (text), Interpolate Raster (Boolean), Read (Boolean).
Output: Geometry (Geometry), and Info (Text).
Reads data from an *xlsx file. File must be closed for component to work.
Input: Workbook Path (Text), Worksheet Name (Text), and Read (Boolean).
Output: Worksheet Data (Data).
Reads data from a *GeoTIFF file. Component does not do unit conversion.
Input: File Path (Text), and Read (Boolean).
Output: Geometry (Geometry), and Info (Text).
Reads data from a *shp file. Use in conjunction with the Coordinate Reference System (CRS) component.
Input: Path (Text), Coordinate Reference System (Text), and Read (Boolean).
Output: Geometry (Geometry), Keys (Text), and Values (Text).
Writes data to new or existing *xlsx file. Use dynamic UI to add and rename worksheets.
Input: Write (Boolean), Workbook Path (Text), and Sheet1 (Data).
Output: N/A
Bake geometry with attributes. Use in conjunction with the Create Object Attributes component.
Input: Geometry (Geometry), Attributes (Data), Cache (Text), and Bake (Boolean).
Output: N/A.
Creates object attributes. To be used in conjunction with Bake with Attributes component. Right-click to create a new layer if the layer name is not present in the current Rhino document.
Input: Name (Text), Layer Name (Text), Attribute Source (Integer), Display Colour (Colour), Material (Text), Linetype (Text), Group Indices (Integer), Plot Colour (Colour), Plot Weight (Number), Is Visible (Boolean), User Text Keys (Text), and User Text Values (Text).
Output: Attributes (Data).
Gets the attributes from Rhino geometry. Right-click to enable live stream.
Input: Geometry (Geometry).
Output: Name (Text), Layer (Text), Layer Full Path (Text), Display Colour (Colour), Material (Text), Linetype (Text), Group Indices (Integer), Plot Colour (Colour), Line Weight (Number), Object Type (Text), Is Visible (Boolean), User Text Keys (Text), and User Text Values (Text).
Gets the user text attributes from Rhino geometry. Right-click to enable live stream.
Input: Geometry (Geometry).
Output: User Text Keys (Text), and User Text Values (Text).
Gets user text values from Rhino geometry. Right-click to enable live stream.
Input: Reference geometry (Geometry), User Text Keys (Text).
Output: User Text Values (Text).
Sets the object attributes of Rhino geometry. Use in conjunction with the Create Object Attributes component.
Input: Reference Geometry (Geometry), Attributes (Data), and Update (Boolean).
Output: N/A
Set user text attributes of Rhino geometry. Right-click to enable rewrite.
Input: Reference Geometry (Geometry), User Text Keys (Text), User Text Values (Text), and Update (Boolean).
Output: N/A
Converts a numeric value from one unit system to another. Right-click to define conversion function.
Input: Value (Number), From Unit System (Integer), To Unit System (Integer).
Output: Value (Number).
Convert Latitude/Longitude to Universal Transverse Mercator (UTM) projection.
Input: Latitude (Number), and Longitude (Number).
Output: Zone (Integer), Zone Designator (Text), Easting (Number), and Northing (Number).
Vector(s) indicating the direction of sunlight for each sun position on the sun path. Note that these vectors point downwards towards the ground.
Input: Latitude (Number), Longitude (Number), Time Zone (Number), North (Vector), From Month (Integer), To Month (Integer), From Day (Integer), To Day (Integer), From Hour (Integer), To Hour (Integer), Time Step (Integer).
Output: Positions (Point), Vectors (Vector), and Dates (Date/Time).
Convert Universal Transverse Mercator (UTM) projection to Latitude/Longitude.
Input: Zone (Integer), Zone Designator (Text), Easting (Number), and Northing (Number).
Output: Latitude (Number), and Longitude (Number).
Imports in the sun access planes as defined in Schedule 6A of the Sydney Local Environmental Plan 2012. Use in conjunction with the Sydney HOB component.
Input: N/A
Output: SAP Srf (Surface), SAP Name (Text), and SAP Volume (Brep).
Generates the Height of Building (HOB) volumes based on the Sydney Local Environmental Plan 2012.
Input: Topography Srf (Surface), HOB (MetricMonkey Dataset), and SAP Volume (Brep)
Output: HOB Volumes (MetricMonkey Dataset).
Copyright © 2023 Parametric Monkey. MetricMonkey is a registered trademark of Parametric Monkey Pty Ltd.