How to Write a Simple Script – Grasshopper® and BricsCAD® – P3

By Fleur Dooms 12 min July 30, 2020
How to Write a Simple Script – Grasshopper® and BricsCAD® – P3

Welcome back to the Grasshopper®-BricsCAD® connection blog post series! In the previous post, we looked at the technology behind the Grasshopper-BricsCAD connection. In this post, you will learn how to write a simple Grasshopper script to create a parametric "frame" in BricsCAD. In the next post, you will learn how to add BIM data.

You can follow along step by step or cheat and download the ZIP-folder. Where you'll find the completed scripts.

How to Write a Simple Script- frame

By the end of this post, you should have something like this. This is the framework that will become the patio cover

Get started

First of all, it is important that your Grasshopper-BricsCAD connection is set up correctly. To do this see the Grasshopper-BricsCAD connection help page. Once your connection is up and running, you should see a new tab in the Ribbon, this allows you to launch both Rhino and Grasshopper from within BricsCAD. For this exercise we will only use Grasshopper but you should know that Rhino is actually running in the background anyhow.

How to Write a Simple Script- ribbon

If you are still unsure of the Grasshopper workflow, take a look at Part 1 -- What is Generative Design?.

Launch a new drawing

  1. To start, launch a new BricsCAD drawing. For this example I use millimeters, but you can also work in imperial, if you prefer.
  2. Save the drawing on your computer and launch the Grasshopper command.
  3. Now save the Grasshopper file and you are ready to go!

The input

Next, define the input point of the patio cover. There are several ways to do this, for example, you could specify a rectangle in BricsCAD as a starting entity and then use the corner points of that rectangle as base points. However, for this exercise, I will use a single, 'localization' starting point because this allows the most flexibility later in the script.

The steps

  1. Use the Box command to make a base slab in BricsCAD.How to Write a Simple Script- box-1
  2. Drag and drop a BricsCAD Point component to the Grasshopper canvas, from within the Grasshopper Components Palette 'BricsCAD > Input Geometry'.
  3. Right-click on the component, choose 'Set input point' and choose a location on the top of the slab where you want to define a virtual point.How to Write a Simple Script- point-1
    Note you can't use a regular Rhino Point as input. If you use a Rhino Point, Grasshopper will check the Rhino workspace and not to the BricsCAD workspace.
  4. Link the Point to a Rhino-point Params > Geometry > Point. This will allow you to work with it further and will create a clean script.How to Write a Simple Script- point connect
  5. (Optional) To rename this component (right-click) it. This is handy for maintaining an overview of what this component contains. For this example change the name to 'Corner 1'.How to Write a Simple Script- rename 1-1
  6. (Optional) To keep things even cleaner, select the two components and group them: right-click and select 'Group'.How to Write a Simple Script- group
  7. (Optional) Rename this group to 'Input' group (right-click to rename).How to Write a Simple Script- rename-1

Start simple

Although it's tempting to start by trying to create the most complex shapes you can imagine, it's best to start simple. Use the Move command to 'copy' the localization point to make the other three base points.

The steps

  1. Insert another Rhino-point.
  2. Link it to the Rhino-point of the 'Input' group. This point will be the start of a new group. The new group will make the 4 base points of the patio.How to Write a Simple Script- insert-point
  3. Make a slider for the width with a range of 1 -- 10 meters. To do that:
    1. Double-click on the Grasshopper canvas
    2. Type in 1000<10000 in the search field. This makes a slider (in the units of our drawing, so mm).
    3. Right-click on the name to rename this slider to 'Width'.How to Write a Simple Script- silder
  4. Copy-paste the previous slider and rename it 'Length'.How to Write a Simple Script- length
  5. Add the two sliders to the 'Input' group. Select them, right-click on the 'Input' group and choose 'Add to group'.
  6. To tidy things up, add four Integer components to the canvas, name two 'Width' and two 'Length' and link them to the corresponding sliders. Put one of each in the 'Input' group.How to Write a Simple Script- 6-1
  7. Add a Move-component Transform > Euclidean > Move to the canvas.
  8. Link it to 'Corner 1' point in the 'Geometry' field.How to Write a Simple Script- 8-1
  9. Now try to link the width integer to the 'Motion' field. A warning will display and the component will turn red. This means, that the input type is not valid (see the red balloon to read the full error message).How to Write a Simple Script- 9-1-800x172How come? Grasshopper just doesn't know in which way you want the point to be move over the integer value. Luckily there is a mathematical way to define this and it is called a 'vector'.
    A vector can be defined by two points the start point and the endpoint (through the 'Vector 2Pt'-component). It defines a direction and a length. If you apply this vector to the 'Motion'-field, it will let the component know which translation you want your geometry to undergo.
    Alternatively, a vector can be represented by a unit-vector (a vector with length one) and a length. To do that, you can use the unit-vector that points in the x-direction for the Width, and the unit-vector in the y-direction for the Length.
  10. Add both a 'Unit X' and 'Unit Y' component Vector > Vector to your canvas and as their length (or 'Factor' -- with which you want to scale this unit-vector) you can link them to the 'Width' and the 'Length' integers.How to Write a Simple Script- 10-1
  11. Finally, link the 'Unit X' component to the 'Motion' field.
    You will now see a preview point that is translated according to the slider value in the x-direction.How to Write a Simple Script- 11-1-800x216
    You can put this one again in a 'Point' component that you, for example, name 'Corner 2'.
    Note: to see these points in BricsCAD you need to set PDMODE to 3.
  12. Make a new Rhino 'Point' component and input both 'Corner 1' and 'Corner 2'. Hold down Shift while you link to the second corner point. Name this point 'Corner 1 and 2'.How to Write a Simple Script- start simple 12
  13. Make a 'Move' component. This time add 'Corner 1 and 2' to the 'Geometry' field.
  14. Add the y-vector to the 'Motion' field and ta-da: four points have been created!How to Write a Simple Script- 14-1-800x450
  15. Put the two new points (the output of the last 'Move') in a new Rhino 'Point' component and name this component 'Corner 3 and 4'.How to Write a Simple Script- 15-1-800x215
  16. Group all of the ungrouped elements in a group called 'Make base points'.How to Write a Simple Script- 16-1-800x185

You should now have something that looks like this:

How to Write a Simple Script- START SIMPLE-800x441

Play around

You can now very clearly see the structure of your script appearing. You have an Input group, which defines the input parameters and geometry and you have a first functional group, that makes the base points. You should be able to clearly see the input components at the start of the group and an output component at the end of the group.

So now it is time to play around!

How to Write a Simple Script- play around

The steps

  1. If you did not manage to complete the previous steps, you can download this ZIP-folder and open the 'Start' file.
    Note: You might need to set an input point, as described above.
    If you have different .dwg's open, you might need to link the .gh script to the open .dwg file manually. Click the blue 'Link' button in the Canvas Toolbar of the Grasshopper environment.
  2. Now start playing around! Change up the values of the sliders: you'll see your points move around.
  3. Change the location of your input point: right-click the BricsCAD 'Point' component and choose 'Set one point'. Pick a new location on top of the slab. You'll now see the entire group of points move.
    Tip This is most easily done when the BricsCAD '3D Nearest'-snap is on.

Practice makes perfect!

Now it is time for you to practice your skills and make four more points that will, later on, define the endpoints of the columns. Hint: you will need a new input: a height parameter!

The steps

  1. Make a new slider for the height. (See step 2 of 'Start Simple').How to Write a Simple Script- 1-3
  2. Make a duplicate of 'Corner 1 and 2' and of 'Corner 3 and 4'.How to Write a Simple Script- 2
  3. Make a new 'Move' component. Input a 'Unit Z' in the 'Motion' field (with factor 'Height').How to Write a Simple Script- 3-2
  4. Input the duplicate of 'Corner 1 and 2' in the 'Geometry' field.
  5. Repeat steps 2 and 3 with 'Corner 3 and 4'. You now have the endpoints of your future columns.How to Write a Simple Script- 5
  6. To tidy up your script:
    1. Make a 'Make top points' group out of the new components.How to Write a Simple Script- 6-1-1
    2. Add the input from step 1 to the input group.How to Write a Simple Script- 6-22
    3. To view only the outputs of the groups, select all the components you don't want to see (Shift select them or make a selection window over all of them) and right-click on the canvas and choose 'Preview off'.

If you want to skip this: download this ZIP-folder, which contains the 'Practice makes' script.

Make the column lines

Let's end this blogpost with a (excuse the pun) concrete result and learn how to make the centerlines of the columns and beams that will form the frame of the patio.

The steps

  1. To start the new group with clean input, duplicate the point components (the outputs of the previous groups).How to Write a Simple Script- 1-1-800x216
  2. Make lines between the bottom points and the top points. To do that:
    1. Add a 'Line' component to the canvas (Curve > Primitive).
    2. Add the duplicated 'Corner 1 and 2' to the 'Start Point' field.
    3. Add the duplicated 'Top 1 and 2' to the 'End Point' field of the Line component.
  3. Now repeat step 2 for the third and fourth corners and top points.How to Write a Simple Script- 3-1-e1594810000258-800x220
  4. You should now have the centerlines of your columns and can start to play with the height parameter. On-screen you will see them stretch or crimp.How to Write a Simple Script- 4
  5. To tidy up your script:
    1. Add two 'Line' components (now the one from Params > Geometry)
    2. Link them up to the components from steps 2 and 3 and rename them 'First columns' and 'End columns'.How to Write a Simple Script- 5-2
    3. Group all these components in a 'Define columns' group and hide all previews except this group's output. Now you should see only the columns' centerlines.How to Write a Simple Script- 5-3

You should now have something that looks like this:

How to Write a Simple Script- COLUMN LINES-2048x1128

Complete the frame

And finally, it is time to complete the frame along with the centerlines of the beams. Again there are many options for you to achieve the same result, but perhaps the simplest way is:
How to Write a Simple Script- COMPLETE THE FRAME-800x441

The steps

  1. For the beams, return back to the top points and copy the output components. This will become the input of the next group.How to Write a Simple Script- 1-2
  2. Now make the beams using the 'Polyline' component.
    Note: You can input a collection of points and a polyline to be made in between them. This allows you to easily make a line from your collection of points.How to Write a Simple Script- 4-e1595575437632
  3. Name this line (in a 'Line' component) 'First beam'.How to Write a Simple Script- 6-2-e1595575481374
  4. Repeat steps 2 and 3 to make name this component 'End beam'.How to Write a Simple Script- 6-2
  5. To tidy up group these components, name it 'Make transversal beams'.How to Write a Simple Script- 7

How to Write a Simple Script- frame (1)

Congratulations! You made the framework for our patio cover! Be sure to check in with the next blog post to get the hang of using BricsCAD BIM's profiles in Grasshopper and much more.

Learn Grasshopper for BricsCAD today

Get Grasshopper for BricsCAD BIM

Keep reading:

  1. What is generative design?
  2. The Technology
  3. How to Write a Simple Script

by Fleur Dooms - EMEA Technical Pre-Sales Team Lead at Bricsys®

Fleur, EMEA Technical Pre-Sales Team Lead, brings her natural talent and enthusiasm for technology to Bricsys. Her passion is to pass on her expertise to anyone that even considers saying the word "BIM" and she is constantly looking for innovation and improvements. If you ever need someone to listen to your next great BIM idea, feel free to drop her a line!

April 15, 2024 3 min

BricsCAD® Pro V24.2 - Performance Improvements

BricsCAD V24.2 is here, bringing with it a suite of performance improvements that promise to boost efficiency and stability. Tailored for drafters, designers, and fabricators across all industries, the latest version focuses on accelerating the creation of detailed design documentation essential for building, fabricating, and manufacturing processes. Let's take a closer look at the enhancements in V24.2 that will accelerate your time to deliverable.

April 8, 2024 4 min

Enhanced Drawing Compatibility in BricsCAD® V24.2

In V24.2, we've further enhanced BricsCAD's DWG compatibility to ensure the rapid creation of design documentation by focusing on the 2D drawing creation workflow. To create the smoothest collaboration, we've ensured you can open and edit the drawings you create in BricsCAD in other DWG-based CAD programs. Let's dive into the enhancements we've made!

Follow us on social media