GH_RhinoScriptInterface

Public Class

Plugin Interface object that is exposed via the RhinoScript layer.

Inheritance Hierarchy

System.Object
Grasshopper.Plugin.GH_RhinoScriptInterface

Assembly: Grasshopper (in Grasshopper.dll)

Syntax

public class GH_RhinoScriptInterface

The GH_RhinoScriptInterface type exposes the following members.

Constructors

Name

Description

Public Method

GH_RhinoScriptInterface

Initializes a new instance of the GH_RhinoScriptInterface class

Methods

Name

Description

Public Method

AssignDataToParameter

Find a parameter and assign some persistent data.

Public Method

BakeDataInObject

Find an object and bake all geometry inside of it.

Public Method
Code Example

CloseAllDocuments

Close all Grasshopper documents.

Public Method
Code Example

CloseDocument

Close the currently active Grasshopper document. If there is not active document, nothing will happen.

Public Method
Code Example

DisableBanner

Disables the display of the Grasshopper banner during Component loading. The banner is typically only shown once during a Grasshopper session, namely when the Editor is first loaded.

Public Method
Code Example

DisableSolver

Disables the Grasshopper Solver. If the Solver is disabled, expired components and parameter will not be recomputed, though any existing solution will remain intact.

Public Method
Code Example

EnableBanner

Enables the display of the Grasshopper banner during Component loading. The banner is typically only shown once during a Grasshopper session, namely when the Editor is first loaded.

Public Method
Code Example

EnableSolver

Enables the Grasshopper Solver. If the Solver is enabled, expired components and parameter will be recomputed.

Public Method
Code Example

HideEditor

Hide the main Grasshopper Editor. If the editor hasn’t been loaded or if the Editor is already hidden, nothing will happen.

Public Method
Code Example

IsEditorLoaded

Returns the loaded state of the Grasshopper Main window.

Public Method
Code Example

IsEditorVisible

Returns the visible state of the Grasshopper Main window.

Public Method
Code Example

IsSolverEnabled

Returns the state of the Grasshopper Solver.

Public Method
Code Example

LoadEditor

Load the main Grasshopper Editor. If the editor has already been loaded nothing will happen.

Public Method
Code Example

OpenDocument

Open a Grasshopper document. The editor will be loaded if necessary, but it will not be automatically shown.

Public Method

RunAsCommand

Obsolete.

Public Method

RunHeadless

Public Method

RunInCommandContext

Public Method

RunSolver

Runs the solver once, even if the global solver lock is on.

Public Method
Code Example

SaveDocument

Save the currently active Grasshopper document. If the active document has never been saved, a Save… dialog will be shown. If there is no active document, nothing will happen.

Public Method
Code Example

SaveDocumentAs

Save the currently active Grasshopper document in a specific location. If there is no active document, nothing will happen.

Public Method

SetSliderRangeAndValue

Find a slider and assign a new value.

Public Method

SetSliderValue

Find a slider and assign a new value.

Public Method
Code Example

ShowEditor

Show the main Grasshopper Editor. The editor will be loaded first if needed. If the Editor is already on screen, nothing will happen.