Grasshopper Docs

Community documentation for Grasshopper add-ons & plugins

0 | Ladybug
1 | AnalyzeWeatherData
2 | VisualizeWeatherData
3 | EnvironmentalAnalysis
4 | Renewables
5 | Extra
6 | Developers
7 | WIP

Use this component to render Rhino views and save them to your hard drive. This component is fully-functional with both Rhino Render and V-Ray for Rhino. Other rendering plugins may still work but are not fully supported yet.
This component is particularly useful if you are trying to create animations of Grasshopper geometry and want to automate the capturing of views.

Inputs

NameIDDescriptionType
File Name_fileNameThe file name that you would like the image to be saved as. Note that, for animations, you want to make sure that each saved images has a different filename otherwise the previous image will be overwritten by each successive image.Goo
Folderfolder_The folder into which you would like to write the image file. This should be a complete file path to the folder. If no folder is provided, the images will be written to C:/Ladybug/Capturedviews/.Goo
Render TimerenderTime_An optional number in seconds that represents the time you anticipate the render taking. This can be used to create rendered animations for V-Ray 3, which currently does not have a dot net interface.Goo
View NamesviewNames_The Rhino viewport name which you would like to render. Acceptable inputs include "Perspective", "Top", "Bottom", "Left", "Right", "Front", "Back" or any view name that you have already saved within the Rhino file (note that you do not need to input quotations). If no text is input here, the default will be an image of the active viewport (or the last viewport in which you navigated).Goo
Image WidthimageWidth_The width of the image that you would like to render in pixels. If no value is provided here, the component will set the width to that of the active Rhino viewport on your screen.Goo
Image HeightimageHeight_The height of the image that you would like to render in pixels. If no value is provided here, the component will set the height to that of the active Rhino viewport on your screen.Goo
Keep Aspect RkeepAspectR_Set to "True" to keep the aspect ratio of the viewport in the images that you save. By default, this is set to "False" if you have connected an imageHeight_ but will override this input to ensure correct aspect ratio if set to "True".Goo
Save AlphasaveAlpha_Set to "True" to have an alpah image saved next to the RGB rendering and set to "False" to have only have the RGB image saved. The default is set to "False" to only save the RGB.Goo
Capture_captureSet to "True" to render the image and save it to your hard drive.Goo

Outputs

NameIDDescriptionType
OutputreadMe!The filepath of the image taken with this component.String
Image PathimagePathThe filepath of the image taken with this component.Goo

Video Tutorials

Site design © Robin Rodricks.   Co-created by Andrew Heumann.   Ladybug and associated data © 2020 Ladybug Tools.  
Rhinoceros and Grasshopper are registered trademarks of Robert McNeel & Associates.  Hosted by GitHub

Report an Issue  |  Terms of Service