Commands

public module Commands
Contains command logic for all standard Grasshopper commands.

Properties

BakeDocument

#
public static GH_Document BakeDocument { get; set; }
Gets or sets the document that will be baked. If you set the document, default Bake behaviour kicks in and all selected objects will be baked.

BakeObject

#
public static IGH_ActiveObject BakeObject { get; set; }
Gets or sets the active object for baking operations. If you do not set a document, then you can choose to set the active object. Specific bake behaviour kicks in.

Methods

Run_Grasshopper

#
public static bool Run_Grasshopper()
Run the _Grasshopper command logic.
Returns: True on success, false on failure.

Run_GrasshopperBake

#
public static bool Run_GrasshopperBake()
Run the _GrasshopperBake command logic. This command requires either the BakeDocument or the BakeObject fields to be set. This command is typically run from within the Grasshopper GUI, it should be hidden from the user.
Returns: True on success, false on failure. (Redraw required on success)

Run_GrasshopperBake

#
public static bool Run_GrasshopperBake(RhinoDoc doc, RunMode mode)
Run the _GrasshopperBake command logic. This command requires either the BakeDocument or the BakeObject fields to be set. This command is typically run from within the Grasshopper GUI, it should be hidden from the user.
Parameters:
doc (RhinoDoc)
mode (RunMode)
Returns: True on success, false on failure. (Redraw required on success)

Run_GrasshopperExportHelp

#
public static bool Run_GrasshopperExportHelp()
Run the _GrasshopperExportHelp command logic.
Returns: True on success, false on failure.

Run_GrasshopperFolders

#
public static bool Run_GrasshopperFolders()
Run the _GrasshopperFolder command.
Returns: True on success, false on cancel.

Run_GrasshopperGetSDKDocumentation

#
public static bool Run_GrasshopperGetSDKDocumentation()
Run the _GrasshopperDownloadSDKDocumentation command logic.
Returns: True on success, false on failure.

Run_GrasshopperOpen

#
public static bool Run_GrasshopperOpen()
Run the GrasshopperOpen command logic.
Returns: True if a file was opened.

Run_GrasshopperOpen

#
public static bool Run_GrasshopperOpen(string path)
Parameters:
path (string)

Run_GrasshopperReloadAssemblies

#
public static List<string> Run_GrasshopperReloadAssemblies()
Run the _GrasshopperReloadMemoryAssemblies command logic.
Returns: List of assemblies that were reloaded.

Run_GrasshopperScripted

#
public static bool Run_GrasshopperScripted()
Run the -_Grasshopper command logic (the scripted version).
Returns: True on success, false on failure.

Run_GrasshopperUnloadPlugin

#
public static bool Run_GrasshopperUnloadPlugin()
Run the _GrasshopperUnloadPlugin command logic.
Returns: True on success, false on failure.