GH_Document

Constructor for GH_Document. Makes sure all important members are initialized.

A collection of missing component IDs to ignore during file load operations. Erase this cache to re-enable all the load warnings.

Defined the delay used to indicate the absence of a schedule.

Defines the delay used to indicate the schedule should be immedate and recursive.

Gets the AbortRequested flag state.

Gets or sets a value indicating that this document was last active in a multi-doc aware Rhino.

Returns the total number of attributes in the document. Both Normal and Hidden ones

Returns a list of all the attributes in this document. This includes attributes for nested objects such as input or output parameters.

Gets the author details associated with this document.

Gets the dictionary of constants defined in this document.

Gets whether this document contains *any* custom preview objects.

Gets or sets the context for this document. Note that the context is not a state so much as an action. Therefore it is not particularly useful to read the context after the fact, rather, context is mostly intended to be a setter, not a getter. When you set the context, all top-level document objects will be informed and the ContextChanged event will be raised.

Gets or sets the default preview colour for normal objects.

Gets or sets the default preview colour for normal objects.

Gets the display name for this document. The display name is highly context sensitive and is only supposed to give the user a good idea of which document this is and whether it has been modified.

Gets the document Id. The Id is assigned at construction and never changed. Note: clusters may choose to modify the Id of their internal documents.

Gets or sets the enabled state for this document. Enabled documents respond to events and display their previews in the Rhino viewport.

Gets or sets a global variable that indicates whether solutions are allowed to be recomputed. When this flag is off, the solver will be disabled and the event watchers should be silent.

Gets the event server that belongs to this document. The Event server may be in an inactive state, but it is never null.

Gets or sets the file path of this document. If the file path is not set Nothing is returned.

Returns the total numbers of components currently in the Object Exception Ignore List.

Returns True if the filename flag of this document has been set

Gets or sets the modified flag. If the new value differs from the old value, the ModifiedChanged() event is raised.

Gets the number of modified subsidiary documents.

Gets or sets whether this document is nested. A nested document is always part of some other document and is therefore unknown to the DocumentServer and the Canvas.

Returns the total number of top-level objects in the document.

Returns a list of all normal, top-level objects.

Gets the total timespan for all objects.

Gets or sets the owner of this document. A document is typically owned when it is subsidiary to some object, such as a cluster.

Gets or sets the preview boundary applied to this document. If a boundary has been set, only those objects which are inside the boundary will be previewed.

Gets the boundingbox used for previews.

Gets or sets the colour of unselected preview geometry.

Gets or sets the colour of selected preview geometry.

Gets or sets the Custom Meshing Parameters for this document, these are only used when PreviewMeshType = GH_PreviewMesh.Custom

Gets or set the preview filter.

Gets or sets the preview mesh type for this document.

Gets or sets the preview display mode and makes sure the conduit instance of this class is set to match.

Gets or sets the profiler mode used in this document.

The properties of this document

If RaiseEvents is set to false, all the On....() methods of this document will stop raising events.

Gets the Remote Control Panel layout for this document.

Gets the runtime ID of this document. RuntimeID is assigned once and never changed. It is also not deserialized so every document will always have a unique ID when loaded.

Gets the delay for the next scheduled solution. If there is no solution scheduled the delay will be negative.

Gets the number of selected objects

Gets the selection topology of the document.

Gets the number of nested solutions currently running. If no solutions are running, the depth should be zero. If one solution is runnnig, the depth should be one. Higher depths are only possible if a new solution was scheduled from within an existing solution with delay=0ms.

Gets a list of the last 1000 solution timespans, from oldest to youngest.

Gets the timespan for the most recent solution.

Gets the state of this document.

Gets the list of stored states in this document

Gets or sets the thumbnail bitmap for this document.

Gets the UndoServer instance that belongs to this document.

Gets a temporary undo utility instance that allows you to easily create standard undo events.

Gets the value table associated with this document.

Returns all normal objects in the document that implement the IGH_ActiveObject interface

Add a new object to the document. If the object is already contained, nothing will happen

Perform alignment and distribution logic on a set of objects.

Perform alignment and distribution logic on all selected objects.

Useful for creating textual representations of this document for debugging purposes.

Rearrange the stack order of the object.

Rearrange the stack order of a collection of objects.

Associate this GH_Document with the currently active Rhino document. This only works if both the 3dm and the ghx file have been saved at least once.

Perform automatic layout on this document.

Creates a new autosave file on the disk. The previous autosave file (assuming it exists) will be temporarily renamed and eventually deleted entirely. Note: AutoSave is only possible on Documents that have TopLevel Rank and a valid FilePath.

Creates a new autosave file on the disk. The previous autosave file (assuming it exists) will be temporarily renamed and eventually deleted entirely. Note: AutoSave is only possible on Documents that have TopLevel Rank and a valid FilePath.

Computes the autosave filename for a full grasshopper filepath.

Returns the boundingbox of all the normal attributes. If the document contains no normal attributes an Empty RectangleF structure is returned.

Move the selection set to the top of the visible stack

Clears the Object Exception Ignore List.

Destroys the Referenced object table in the Rhino event watcher. You must call this function if you either add or remove a reference to a Rhino object.

Iterate over all subsidiary documents and close them all without saving.

Gets a sorted list of all the cluster input hooks.

Counts the number of instances of a specific cluster document ID.

Gets a sorted list of all the cluster output hooks.

Compare two documents. This function does not compare document content.

Create a hierarchical document tree of ownership with this document as the root.

Tests whether this document contains at least one cluster hook.

Convert all nicknames to original nicknames if they are equal to the default full name. There will be no undo record associated with this operation.

Convert all nicknames to full names, if they are equal to the default nickname. There will be no undo record associated with this operation.

Add an input hook for every non-optional input parameter with no persistent data and no sources. Then add an output hook for every floating parameter without recipients, and for every first component output parameter where the parent component has no recipients.

Gets the connectivity diagram for the current state of this document.

Create a new Expression Solver preloaded with the constants defined in this document.

Add a new constant to the document. Constants are not case-sensitive, when you define a constant with an existing name, the old one will be replaced. Note: constants are as of yet unused. Eventually they are supposed to become accessible to all expressions running inside a document.

Deselect all top-level attributes.

Destroys the Attribute cache. Call this function whenever you do something which might affect attributes.

Destroys all autosave files and backup files that are associated with this document. Only call this function when you are certain that the document has been properly saved and no changes have occured since.

Erase the Object fast lookup table. You must call this whenever you add or remove objects to or from the document while circumventing the regular channels.

Wipe all caches for Viewport Preview logic.

Attempts to destroy all the preview meshes in this document. It might not work for all objects, but this is still your best bet.

Remove all remaining proxy sources from the document.

Returns all disabled objects in the document

When you discard documents you must call Dispose or the Viewport Display event handlers will not be disconnected.

Attempt to duplicate a document.

Returns all enabled objects in the document

Grow or shift the selection set based on source and recipient links

Expires the preview caches of the conduit.

Expire the entire solution. This will blank all objects.

Filter a list of objects.

Filter a list of objects.

Filter a list of objects.

Filter a list of objects.

Returns all objects in the document that pass the filter specification

Filter a list of objects using several filters at once

Filter a list of objects.

Filter a list of objects.

Find all objects that depend in some way on the Source.

Find all objects that depend in some way on the Source.

Find all objects that depend in some way on the Source collection

Find all objects that depend in some way on the Source collection

Find the object that matches the ID

Search for attributes that contain a certain point.

Search for attributes that contain grips near the search locus

Search for attributes that contain grips near the search locus

Find all the clusters that have a matching ID.

Find all the clusters that have a matching filepath.

Search for components using an ID filter

Search for components that contain the locus

Search for floating parameters that contain the locus

Search for input (upstream) parameters that contain the locus

Find the object that matches the ID.

Find the topmost object that is closest to the point

Find the object that matches the ID.

Find the objects in the document that match the search term. Top level object names and nicknames are searched, as well as descriptions. Some objects are special cased to allow for more targeted searches. Data descriptions are not searched.

Search for output (downstream) parameters that contain the locus

Search for parameters using an ID filter

Find the wire at or near the given coordinate.

If true, the document will draw viewport previews regardless of other conditions. Typically a document only previews if it is loaded in the canvas or when it has an RCP.

Get a sorted list of all the IGH_DocumentObject instance IDs in this document.

Returns all objects in the document that don't implement the IGH_ActiveObject interface

Invert the selected state of all top-level attributes.

Gets whether the escape key was pressed since the last time this function was called. Though in reality the actual escape state is checked no more than once every 50 milliseconds or so, which should be sufficient for a smooth user experience.

Test to see whether a pipeline should have custom render meshes vs. previews.

Hoist all objects from another document into this one.

Hoist all objects from another document into this one.

Hoist all objects from another document into this one.

Sets the modified flag of this document.

Change all the instance UUIDs of all objects in the document. Be sure to resolve all proxy sources before mutating IDs. This function will ensure all groups are updated appropriately.

Start a new solution.

Start a new solution.

This delegate can be used in the FindAllDownstreamObjects(...) methods. Only includes objects that are non-blank and non-failed.

This delegate can be used in the FindAllDownstreamObjects(...) methods. Includes all objects.

Raise the ContextChanged event.

Raise the EnabledChanged event.

Raise the FilePathChanged event.

Raise the ModifiedChanged event

Raise the ObjectsAdded event.

Raise the ObjectsDeleted event.

Raise the ObjectsAdded event.

Raise the ObjectsDeleted event.

Raise the SettingsChanged event.

Raise the UndoStateChanged event.

Gets the currently relevant meshing parameters (do not modify the instance as it may be shared).

Standard archiving function. Will deserialize the entire document.

Perform the first redo event.

Find the most relevant object at a given canvas location. The most relevant object might be a regular Object (Component or Parameter), it might be an attribute grip, an attribute balloon, a wire or a group.

Find the most relevant object at a given canvas location. The most relevant object might be a regular Object (Component or Parameter), it might be an attribute grip, an attribute balloon, a wire or a group.

Remove the top-level object in the attribute tree from the document. This method does not add an Undo event, that is the responsibility of the caller.

Remove the object from the document. This removal is the precursor to object deletion. Do not call this function if you intend to transfer the object to another GH_Document. This method does not add an Undo event, that is the responsibility of the caller.

Remove the specified objects from the document. This removal is the precursor to object deletion. Do not call this function if you intend to transfer the objects to another GH_Document. This method does not add an Undo event, that is the responsibility of the caller.

Delete all the objects in the selection set. This method does not record an Undo event, that is the responsibility of the caller.

Attempts to resolve all proxy sources in the document.

Replace all remaining proxy sources in the document with UnresolvedProxy Objects.

Set the AbortRequested flag. The solution will be aborted whenever the current active object is completed. It is also possible that active objects themselves implement an abortion mechanism, in which case abortion might occur even sooner.

When the document is being solved inside the context of an executing Rhino command, this function will return the command instance. Under normal operation of Grasshopper in the traditional sense, this function will return null. The document executes as a command when inside of the grasshopper player or as a compiled grasshopper player based command. The way to run a GH_Document as a command is to call the GH_RhinoScriptInterface.RunAsCommand function

Schedule a new solution after a specified time interval. The schedule is erased if another solution is triggered before the schedule is executed. Tight schedules override loose schedules. If this method is called during a solution, the schedule will be started after the current solution completes.

Schedule a new solution after a specified time interval. The schedule is erased if another solution is triggered before the schedule is executed. Tight schedules override loose schedules. If this method is called during a solution, the schedule will be started after the current solution completes.

Default pick selection behaviour

Default pick selection behaviour. (looks at current Shift + Control modifier states to determine addition/removal)

Select all top-level attributes.

Returns all selected objects in the document

Set the enabled flags of all selected objects to true or false

Set the enabled flags of all specified objects to true or false

Set the preview flags of all selected objects to true or false

Set the preview flags of all specified objects to true or false

Display the Preview settings dialog.

Returns the progress of the current solution.

Toggle the enabled flags of all selected objects

Toggle the enabled flags of all specified objects

Toggle the preview flags of all selected objects

Toggle the preview flags of all specified objects

A document serializes itself using the filename of the current path. This is useful for sorting purposes and ListBoxes.

Offset objects by a certain distance in X and Y

Perform the first undo event.

Returns all unselected objects in the document

Iterate over all subsidiary documents and update them with their respective owners. If a subsidiary hasn't been modified, it will not be updated and it will not be counted.

Special function that allows writing of a custom object list. This function is used when partial documents need to be serialized such as when exporting or during clipboard operations.

Standard archiving function. Will serialize the entire document.

The context for this document was changed.

This even is raised whenever the global default for Normal preview colour is changed.

This even is raised whenever the global default for Selected preview colour is changed.

The Enabled state was changed on this document.

Raised whenever the Shared EnabledSolutions property is changed.

Raised whenever the FilePath of the document is modified.

The modified flag on the document was changed.

Raised after a collection of objects was added to the document.

Raised after a collection of objects was removed from the document. At this point, the objects still exist, but they no longer belong to this document.

Some settings of the document were changed.

This event is raised whenever a new solution request has been handled. Even if the document is locked.

This event is raised whenever a new solution is requested. Even if the document is locked.

Raised whenever there is a change to the document undo/redo stack.