SurfaceLocusParameter

Gets the access for this parameter, i.e. whether it treats data as items, lists or trees.

Gets or sets the variability allowance of the access level. If this variability is anything other than None, the parameter will provide menu UI for changing its access state.

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 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 or sets the colour override for the display of this object.

Gets the topological connectivity of this object. The topology is not updated automatically, so be sure to get a fresh instance every time you need it.

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 whether this object makes allowance for 3D viewport displays.

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 expression associated with the expression text, if the text is not null/empty and a valid expression. Note that if the AbstractParameter.ExpressionEnabled property is set to false, this property still returns an expression if it can.

Gets or sets whether the expression is taken into consideration.

Gets or sets the expression text for this parameter.

Gets or sets a fallback name to be used as DisplayName in case the UserName is null or empty.

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 or sets the hard meta data to assign to all values passing through this parameter. Hard meta data is always assigned and may overwrite existing meta data with the same keys.

Gets the icon associated with this object.

Gets the input parameters. This list only includes parameters that are connected through wires, it does not include globals this parameter depends on.

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 the parameter station (in life). Input, output, floating or other.

Gets an array of all the state icons for this parameter.

Gets or sets the modifiers associated with this parameter.

Gets the user friendly description of this object.

Gets whether this object is considered obsolete.

Gets the output parameters. This list only includes parameters that are connected through wires, it does not include objects that in some other way depend on this parameter.

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 nomen to be used for the 'Set Related Items' button. If this property returns null, the button is not displayed on the pop-over.

Assign this method if you wish to process the trees harvested from source parameters before they are converted into a single, type compatible tree. Do note that any type conversions that occur here will not be included in the conversion record. Also note that this property must be assigned every time as it cannot be (de)serialised.

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 or sets the data requirement for this parameter. Requirement typically only make sense as component inputs, but the property exists on all parameters.

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 or sets the soft meta data to assign to all values passing through this parameter. Soft meta data is only assigned when it won't overwrite existing meta data with the same keys.

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

Each parameter type ought to provide an assistant. However this property may return null, in which case a lot of functionality will not be available.

Gets the flavour of the type this parameter contains.

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.

Append the parameter modifiers to do with cleaning, (Remove Empty Twig, Remove Nulls, Remove Invalid).

Override this method to append a bar with custom modifiers, or, if you really want, mess with the already added input panel elements.

Append the parameter persistent data setters. (Clear, Internalise, Set One, Set Many, Edit).

Append the expression modifier UI to the input panel. Override this method and do nothing to disable expressions on this parameter.

Override this method if you with to add your own modifier icons to this parameter.

Append the parameter modifiers to do with item ordering, (Sort, Randomise, Reverse).

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

Append all default modifier options.

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

Append the group of input access variability inputs (Item, Twig, Tree), depending on parameter state.

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

Create default attributes for this object. If attributes already exist, this method will not replace them.

Override this method to populate displays.

Create an empty tree which can be used as a placeholder for null data in solution results.

Construct a lightweight control suitable for editing this parameter's value. Control provider is responsible for handling undo record and assigning changes. Return null if no control makes sense in any particular case. Note that the control which is returned by this method may never be shown.

Pop up the hard and soft meta data editor.

Show the persistent values editor.

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.

Expire all references which match a validator method.

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.

Utility function for overriding persistent data. This method will:

1. Add an undo record for the current persistent data.
2. Assign new persistent data.
3. Expire the parameter.
4. Trigger a new solution on the document which owns this parameter.

Utility function for overriding persistent data. This method will:

1. Add an undo record for the current persistent data.
2. Assign new persistent data.
3. Expire the parameter.
4. Trigger a new solution on the document which owns this parameter.

Apply the modifiers and the AbstractParameter.ProcessResult(Solution, SolutionData) method. This is automatically called as part of the standard AbstractParameter.ComputeInternal(Solution, CallStack) logic, so unless you're overriding that, you have no need of this method.

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.

Method for overriding the access. You almost never want to change this yourself, which is why this functionality is hidden behind this method.

Override the access of this parameter. This is dangerous and almost never needed at runtime. Consider enabling AbstractParameter.AccessVariability if the access needs to change over time.

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

Default implementation will show a multi-line text box.

Default implementation will show a text box provided there's an assisatant which supports roundtripping.

Override this method to specify many related values. This usually translates to the special pickers. Many parameters do not override this method and that's absolutely fine.

Override this method if you wish to post-process the default result of this parameter. The intermediate result will either contain the merged tree of all source objects or the persistent data, processed by the parameter modifiers. It will also contain all relevant type conversion messaging. You may choose to replace the data in the intermediate result, add messages, or create an entirely new Result instance, but do note that the intermediate may contain a lot of useful messaging.

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.

Set one or more persistent values at path {0}. This method overwrites whatever persistent data may already be set.

Set one or more persistent values at path {0}. This method overwrites whatever persistent data may already be set.

Set all persistent data. This method overwrites whatever persistent data may already be set.

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 is called whenever the instance is required to serialize itself.

Gets a set of strings which describe the current state of this parameter. This is used primarily to populate tooltip content.

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.