Click or drag to resize

ComponentFunctionInfo Class

Defines the base class for a function representing a component. This class is abstract.
Inheritance Hierarchy
SystemObject
  Rhino.NodeInCodeComponentFunctionInfo

Namespace:  Rhino.NodeInCode
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public abstract class ComponentFunctionInfo

The ComponentFunctionInfo type exposes the following members.

Constructors
  NameDescription
Protected methodComponentFunctionInfo
Instantiates a new instance of the function class. This is not meant for public consumption.
Top
Properties
  NameDescription
Public propertyComponentGuid
The unique identifier of the Grasshopper component. It is the original developer's responsibility to ensure that this ID is unique.
Public propertyDelegate
Returns a delegate that can be directly invoked using a list of arguments. This flattens trees.
Public propertyDelegateNoWarnings
Returns a delegate that can be directly invoked using a list of arguments. This flattens trees.
Public propertyDelegateTree
Returns a delegate that can be directly invoked using a list of arguments. This considers trees and simplifies single-output components.
Public propertyDelegateTreeNoWarnings
Returns a delegate that can be directly invoked using a list of arguments. This considers trees and simplifies single-output components.
Public propertyDescription
The function description.
Public propertyFullName
Returns the name of the component prefixed by, if existing, the namespace.
Public propertyFullScriptingName
Shows the full name of the component, including optional periods. Removes spaces and common operator signs.
Public propertyInputDescriptions
The function input parameter descriptions.
Public propertyInputNames
The function input parameter names.
Public propertyInputsOptional
Indications for each function input parameter whether it is optional.
Public propertyInputTypeNames
The function input type names.
Public propertyIsDefault
Determines if the component is a default one.
Public propertyName
The function name.
Public propertyNamespace
The function namespace.
Public propertyOutputDescriptions
Grasshopper returns several items in general. This property returns the output descriptions.
Public propertyOutputNames
Grasshopper returns several items in general. This property returns the output names.
Public propertyOutputTypeNames
Grasshopper returns several items in general. This property returns the output type names.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluate
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 methodEvaluateSilenceWarnings
Infrastructure method that simplifies output and performs warning checks.
Protected methodEvaluateTreeSilenceWarnings
Infrastructure method that simplifies output and performs warning checks.
Protected methodEvaluateTreeWithWarningsAsErrors
Infrastructure method that simplifies output and performs warning checks.
Protected methodEvaluateWithWarningsAsErrors
Infrastructure method that simplifies output and performs warning checks.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberSimplifyTreeOutput
Performs list logical reduction when trees are not used.
Public methodToString
Returns a string representing this function.
(Overrides ObjectToString.)
Top
See Also