ComponentFunctionInfo
Defines the base class for a function representing a component. This class is abstract.
Inheritance Hierarchy
System.Object
Rhino.NodeInCode.ComponentFunctionInfo
Namespace: Rhino.NodeInCode
Assembly: RhinoCommon (in RhinoCommon.dll)
Syntax
public abstract class ComponentFunctionInfoThe ComponentFunctionInfo type exposes the following members.
Constructors
Name
Description
Protected Method
ComponentFunctionInfo
Instantiates a new instance of the function class. This is not meant for public consumption.
Properties
Name
Description
Public Property
ComponentGuid
The unique identifier of the Grasshopper component. It is the original developer’s responsibility to ensure that this ID is unique.
Public Property
Delegate
Returns a delegate that can be directly invoked using a list of arguments. This flattens trees.
Public Property
DelegateNoWarnings
Returns a delegate that can be directly invoked using a list of arguments. This flattens trees.
Public Property
DelegateTree
Returns a delegate that can be directly invoked using a list of arguments. This considers trees and simplifies single-output components.
Public Property
DelegateTreeNoWarnings
Returns a delegate that can be directly invoked using a list of arguments. This considers trees and simplifies single-output components.
Public Property
Description
The function description.
Public Property
FullName
Returns the name of the component prefixed by, if existing, the namespace.
Public Property
FullScriptingName
Shows the full name of the component, including optional periods. Removes spaces and common operator signs.
Public Property
InputDescriptions
The function input parameter descriptions.
Public Property
InputNames
The function input parameter names.
Public Property
InputsOptional
Indications for each function input parameter whether it is optional.
Public Property
InputTypeNames
The function input type names.
Public Property
IsDefault
Determines if the component is a default one.
Public Property
Name
The function name.
Public Property
Namespace
The function namespace.
Public Property
OutputDescriptions
Grasshopper returns several items in general. This property returns the output descriptions.
Public Property
OutputNames
Grasshopper returns several items in general. This property returns the output names.
Public Property
OutputTypeNames
Grasshopper returns several items in general. This property returns the output type names.
Methods
Name
Description
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public Method
Evaluate
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.
Protected Method
Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public Method
Invoke
Runs Evaluate(IEnumerable, Boolean, .String..) with keepTree equal to false, and raises an exception on the first warning.
Public Method
InvokeKeepTree
Runs Evaluate(IEnumerable, Boolean, .String..) with keepTree equal to true and raises an exception on the first warning.
Public Method
InvokeKeepTreeSilenceWarnings
Runs Evaluate(IEnumerable, Boolean, .String..) with keepTree equal to true, and discards warnings (this is a dangerous operation!).
Public Method
InvokeSilenceWarnings
Runs Evaluate(IEnumerable, Boolean, .String..) with keepTree equal to false, then simplifies output with SimplifyTreeOutput(.Object., .String., Boolean) and discards warnings (this is a dangerous operation!).
Protected Method
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public Method
ToString
Returns a string representing this function.
(Overrides Object.ToString..)