RhinoPipeline

Gets or sets the active state of this object. Note that this property is meaningless for certain types of object.

Gets or sets the attributes for this object.

Gets whether this component is capable of baking any data at this very moment.

Gets all immediate child objects that belong to the current object. It is possible that an object does not have any children, and it is possible that a child object has children of its own.

Gets the topological description of this object. Component topology by default only connects the component to its own inputs and outputs. If you wish to get the connectivity for the component as a whole, access the ConnectivityComplete property instead.

Gets the connectivity of this component as a whole (meaning including the input and output parameters).

Gets a collection of keyed values which can be used to store custom data which will survive (de)serialisation.

Gets or sets the display state of this object. Note that this property is meaningless for certain types of object.

Gets or sets the ActiveObject.DisplayCache to use while displaying this object.

Gets the display name of this object. Often the DisplayName is identical to the UserName, but there could be more complicated algorithms involved.

Enumerate over all display capable inputs and outputs. This enumerator skips over disabled and hidden parameters, as well as inputs with sources, and parameters whose attribute bounds are empty.

Gets or sets the display style to use for the geometric data inside this object. Note that this property is meaningless for certain types of object.

Gets or sets the document this object belongs to. It is possible an object does not belong to any document, however it can never belong to more than one document simultaneously.

Enumerates over all objects in the hierarchy this object is part of. This enumeration starts at the root object and then continues over all children and grandchildren in a breadth-first fashion.

Gets the root or founding object in the object hierarchy. If the current object does not have a parent, it is a founding object.

Gets the icon associated with this object.

Override this method to provide an icon for this object. If the icon is an embedded resource in this assembly with the same name as the class, it will automatically be loaded. The DocumentObject.Icon property calls this property and caches the result.

Gets or sets the name vs. icon display mode of this component.

Gets or sets the instance Id for this object. The instance Id should be different for every instance of every type. Do *not* assign this Id unless you know exactly what you are doing.

Gets (or sets, if you derive from this component) the label. The label ought to be a short, single-line string which is displayed as part of the component slab.

Gets the visible/hidden status for optional inputs. Note that this property will yield null until after the constructor completes.

Gets the visible/hidden status for optional outputs. Note that this property will yield null until after the constructor completes.

Gets the user friendly description of this object.

Gets whether this object is considered obsolete.

Gets access to the input and output parameters of this component.

Gets or sets the parent object that owns this object. Top-level objects do not have parents. Do not assign or remove parents unless you know exactly what you are doing.

Gets the current solution phase of this object.

Gets the pin collection for this cushion. Note that the Component base class implements this only to make it easier for sub-classes to implement IPinCushion. If the derived class does not implement IPinCushion then this field will probably be null.

Gets the progress as a percentage. If this object is currently not calculating a new solution, this number is not meaningful.

Gets or sets the auxiliary state of this object. Auxiliary objects are drawn in an inconspicuous way as they are considered in-between logic. Note that this property is meaningless for certain types of object.

Gets the main yes/no state from the SelectionState.

Gets or sets the selected state of this object. Note that the selected setting of secondary objects is inherited from the parent.

Gets all sibling objects in the object family tree.

Gets the current state of this object. This is always the most recently completed state.

Gets whether this component supports parameter addition and removal. For this to be true, the methods Component.CanCreateParameter(Side, int), Component.CanRemoveParameter(Side, int), and Component.DoCreateParameter(Side, int, ActionList) must all have been overridden.

Gets or sets the processing level for this component.

Gets the user specified name of this object.

Add a custom undo record for this object.

Add a single action undo record for this object.

Append the baking input panel.

Add toggles to an input panel based on the supported pins of this component.

Append the 'Enabled' and 'Display' states to this input panel.

Append the user name text box within a category labelled 'Attributes'.

Bake the shapes in all output parameters. By default this method does not include input parameters or any data on the component itself, but individual components may override that behaviour.

Override this method to perform some action before any data about the component process have been collected or computed. This would be a good place to modify the topology of the input or output parameters for example.

Compute a new solution for this object, or return a completed solution if one is available.

Compute and populate a new solution object. Please do not override this method on your own component class unless you have a really solid understanding of what you're doing. The only reason this method isn't sealed is because Chains and Clusters need to be able to override it.

Expire this object and all objects that depend on it. This will request-cancel any running solutions inside whatever document contains this object.

Expire the attributes and raise the DisplayChanged event.

Gets information about who created this component and when.

Gets information about who last modified this component and when.

Invalidate the attribute layout, but only if the attributes already exist.

Override the icon for this object. Use this judiciously.

Programmatically modify the nickname, name and/or info strings on the Nomen.

Raise the DocumentObject.DisplayChanged event.

Raise the Expired event.

Raise the DocumentObject.LayoutChanged event.

Assign new attributes to this object. Not all attributes may be accepted, it depends on the implementation.

Override this method to populate a display bag from a computed result. The DisplayCapable property will return true if this method has been overridden.

Override this method to perform some action after all calls to Component.Process(IDataAccess) during a single solution.

Override this method if you wish to post-process the trees generated for the output parameters.

Override this method to perform some action prior to any call to Component.Process(IDataAccess) during a single solution.

Request an autosave.

Request an autosave using the instance ID of this object as a filter. This means hat subsequent autosave requests coming from the same object will be ignored.

Resolve the current icon mode to one of the definite states.

Set the CreatedBy and CreatedAt fields if they haven't been set already.

Set the ModifiedBy and ModifiedAt fields.

Set the DocumentObject.ProgressPercentage field directly. The percentage is automatically limited to the [0, 100] interval.

Set the DocumentObject.ProgressPercentage field based on a step count. This method always limits the percentage to the [1, 99] range, as 0% and 100% are oftentimes indicative of unstarted or completed processes, which probably gives the wrong impression.

This method will be invoked whenever a parameter is added or removed via the variable parameter mechanism.

Raised whenever the Enabled state of this object changes.

Raised whenever this object requests an autosave.

Raised whenever the display state of this object changes.

Raised whenever this object becomes part of a different document.

Raised whenever the solution currently held by this object is expired.

Raised whenever the InstanceId of this object changes.

Raised whenever the layout of this object changes. Layout invalidation triggers a canvas redraw.

Raised whenever the UserName of this object changes. This typically infers that the DisplayName also changes.

Raised whenever the Auxiliary state of this object changes.

Raised whenever the Selected state of this object changes.