Grasshopper.Kernel Namespace

Basic implementation of IGH_ActiveObject interface. Derive from this class rather than implementing IGH_ActiveObject to make your life easier.

Represents a single alias|target combo.

Implement this interface once (and once only) in a GHA project if you wish to add additional information about your library to Grasshopper. Note you must supply an empty constructor.

Provides basic properties for a GHA assembly that does not expose a type that derives from GH_AssemblyInfo. This type is created automatically when a GH_AssemblyInfo type is not found in an assembly.

Derive from this class if you wish to perform additional steps before any of your components are loaded. Any class in your project which inherits from GH_AssemblyPriority and which has an empty constructor will be instantiated prior to any GH_Component or IGH_DocumentObject classes.

Derive from this class rather than implementing IGH_Attributes from scratch.

Event arguments passed during AttributesChanged events.

Maintains author information such as name, company, copyright, address etc.

Provides access to all AutoSave event flags.

A utility class for baking. We heavily recommend you use this for any baking, as it handles invalid objects correctly.

Inherit from this class if you wish to create a custom component. Note that you must provide a public, empty constructor which calls the base class constructor.

This class is used during Component construction to add input parameters.

This class is used during Component construction to add output parameters.

Wraps all members and functions needed for GH_Component to manage its input and output parameters.

Maintains proxies for all components, parameters and other object types as defined in all grasshopper assemblies.

Represents a complete connectivity diagram (topology) of a GH_Document. A connectivity diagram is basically an undirected network of all the wires in a document.

Maintains two connectivity diagrams, one of which is a subset of the other.

Represents a single node in a Grasshopper connectivity diagram. A single node represents a single IGH_Param instance.

Provides static converters for different data types inside Grasshopper. This class both has specific and generic converters.

RhinoCommon only event server.

Writer object used to create debug logs.

Arguments for display events.

These arguments are passed along with SettingsChanged events on GH_Document.

These arguments are passed along with SettingsChanged events on GH_Document.

These arguments are passed along with FilePathChanged events on GH_Document.

These arguments are passed along with ModifiedChanged events on GH_Document.

These arguments are passed along with ObjectsAdded and ObjectsRemoved events on GH_Document.

These arguments are passed along with SettingsChanged events on GH_Document.

Represents a single Grasshopper document.

RhinoCommon only event server.

Provides basic IO operations for GH_Documents.

Standard implementation of IGH_DocumentObject.

Manages and maintains a collection of GH_Documents.

Represents a hierarchical tree of documents that are subsidiary to one another.

Represents a single node in a document tree.

These arguments are passed along with UndoStateChanged events on GH_Document.

Represents information about external files to be loaded.

Provides a easy-to-use way to keep tabs on files.

Provides easy mechanisms to monitor changes to the local File System.

Maintains a collection of standard fonts and mays to measure them.

Provides standard Grasshopper formatting functions.

Event arguments used in the GH_GHALoaded event on GH_ComponentServer.

Provides static methods for harvesting data from GHX and GH files.

Base implementation of IGH_InstanceDescription. Consider deriving from this class rather than implementing IGH_InstanceDescription from scratch.

Provides basic functionality for the custom ReadFile component script parsing.

Provides utilities for dealing with list of Data from input parameters.

Assembly loading behaviour attribute.

Utility class for ultra-fast bitmap sampling and filters.

Event arguments passed during ObjectChanged events.

Base implementation of IGH_Param. Derive from this class rather than implementing IGH_Param from scratch. If your parameter can store persistent data, derive from GH_PersistentParam(Of T) instead.

Data passed to IGH_ContextualParameter.AutoAssignContextualData to help define a context state of Rhino/Grasshopper

Arguments used in events for the GH_ComponentParamServer type.

Derives from GH_PersistentParam(Of T), but adds some useful functions for dealing with geometric data types.

Implementation of GH_Param(Of T) that supports persistent data.

Event arguments passed during PingDocument events.

This class is passed to Objects that implement IGH_PreviewObject during drawing operations.

A closed boundary for filtering previewed objects.

Arguments for preview events.

This class is passed to objects that implement IGH_PreviewData during mesh drawing operations.

This class exposes functionality that makes it easy to draw temporary geometry in Rhino viewports.

This class is passed to objects that implement IGH_PreviewData during wire drawing operations.

Contains information about relevant objects at a specific canvas location.

This class is passed to objects that implement IGH_RenderAwareData or IGH_RenderAwareObject during render queue operations.

Contains all fields that together define a RuntimeMessage. Runtime Messages are created and recorded by document objects during Grasshopper solutions.

A single instance of this class is maintained at module level under the accessor "Settings".

Event arguments used for Document Solution events.

Arguments for solution events.

Represents a single recorded document state. A state contains values for an arbitrary set of objects inside the document.

Maintains all the recorded states for this document.

Abstract implementation of the IGH_StateTag interface. Derive from this class rather than implementing IGH_StateTag.

Maintains a collection of IGH_StateTag objects.

Abstract implementation of IGH_TaskCapableComponent. Inherit from this class instead of implementing IGH_TaskCapableComponent directly.

Utility module that caches a number of oft-used types and type-ids for quick access. Do not change any of the values in this module or you'll wreck casting and conversion logic.

Exposes several utility functions for migrating parameters and wires between components useful while upgrading components.

Represents a custom user object. A User Object is an existing IGH_DocumentObject with overridden icon, instance description and exposure.

Represents the abstract base implementation of the IGH_ValueProxy interface.

Basic implementation of IGH_ZuiAction.

Represents a folder from which GHA files are loaded.

Represents the time interval for a GH_Document solution.

Synch object for tracking long term changes to the parameter server.

Base interface for all objects on the canvas that participate in solutions

Base interface for all Attributes. Attributes are the visual portion of GH_DocumentObjects. They handle display, mouse events, layout, context menus etc. etc. You should consider inheriting from GH_Attributes or some other abstract class instead of implementing this interface from scratch.

Provides of collection of basic author details.

Implement this interface in your IGH_Goo data type if you want to be included in baking operations.

Implement this interface on your IGH_ActiveObject if you want to participate in the Bake GUI.

Base interface for all GH_Component types. Do not implement this interface from scratch, inherit from GH_Component instead.

Base interface for contextual components. This makes accessing non-strongly-typed functionality easier.

Base interface for contextual parameters. This makes accessing non-strongly-typed functionality easier.

Version 2 of Base interface for contextual parameters. This makes accessing non-strongly-typed functionality easier.

Provides access to component parameters, in order to retrieve and assign data during solutions.

Implement this interface to participate in Debug Logging.

Base interface for objects that want to play on the Canvas. Do not implement this interface from scratch. Either inherit from GH_DocumentObject or one of the other partially finished types such as GH_ActiveObject, GH_Param(Of T) or GH_Component.

Implement this interface if you want to be the owner assigned to a document in the Grasshopper documentserver.

Implement this interface if you want to inter-operate with a GH_EventServer.

Implement this interface in your IGH_DocumentObject class if you want to handle initialization codes from Canvas Search boxes.

Base interface for all objects that participate in the Grasshopper GUI.

Implement this interface in your IGH_DocumentObject class if you want to be informed when the InstanceGuids of objects in the document are mutated.

Provides proxy data for all Grasshopper components and parameters.

Base interface for all Parameter types in Grasshopper. Do not implement this interface from scratch, derive from GH_Param or GH_PersistentParam instead.

Preview display arguments for IGH_PreviewObjects.

All IGH_Goo types that wish to participate in Viewport redraws must implement this interface.

Implement this interface if your data deals with preview meshes.

All IGH_DocumentObjects that wish to participate in Viewport redraws must implement this interface.

Implement this interface in your IGH_Goo type if it may have render geometry.

Implement this interface if you want to be included in state saving/loading.

A StateTag is a visual feedback mechanism that reflects a certain local setting of an Object.

GH_Component that can choose to support the use of Tasks to compute solutions When UseTasks returns true, the component has it's SolveInstance enumeration called twice. The first pass (InPreSolve=True) is intended solely for collecting data and starting calculation tasks. The second pass (InPreSolve=False) takes results or the tasks and sets the output.

Create a class with an empty constructor that implements this interface if you want to provide an upgrade mechanism.

Implement this interface in your IGH_Param if you want to allow users to set data either through the menu or by double clicking.

Implement this interface in your component if you want to enable variable parameter UI.

Represents a single action which is only visible on screen above a certain zoom level.

Implement this interface in a parameter or component if you want to be publishable on the remote control panel.

Callback signature for Scheduled Solutions.

This delegate is called when changes to a certain file occur.

Delegate method for file change callbacks.

Delegate method for file change callbacks.

Drawing delegate.

Enumerates possible types of object arrangement.

Different types of events that can cause an AutoSave.

Lists all possible channels for 24 and 32 bit bitmaps.

Enumerates all possible clipboards for GH_DocumentIO operations.

Level flag for conversion algorithms.

Enumerates all possible Data Matching algorithms for Components.

Enumerates all parameter data mapping types.

Enumerates all possible (de)activation contexts for documents.

Enumerates all possible document rankings.

Enumerates all possible types of settings for a GH_Document.

Lists the different kinds of GUI exposure an object can have.

Enumerates the possible external files that Grasshopper is interested in.

Enumerates all possible file watcher events. These can be combined.

Enumerates all object Search filters.

Enumerates typical getter results.

Contains a list of all possible Assembly GUID conflict solutions

Lists all display modes that individual objects can have.

Enumerates the possible library types for GHA assemblies.

Enumerates the possible actions a line parser can invoke.

Enumerates all assembly loading behaviour demands.

Enumerates all external GHA loading process instructions.

Enumerates all assembly loading mechanisms.

All possible string matching schemes.

Weighting factors of string matches.

Represents common changes which can cause the ObjectChanged event to be raised.

Contains all object species.

Enumerates all types of object that can be referenced by a GH_ObjectProxy instance.

Enumerates the types of access that parameters support.

Enumerates the possible states of being for data inside a parameter.

Enumerates possible sides for variable parameters.

Enumerates all accepted fields for hashing parameter data.

Enumerates the different guises of parameter

Enumerates the possible wire display types for parameters.

Represents the different ways in which picking rectangles can behave.

Enumerates the possible folder types for GH_AssemblyFolderInfo

Lists all possible Grasshopper preview filters.

Enumerates possible meshing parameters for documents.

Lists all possible Grasshopper preview modes.

Enumerates the different possible states in which the masterness of a parameter can occur.

Enumerates all possible solution states in which the document can be.

Lists all profiler modes.

Enumerates the possible filters to use in relevant object searches.

Indicates the severity of a runtime message.

Enumerates the possible effects of a specific selection operation.

Enumerates the possible selection topologies.

Lists all the data types available in the GH_SettingsServer class.

Enumerates all solution modes.

The Phase flags are used to track object states during solutions.

Enumerates the possible layout directions for parameter state tags.

Enumerates the possible kinds that a System.DateTime value can imply.

Enumerates all possible types of undo operation.