RhinoCommon documentation has a new look. The old site can still be found here.

/

Rhino.NodeInCode

/

ComponentFunctionInfo

ComponentFunctionInfo class

Defines the base class for a function representing a component. This class is abstract.

Derived Classes:

Namespace: Rhino.NodeInCode
ComponentFunctionInfo: references

Constructors (1)

ComponentFunctionInfo(string name, string @namespace, string description, IReadOnlyList<string> inputNames, IReadOnlyList<string> inputDescriptions, IReadOnlyList<string> inputTypeNames, IReadOnlyList<bool> inputsOptional, IReadOnlyList<string> outputNames, IReadOnlyList<string> outputDescriptions, IReadOnlyList<string> outputTypeNames, Guid componentGuid)

Instantiates a new instance of the function class. This is not meant for public consumption.

Properties (18)

ComponentGuid

The unique identifier of the Grasshopper component. It is the original developer's responsibility to ensure that this ID is unique.

Delegate

Returns a delegate that can be directly invoked using a list of arguments. This flattens trees.

DelegateNoWarnings

Returns a delegate that can be directly invoked using a list of arguments. This flattens trees.

DelegateTree

Returns a delegate that can be directly invoked using a list of arguments. This considers trees and simplifies single-output components.

DelegateTreeNoWarnings

Returns a delegate that can be directly invoked using a list of arguments. This considers trees and simplifies single-output components.

Description

The function description.

FullName

Returns the name of the component prefixed by, if existing, the namespace.

FullScriptingName

Shows the full name of the component, including optional periods. Removes spaces and common operator signs.

InputDescriptions

The function input parameter descriptions.

InputNames

The function input parameter names.

InputsOptional

Indications for each function input parameter whether it is optional.

InputTypeNames

The function input type names.

IsDefault

Determines if the component is a default one.

Name

The function name.

Namespace

The function namespace.

OutputDescriptions

Grasshopper returns several items in general. This property returns the output descriptions.

OutputNames

Grasshopper returns several items in general. This property returns the output names.

OutputTypeNames

Grasshopper returns several items in general. This property returns the output type names.

Methods (6)

Evaluate(IEnumerable args, bool keepTree, out string warnings)

Evaluates the component with a set of arguments. There needs to be an argument for each input param, and each output param gives an entry in the output array.

Invoke(params object args)

Runs <b>Evaluate</b> with keepTree equal to false, and raises an exception on the first warning.

InvokeKeepTree(params object args)

Runs <b>Evaluate</b> with keepTree equal to True and raises an exception on the first warning.

InvokeKeepTreeSilenceWarnings(params object args)

Runs <b>Evaluate</b> with keepTree equal to true, and discards warnings (this is a dangerous operation!).

InvokeSilenceWarnings(params object args)

Runs <b>Evaluate</b> with keepTree equal to false, then simplifies output with <b>SimplifyTreeOutput</b> and discards warnings (this is a dangerous operation!).

ToString()

Returns a string representing this function.

Nothing found