Grasshopper2.Docnamespace

Provides the methods required for the UI interaction with document objects. Attributes are typically *not* deserialized, so all persistent properties ought to be part of the owner document object.

Implement this interface in your IDocumentObject IAttributes class if you wish to modify the cursor.

Defines the rules and regulations for any object that wishes to be part of an IDocument.

Implement this interface in your IDocumentObject type in order to host another document inside it. For example Chain and Cluster objects are document parents.

Implement this interface in your IDocumentObject if you wish to be notified about object instance id changes.

Objects which can be initialised with user specified arguments may implement this interface.

Implement this interface in your IDocumentObject class if you wish to provide UI for locking certain properties of the object.

Implement this interface in your Attributes class to inform the canvas that any mousemoves (even ones not coincident with the attributes) may invalidate the attributes. This is typically used for mouse-hover feedback.

Interface for read-only access to object connectivity data.

Parameter attributes. This interface extends IAttributes by providing Inlet and Outlet points.

Any IDocumentObject which wishes to be informed when Rhino objects change must implement this interface.

Implements this interface in your IDocumentObject to be notified when your object is about to be deleted by the user.

Implement this interface on your active object if you wish it to be put at the front of the solve-order list.

Implement this interface in your IDocumentObject class if you wish to be included in state UI.

Abstract implementation of the IDocumentObject interface for objects that wish to participate in solutions.

Event arguments used for Object Added event.

Event arguments used for Object Added event.

Base abstract implementation of IAttributes.

Enumerates common reasons for autosaving.

Enumerates the possible outcomes of an autosave request.

Enumerates the ways in which documents can be written to the disk during a save operation.

Event arguments used for Object Added event.

Event arguments used for Object Removed event.

Represents the stack of objects that form the invocation sequence to a specific IDocumentObject. This is typically used to figure out whether an invocation sequence is in fact a loop (i.e. cyclical), but it may be useful for other purposes too.

Enumerates the possible clipboards Grasshopper uses.

Exposes common standard message texts, infos and actions.

Enumerates the possible kind of tasks that the IDocumentObject.Compute() method can emit.

Represents a single group in a document Connectivity. Note that groups with attached pins can have inputs and outputs, which is why groups derive from objects.

Represents a single top-level object in a document Connectivity. Any attached pins are considered to be part of the object itself and its inputs and outputs are included in the ConnectiveObject.In and ConnectiveObject.Out properties.

A readonly snapshot of the object connectivity within a document.

Enumerates the possible types of document content.

Thrown when a loop in the dependency graph is found.

Exception thrown whenever a cyclical graph is detected. This exception is thrown automatically when an object which is already part of a CallStack is pushed onto the same stack again: RH-68232

A difference in persistent data of the same object between two documents.

Represents the data in a resolved dependency.

A graph representing the loaded portion of document dependencies.

A node in a dependency graph.

Thrown when a file does not contain the specified named data.

Abstract base class for individual differences.

A collection of differences between two documents.

Lists the various kinds of differences that can exist between two files.

The Grasshopper document class. Documents contain all objects, undo record, solution and display logic.

A class for maintaining and harvesting data from document dependencies. For example when this document imports data from another document.

Generic class for document events.

Utility methods for saving and opening documents.

Class for matching object nodes in a *.ghz archive. Objects may be stored in a different order in two files while being fundamentally the same object. This is particularly common when a Group is added, as groups are stored at the start of the object list, thus bumping all other objects up to a higher index. When comparing two files for differences, it is recommended to provide an instance of this NodeMatcher to the diff method.

This class exposes common operations that are performed on documents. Always consider using a method in this class instead of a more low-level one.

Event arguments used in document state change events.

Abstract implementation of the IDocumentObject interface for all objects.

Enumerates the possible states in which a document can exist.

Event arguments used in document state change events.

A utility class for examining files written by the GrasshopperIO assembly.

Enumerates the possible contents of a GHZ file.

This class maintains all information and functionality regarding document files.

A threadsafe dictionary with strongly typed access for values which are never serialised.

Enumerates the possible outcomes of adding a global object to a document.

Maintains a collection of global data sources within a document.

Enumerates the possible topologies of partial networks.

Defines attributes to be assigned to properties on IDocumentObject classes.

A class for maintaining a mutable and overwritable set of named values to be used inside document objects.

Arguments used in the events raised by the KeyedValues class.

A difference of layout (position or size or both) between two objects with identical IDs.

A message associated with an IDocumentObject, typically generated during solutions.

A class wrapping around a MessageDelegate.

A delegate for errors and warnings to invoke when they are clicked. Provide naming overrides and detailed information by attached the UiNameAttribute and UiInfoAttribute attributes to your method.

Exception used in solution failures. Contains both a short form and long form message.

Enumerates the severity of possible message levels.

A collection of zero or more Message instances.

A difference of modifiers between two parameters with identical IDs.

A single named view into a document.

A collection of named views.

Enumerates the defined object status (on/off/standby/etc.). In the future more values may be added to this enum to reflect more subtle states.

Event arguments for IDocumentObject autosave events.

Implementation of IObjectConnectivity.

A difference of existence of an object between two documents.

Enumerates the defined object display states. In the future more values may be added to this enum to reflect more subtle display states.

Enumerates the possible display styles of this object.

Event arguments for IDocumentObject generic events.

Event arguments for IDocumentObject events.

Event arguments for IDocumentObject name events.

Enumerates the possible levels at which objects can occur.

Represents the collection of all objects in a document.

Event arguments for IDocumentObject name events.

Event arguments for IDocumentObject phase events.

Enumerates the defined object relevance states. In the future more values may be added to this enum to reflect more subtle relevance states.

Enumerates the defined object selection states. In the future more values may be added to this enum to reflect more subtle selection states.

An immutable, thread-safe class aggregating all fields relevant to object solutions.

Static utility methods for document layouts.

Enumerates the possible behaviours of the paste command.

Enumerates the possible solution phases an object can attain.

Enumerates the possible kinds of pick.

Enumerates the different operations that are profiled.

Provides access to the list of recently opened files.

This class provides methods for maintaining a collection of recipient objects.

Event arguments used with the GlobalServer.ResolveExternal event. Handle this even if you think you can provide a resolution to a global request which could not be handled intra-document.

List of all (de)selected objects and wires during a picking or selection operation.

Records the state of a single open document at the time a session snapshot was written. One SessionEntry is created per open document and stored within a SessionRecord.

Categorises the kind of document a SessionEntry describes.

Static helpers for capturing, persisting and restoring a SessionRecord on disk. The on-disk record lives in Folders.LocalAppDataFolder and is written at shutdown; the next startup reads it and reinstates the documents that were open when the previous session ended.

A snapshot of all documents open in the editor at the moment a session ends. Designed to be written at shutdown (clean or otherwise) and read at startup to reinstate the editor in the state the user left it in.

Maintains a set of methods and properties which are used by IDocumentObjects while computing new solution data.

Enumerates the possible ways in which solutions can terminate.

Storage class for object solution results.

Arguments used in document solution events.

Arguments used in document solution exception events.

Provides an app-wide secure way to generate solution runtime ids.

Arguments used in the document tally event.

Enumerates the various modes a solution can run in.

Enumerates the possible solution states in which a document can occur.

Maintains very basic information about finished solutions.

This class provides all methods and properties concerning past document solutions and how to start new ones.

Exposes a set of standard keys used in various KeyedValues instances throughout Grasshopper.

Enumerates the possible document pointers.

Represents the instance ids of the parameters at either end of a wire, as well as the indices within the respective input and output arrays.

A difference of connecting wires between two documents.

Represents the instance ids of the parameters at either end of a wire.