-
Notifications
You must be signed in to change notification settings - Fork 0
DiGi.Rhino.Core.Classes
A Grasshopper component that creates a DiGi.Core.Classes.Address object based on street, city, postal code, and country code inputs.
public class Address : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → Address
Initializes a new instance of the Address component.
public Address();Gets the unique identifier for this Grasshopper component.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component in the Grasshopper toolbar.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Gets the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Gets the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }Executes the main logic of the component, reading input data and producing an DiGi.Core.Classes.Address output.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The data access object used to retrieve inputs and set outputs.
Provides a base abstract class for custom Grasshopper components, extending the standard GH_Component functionality.
public abstract class ComponentInheritance Grasshopper.Kernel.GH_Component → Component
Derived
↳ ElementLogicalFilter
↳ Inspect
↳ VariableParameterComponent
Initializes a new instance of the Component class with specified identification and categorization details.
public Component(string name, string nickname, string description, string category, string subCategory);name System.String
The full name of the component.
nickname System.String
The short name displayed on the Grasshopper canvas.
description System.String
A detailed description of the component's functionality.
category System.String
The primary category in the Grasshopper menu where this component is located.
subCategory System.String
The sub-category within the primary category for further organization.
Represents a Grasshopper component that creates geographic coordinates from latitude and longitude inputs.
public class Coordinates : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → Coordinates
Initializes a new instance of the Coordinates class.
public Coordinates();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component, determining when it is executed.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work, processing input latitude and longitude to produce a coordinates object.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object used to retrieve data from inputs and store results in outputs.
Represents the country code component used for ISO country identification within the system.
public class CountryCode : DiGi.Rhino.Core.Classes.EnumComponent<DiGi.Core.Enums.CountryCode>Inheritance Grasshopper.Kernel.GH_Component → DiGi.Rhino.Core.Classes.EnumComponent<DiGi.Core.Enums.CountryCode> → CountryCode
Initializes a new instance of the CountryCode class.
public CountryCode();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }A Grasshopper component that deserializes JSON strings into a list of serializable objects.
public class Deserialize : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → Deserialize
Initializes a new instance of object.
public Deserialize();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component, which determines how it is displayed in the Grasshopper canvas.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object is used to retrieve from inputs and store in outputs.
Implementation of a logical AND filter that combines multiple input filters into a single output string.
public class ElementLogicalAndFilter : DiGi.Rhino.Core.Classes.ElementLogicalFilterInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → ElementLogicalFilter → ElementLogicalAndFilter
Initializes a new instance of the ElementLogicalAndFilter class.
public ElementLogicalAndFilter();Gets the unique identifier for this component.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Base abstract class for logical filter components that support a variable number of input parameters.
public abstract class ElementLogicalFilter : DiGi.Rhino.Core.Classes.ComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → ElementLogicalFilter
Derived
↳ ElementLogicalAndFilter
Initializes a new instance of the ElementLogicalFilter class.
protected ElementLogicalFilter(string name, string nickname, string description, string category, string subCategory);name System.String
The full name of the component.
nickname System.String
The short nickname of the component.
description System.String
A description of what the component does.
category System.String
The category in the Grasshopper menu.
subCategory System.String
The sub-category in the Grasshopper menu.
Called when the component is added to a Grasshopper document.
public override void AddedToDocument(GH_Document document);document Grasshopper.Kernel.GH_Document
The document the component is being added to.
Determines whether a parameter can be inserted at the specified side and index.
public bool CanInsertParameter(GH_ParameterSide side, int index);side Grasshopper.Kernel.GH_ParameterSide
The side of the component where the parameter would be inserted.
index System.Int32
The zero-based index of the parameter.
System.Boolean
true if the parameter can be inserted; otherwise, false.
Determines whether a parameter can be removed from the specified side and index.
public bool CanRemoveParameter(GH_ParameterSide side, int index);side Grasshopper.Kernel.GH_ParameterSide
The side of the component where the parameter would be removed.
index System.Int32
The zero-based index of the parameter.
System.Boolean
true if the parameter can be removed; otherwise, false.
Creates a new parameter for the specified side and index.
public IGH_Param? CreateParameter(GH_ParameterSide side, int index);side Grasshopper.Kernel.GH_ParameterSide
The side of the component where the parameter is created.
index System.Int32
The zero-based index of the parameter.
Grasshopper.Kernel.IGH_Param
The newly created Grasshopper.Kernel.IGH_Param, or null if creation is not possible.
Destroys the parameter at the specified side and index.
public bool DestroyParameter(GH_ParameterSide side, int index);side Grasshopper.Kernel.GH_ParameterSide
The side of the component where the parameter is located.
index System.Int32
The zero-based index of the parameter.
System.Boolean
true if the parameter was successfully destroyed; otherwise, false.
Called when the component is removed from a Grasshopper document.
public override void RemovedFromDocument(GH_Document document);document Grasshopper.Kernel.GH_Document
The document the component is being removed from.
Performs maintenance on variable parameters to ensure consistency.
public void VariableParameterMaintenance();An abstract base class for Grasshopper components that manage a value of a specific enumeration type.
public abstract class EnumComponent<T>
where T : System.EnumT
The enumeration type used by the component.
Inheritance Grasshopper.Kernel.GH_Component → EnumComponent<T>
Derived
↳ CountryCode
↳ NumberComparisonType
↳ TextComparisonType
↳ UTC
Initializes a new instance of the EnumComponent<T> class using a prefix to automatically generate metadata.
public EnumComponent(string prefix);prefix System.String
The prefix used to construct the component's identity and category path.
Initializes a new instance of the EnumComponent<T> class with specified metadata.
public EnumComponent(string name, string nickname, string description, string category, string subCategory);name System.String
The full name of the component.
nickname System.String
The short nickname of the component.
description System.String
A detailed description of the component's functionality.
category System.String
The primary category in the Grasshopper menu.
subCategory System.String
The sub-category in the Grasshopper menu.
Appends the enumeration values of type T as selectable items in the component's context menu.
protected override void AppendAdditionalComponentMenuItems(System.Windows.Forms.ToolStripDropDown menu);menu System.Windows.Forms.ToolStripDropDown
The drop-down menu to which the items are appended.
Reads the serialized state of the component from the provided reader.
public override bool Read(GH_IReader reader);reader GH_IO.Serialization.GH_IReader
The reader used to retrieve stored data.
System.Boolean
True if the read operation was successful; otherwise, false.
Registers all the input parameters for this component.
protected override void RegisterInputParams(GH_InputParamManager inputParamManager);inputParamManager Grasshopper.Kernel.GH_Component.GH_InputParamManager
The manager used to register input parameters.
Registers all the output parameters for this component.
protected override void RegisterOutputParams(GH_OutputParamManager outputParamManager);outputParamManager Grasshopper.Kernel.GH_Component.GH_OutputParamManager
The manager used to register output parameters.
This is the method that actually does the work.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object is used to retrieve from inputs and store in outputs.
Writes the current state of the component to the provided writer for serialization.
public override bool Write(GH_IWriter writer);writer GH_IO.Serialization.GH_IWriter
The writer used to store data.
System.Boolean
True if the write operation was successful; otherwise, false.
A component that filters a list of serializable objects based on a provided boolean mask.
public class FilterByMask : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → FilterByMask
Initializes a new instance of the FilterByMask class.
public FilterByMask();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component, which determines its visibility and behavior in the Grasshopper canvas.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work, filtering the input list based on the provided boolean mask.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object used to retrieve data from inputs and store results in outputs.
A component that filters a list of serializable objects based on the value of a specified numeric property.
public class FilterByNumber : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → FilterByNumber
Initializes a new instance of the FilterByNumber class.
public FilterByNumber();Gets the unique identifier for this component.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work of filtering objects by a numeric property value.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object used to retrieve from inputs and store in outputs.
A Grasshopper component that filters a list of serializable objects based on the text value of a specified parameter.
public class FilterByText : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → FilterByText
Initializes a new instance of the FilterByText class.
public FilterByText();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component, which determines its visibility and behavior on the canvas.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work of filtering objects based on text comparison.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The data access object used to retrieve input values and set output values.
A Grasshopper component that retrieves a value for a given parameter definition from a parametrized object.
public class GetValue : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → GetValue
Initializes a new instance of the GetValue class.
public GetValue();Gets the unique identifier for this component.
public override System.Guid ComponentGuid { get; }Gets the exposure level of this component.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }Performs the main logic of the component, retrieving a value from the parametrized object based on the provided parameter definition.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object used to retrieve from inputs and store in outputs.
A non-generic wrapper for enumeration types to be used within the Grasshopper environment.
public class GooEnum : DiGi.Rhino.Core.Classes.GooEnum<System.Enum>Inheritance Grasshopper.Kernel.Types.GH_Goo → Grasshopper.Kernel.Types.IGH_Goo → GH_IO.GH_ISerializable → DiGi.Rhino.Core.Classes.GooEnum<System.Enum> → GooEnum
Initializes a new instance of the GooEnum class.
public GooEnum();Initializes a new instance of the GooEnum class with a specific enumeration value.
public GooEnum(System.Enum? @enum);enum System.Enum
The enumeration value.
Creates a duplicate of the current Goo object.
public override IGH_Goo? Duplicate();Grasshopper.Kernel.Types.IGH_Goo
A new instance of GooEnum containing the same value.
A generic wrapper for enumeration types to be used within the Grasshopper environment.
public class GooEnum<T> : DiGi.Rhino.Core.Interfaces.IGooObject
where T : System.EnumT
The type of the enumeration.
Inheritance Grasshopper.Kernel.Types.GH_Goo → Grasshopper.Kernel.Types.IGH_Goo → GH_IO.GH_ISerializable → GooEnum<T>
Derived
↳ GooEnum
Implements IGooObject
Initializes a new instance of the GooEnum<T> class.
public GooEnum();Initializes a new instance of the GooEnum<T> class using an existing GooEnum<T>.
public GooEnum(DiGi.Rhino.Core.Classes.GooEnum<T>? gooEnum);gooEnum DiGi.Rhino.Core.Classes.GooEnum<T>
The source GooEnum object.
Initializes a new instance of the GooEnum<T> class with a specific enumeration value.
public GooEnum(T? @enum);enum T
The enumeration value.
Gets a value indicating whether the current instance contains a valid value.
public override bool IsValid { get; }Gets a description of the type, replacing dots with spaces for readability.
public override string? TypeDescription { get; }Gets the full name of the type.
public override string? TypeName { get; }Attempts to cast the specified object to a GooEnum<T>.
public override bool CastFrom(object source);source System.Object
The object to cast.
System.Boolean
True if the casting was successful; otherwise, false.
Attempts to cast the current value to a specified type.
public override bool CastTo<Y>(ref Y target);Y
The target type.
target Y
A reference to the target variable where the result will be stored.
System.Boolean
True if the casting was successful; otherwise, false.
Creates a duplicate of the current Goo object.
public override IGH_Goo? Duplicate();Grasshopper.Kernel.Types.IGH_Goo
A new instance of GooEnum<T> containing the same value.
Reads the enumeration value from a serialization reader.
public override bool Read(GH_IReader? reader);reader GH_IO.Serialization.GH_IReader
The reader used to deserialize the data.
System.Boolean
True if the read operation was successful; otherwise, false.
Returns a string representation of the current enumeration value.
public override string? ToString();System.String
The string representation of the value, or null if no value is present.
Writes the enumeration value to a serialization writer.
public override bool Write(GH_IWriter writer);writer GH_IO.Serialization.GH_IWriter
The writer used to serialize the data.
System.Boolean
True if the write operation was successful; otherwise, false.
A Grasshopper parameter component for general enumeration types.
public class GooEnumParamInheritance Grasshopper.Kernel.GH_PersistentParam → GooEnumParam
Initializes a new instance of the GooEnumParam class.
public GooEnumParam();Gets the unique identifier for this component.
public override System.Guid ComponentGuid { get; }Represents a persistent parameter in Grasshopper that handles enumeration values wrapped in a GooEnum<T>.
public abstract class GooEnumParam<T,X>
where T : DiGi.Rhino.Core.Classes.GooEnum<X>
where X : System.EnumT
The type of the value being stored, which must be a GooEnum<T>.
X
The underlying enumeration type.
Inheritance Grasshopper.Kernel.GH_PersistentParam → GooEnumParam<T,X>
Derived
↳ GooEnumParam<T>
Initializes a new instance of the GooEnumParam<T,X> class.
public GooEnumParam();Handles the prompt for multiple values when the parameter is accessed.
protected override GH_GetterResult Prompt_Plural(ref System.Collections.Generic.List<T> values);values System.Collections.Generic.List<T>
A reference to the list of values to be updated.
Grasshopper.Kernel.GH_GetterResult
The result of the getter operation.
Handles the prompt for a single value when the parameter is accessed.
protected override GH_GetterResult Prompt_Singular(ref T value);value T
A reference to the value to be updated.
Grasshopper.Kernel.GH_GetterResult
The result of the getter operation.
A Grasshopper parameter component for generic enumeration types.
public class GooEnumParam<T> : DiGi.Rhino.Core.Classes.GooEnumParam<DiGi.Rhino.Core.Classes.GooEnum<T>, T>
where T : System.EnumT
The type of the enumeration.
Inheritance Grasshopper.Kernel.GH_PersistentParam → DiGi.Rhino.Core.Classes.GooEnumParam<DiGi.Rhino.Core.Classes.GooEnum<T>,T> → GooEnumParam<T>
Initializes a new instance of the GooEnumParam<T> class.
public GooEnumParam();Gets the unique identifier for this component.
public override System.Guid ComponentGuid { get; }A non-generic version of GooObject<TObject> that wraps an object of type System.Object.
public class GooObject : DiGi.Rhino.Core.Classes.GooObject<object>Inheritance Grasshopper.Kernel.Types.GH_Goo → Grasshopper.Kernel.Types.IGH_Goo → GH_IO.GH_ISerializable → DiGi.Rhino.Core.Classes.GooObject<System.Object> → GooObject
Initializes a new instance of the GooObject class.
public GooObject();Initializes a new instance of the GooObject class with a specified value.
public GooObject(object? @object);object System.Object
The object to wrap in this Goo container.
Creates a duplicate of the current Goo object.
public override IGH_Goo? Duplicate();Grasshopper.Kernel.Types.IGH_Goo
A new instance of GooObject containing the same value.
A generic wrapper for objects to be used within Grasshopper, providing serialization and casting capabilities.
public class GooObject<TObject> : DiGi.Rhino.Core.Interfaces.IGooObject<TObject>, DiGi.Rhino.Core.Interfaces.IGooObjectTObject
The type of the object wrapped by this Goo container.
Inheritance Grasshopper.Kernel.Types.GH_Goo → Grasshopper.Kernel.Types.IGH_Goo → GH_IO.GH_ISerializable → GooObject<TObject>
Derived
↳ GooObject
↳ GooSerializableObject<TSerializableObject>
↳ GooType
Implements DiGi.Rhino.Core.Interfaces.IGooObject<TObject>, IGooObject
Initializes a new instance of the GooObject<TObject> class.
public GooObject();Initializes a new instance of the GooObject<TObject> class with a specified value.
public GooObject(TObject? @object);object TObject
The object to wrap in this Goo container.
Gets a value indicating whether the wrapped object is valid (not null).
public override bool IsValid { get; }Gets a human-readable description of the type of the wrapped object.
public override string? TypeDescription { get; }Gets the full name of the type of the wrapped object.
public override string? TypeName { get; }Attempts to cast the specified source object into this Goo container.
public override bool CastFrom(object? source);source System.Object
The source object to cast from.
System.Boolean
True if the casting was successful; otherwise, false.
Attempts to cast the wrapped object into the specified target type.
public override bool CastTo<Y>(ref Y target);Y
The target type to cast to.
target Y
A reference to the target variable where the result will be stored.
System.Boolean
True if the casting was successful; otherwise, false.
Creates a duplicate of the current Goo object.
public override IGH_Goo? Duplicate();Grasshopper.Kernel.Types.IGH_Goo
A new instance of Grasshopper.Kernel.Types.IGH_Goo containing the same value.
Retrieves the wrapped value cast to a more specific type.
public XObject? GetValue<XObject>()
where XObject : TObject;XObject
The specific type to retrieve, which must inherit from TObject.
Implements GetValue<XObject>()
XObject
The wrapped value as XObject if possible; otherwise, the default value of XObject.
Reads the wrapped object from a Grasshopper reader.
public override bool Read(GH_IReader reader);reader GH_IO.Serialization.GH_IReader
The reader used to deserialize the object.
System.Boolean
True if reading was successful; otherwise, false.
Returns a string representation of the wrapped object.
public override string? ToString();System.String
The full name of the type of the wrapped value, or null if the value is null.
Writes the wrapped object to a Grasshopper writer.
public override bool Write(GH_IWriter writer);writer GH_IO.Serialization.GH_IWriter
The writer used to serialize the object.
System.Boolean
True if writing was successful; otherwise, false.
A Grasshopper persistent parameter for GooObject.
public class GooObjectParamInheritance Grasshopper.Kernel.GH_PersistentParam → GooObjectParam
Initializes a new instance of the GooObjectParam class.
public GooObjectParam();Gets the unique identifier for this component.
public override System.Guid ComponentGuid { get; }Represents a Grasshopper parameter that handles generic goo objects (Grasshopper.Kernel.Types.IGH_Goo).
public class GooParamInheritance Grasshopper.Kernel.GH_Param → GooParam
Initializes a new instance of the GooParam class with default values and item access.
public GooParam();Initializes a new instance of the GooParam class with specified metadata and access mode.
public GooParam(string name, string nickname, string description, GH_ParamAccess gH_ParamAccess);name System.String
The name of the parameter.
nickname System.String
The nickname of the parameter.
description System.String
The description of the parameter.
gH_ParamAccess Grasshopper.Kernel.GH_ParamAccess
The access mode for the parameter (e.g., Item or List).
Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the parameter.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Returns a hash code for the current object based on its name.
public override int GetHashCode();System.Int32
A hash code for the current object.
Reads the parameter data from the specified reader.
public sealed override bool Read(GH_IReader reader);reader GH_IO.Serialization.GH_IReader
The reader used to deserialize the object.
System.Boolean
true if the read operation was successful; otherwise, false.
Writes the parameter data to the specified writer.
public sealed override bool Write(GH_IWriter writer);writer GH_IO.Serialization.GH_IWriter
The writer used to serialize the object.
System.Boolean
true if the write operation was successful; otherwise, false.
Represents a persistent parameter in Grasshopper that manages data of type T, which wraps an underlying object of type X.
public class GooPresistentParam<T,X>
where T : DiGi.Rhino.Core.Classes.GooObject<X?>
where X : DiGi.Core.Interfaces.IObjectT
The type of the Goo object, which must inherit from GooObject<TObject>.
X
The type of the underlying data object, which must implement DiGi.Core.Interfaces.IObject.
Inheritance Grasshopper.Kernel.GH_PersistentParam → GooPresistentParam<T,X>
Derived
↳ GooSerializablePresistentParam<T,X>
Initializes a new instance of the GooPresistentParam<T,X> class using default values derived from type X.
public GooPresistentParam();Initializes a new instance of the GooPresistentParam<T,X> class with a specified name and subcategory.
public GooPresistentParam(string name, string subcategory);name System.String
The display name of the parameter.
subcategory System.String
The subcategory under which the parameter is listed in the Grasshopper menu.
Gets the unique identifier for this component.
public override System.Guid ComponentGuid { get; }Prompts the user to supply multiple values of type T.
protected override GH_GetterResult Prompt_Plural(ref System.Collections.Generic.List<T?> values);values System.Collections.Generic.List<T>
The list of values supplied by the user.
Grasshopper.Kernel.GH_GetterResult
A Grasshopper.Kernel.GH_GetterResult indicating the outcome of the prompt.
Prompts the user to supply a single value of type T.
protected override GH_GetterResult Prompt_Singular(ref T? value);value T
The value supplied by the user.
Grasshopper.Kernel.GH_GetterResult
A Grasshopper.Kernel.GH_GetterResult indicating the outcome of the prompt.
Represents a non-generic Goo wrapper for any object implementing DiGi.Core.Interfaces.ISerializableObject.
public class GooSerializableObject : DiGi.Rhino.Core.Classes.GooSerializableObject<DiGi.Core.Interfaces.ISerializableObject>Inheritance Grasshopper.Kernel.Types.GH_Goo → Grasshopper.Kernel.Types.IGH_Goo → GH_IO.GH_ISerializable → DiGi.Rhino.Core.Classes.GooObject<DiGi.Core.Interfaces.ISerializableObject> → DiGi.Rhino.Core.Classes.GooSerializableObject<DiGi.Core.Interfaces.ISerializableObject> → GooSerializableObject
Initializes a new instance of the GooSerializableObject class.
public GooSerializableObject();Initializes a new instance of the GooSerializableObject class with a specified serializable object.
public GooSerializableObject(DiGi.Core.Interfaces.ISerializableObject? serializableObject);serializableObject DiGi.Core.Interfaces.ISerializableObject
The serializable object to wrap.
Creates a duplicate of the current Goo object.
public override IGH_Goo? Duplicate();Grasshopper.Kernel.Types.IGH_Goo
A new instance of GooSerializableObject containing the same value.
Represents a Goo wrapper for an object that implements the DiGi.Core.Interfaces.ISerializableObject interface, allowing it to be passed through Grasshopper wires while maintaining serialization capabilities.
public class GooSerializableObject<TSerializableObject> : DiGi.Rhino.Core.Classes.GooObject<TSerializableObject?>, DiGi.Rhino.Core.Interfaces.IGooSerializableObject<TSerializableObject>, DiGi.Rhino.Core.Interfaces.IGooSerializableObject, DiGi.Rhino.Core.Interfaces.IGooObject, DiGi.Rhino.Core.Interfaces.IGooObject<TSerializableObject?>
where TSerializableObject : DiGi.Core.Interfaces.ISerializableObjectTSerializableObject
The type of the serializable object.
Inheritance Grasshopper.Kernel.Types.GH_Goo → Grasshopper.Kernel.Types.IGH_Goo → GH_IO.GH_ISerializable → DiGi.Rhino.Core.Classes.GooObject<TSerializableObject> → GooSerializableObject<TSerializableObject>
Derived
↳ GooAddress
↳ GooCoordinates
↳ GooParameter
↳ GooParameterDefinition
↳ GooParametrizedObject
↳ GooTimeSeries
↳ GooSerializableObject
Implements DiGi.Rhino.Core.Interfaces.IGooSerializableObject<TSerializableObject>, IGooSerializableObject, IGooObject, DiGi.Rhino.Core.Interfaces.IGooObject<TSerializableObject>
Initializes a new instance of the GooSerializableObject<TSerializableObject> class.
public GooSerializableObject();Initializes a new instance of the GooSerializableObject<TSerializableObject> class with a specified serializable object.
public GooSerializableObject(TSerializableObject? serializableObject);serializableObject TSerializableObject
The serializable object to wrap.
Creates a duplicate of the current Goo object.
public override IGH_Goo? Duplicate();Grasshopper.Kernel.Types.IGH_Goo
A new instance of GooSerializableObject<TSerializableObject> containing the same value.
A Grasshopper persistent parameter that handles GooSerializableObject types.
public class GooSerializableObjectParamInheritance Grasshopper.Kernel.GH_PersistentParam → GooSerializableObjectParam
Initializes a new instance of the GooSerializableObjectParam class.
public GooSerializableObjectParam();Gets the unique identifier for this component.
public override System.Guid ComponentGuid { get; }Appends additional custom menu items to the parameter's context menu.
public override void AppendAdditionalMenuItems(System.Windows.Forms.ToolStripDropDown menu);menu System.Windows.Forms.ToolStripDropDown
The dropdown menu to append items to.
Handles the "Save As..." menu item click event.
private void Menu_SaveAs(object? sender, System.EventArgs? e);sender System.Object
The source of the event.
The event arguments.
Prompts the user to select multiple values for the parameter.
protected override GH_GetterResult Prompt_Plural(ref System.Collections.Generic.List<DiGi.Rhino.Core.Classes.GooSerializableObject?> values);values System.Collections.Generic.List<GooSerializableObject>
The list of selected values.
Grasshopper.Kernel.GH_GetterResult
A result indicating whether the operation was successful.
Prompts the user to select a single value for the parameter.
protected override GH_GetterResult Prompt_Singular(ref DiGi.Rhino.Core.Classes.GooSerializableObject? value);value GooSerializableObject
The selected value.
Grasshopper.Kernel.GH_GetterResult
A result indicating whether the operation was successful.
Represents a persistent parameter that handles serializable objects of type T and X.
public class GooSerializablePresistentParam<T,X> : DiGi.Rhino.Core.Classes.GooPresistentParam<T, X>
where T : DiGi.Rhino.Core.Classes.GooSerializableObject<X>
where X : DiGi.Core.Interfaces.ISerializableObjectT
The type of the Goo object, which must derive from GooSerializableObject<TSerializableObject>.
X
The underlying serializable data type that implements DiGi.Core.Interfaces.ISerializableObject.
Inheritance Grasshopper.Kernel.GH_PersistentParam → DiGi.Rhino.Core.Classes.GooPresistentParam<T,X> → GooSerializablePresistentParam<T,X>
Derived
↳ GooAddressParam
↳ GooCoordinatesParam
↳ GooParameterDefinitionParam
↳ GooParameterParam
↳ GooParametrizedObjectParam
↳ GooTimeSeriesParam
Initializes a new instance of the GooSerializablePresistentParam<T,X> class.
public GooSerializablePresistentParam();Initializes a new instance of the GooSerializablePresistentParam<T,X> class with a specified name and subcategory.
public GooSerializablePresistentParam(string name, string subcategory);name System.String
The display name of the parameter.
subcategory System.String
The subcategory used for grouping in the Grasshopper interface.
Gets the unique identifier for this component type.
public override System.Guid ComponentGuid { get; }Appends additional custom items to the context menu of the parameter.
public override void AppendAdditionalMenuItems(System.Windows.Forms.ToolStripDropDown menu);menu System.Windows.Forms.ToolStripDropDown
The System.Windows.Forms.ToolStripDropDown menu to which items will be added.
Prompts the user to provide multiple values for the parameter.
protected override GH_GetterResult Prompt_Plural(ref System.Collections.Generic.List<T?> values);values System.Collections.Generic.List<T>
A reference to the list of values to be retrieved.
Grasshopper.Kernel.GH_GetterResult
The result of the getter operation as a Grasshopper.Kernel.GH_GetterResult.
Prompts the user to provide a single value for the parameter.
protected override GH_GetterResult Prompt_Singular(ref T? value);value T
A reference to the value to be retrieved.
Grasshopper.Kernel.GH_GetterResult
The result of the getter operation as a Grasshopper.Kernel.GH_GetterResult.
Represents a Goo wrapper for System.Type, allowing system types to be passed through Grasshopper wires.
public class GooType : DiGi.Rhino.Core.Classes.GooObject<System.Type>, DiGi.Rhino.Core.Interfaces.IGooObject<System.Type>, DiGi.Rhino.Core.Interfaces.IGooObjectInheritance Grasshopper.Kernel.Types.GH_Goo → Grasshopper.Kernel.Types.IGH_Goo → GH_IO.GH_ISerializable → DiGi.Rhino.Core.Classes.GooObject<System.Type> → GooType
Implements DiGi.Rhino.Core.Interfaces.IGooObject<System.Type>, IGooObject
Initializes a new instance of the GooType class.
public GooType();Initializes a new instance of the GooType class with a specified type.
public GooType(System.Type? type);type System.Type
The System.Type to be wrapped in the Goo object.
Creates a duplicate of the current Goo object.
public override IGH_Goo? Duplicate();Grasshopper.Kernel.Types.IGH_Goo
A new GooType instance containing the same value.
A Grasshopper parameter used to input and output GooType objects.
public class GooTypeParamInheritance Grasshopper.Kernel.GH_PersistentParam → GooTypeParam
Initializes a new instance of the GooTypeParam class.
public GooTypeParam();Gets the unique identifier for the GooTypeParam component.
public override System.Guid ComponentGuid { get; }A Grasshopper component that inspects DiGi objects and dynamically generates output parameters based on the input object's serializable properties.
public class Inspect : DiGi.Rhino.Core.Classes.ComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → Inspect
Initializes a new instance of the Inspect component.
public Inspect();Gets the unique identifier for this Grasshopper component.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component in the Grasshopper toolbar.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Called when this component is added to a Grasshopper document.
public override void AddedToDocument(GH_Document document);document Grasshopper.Kernel.GH_Document
The Grasshopper document to which the component is being added.
Appends additional custom menu items to the component's right-click context menu.
public override void AppendAdditionalMenuItems(System.Windows.Forms.ToolStripDropDown menu);menu System.Windows.Forms.ToolStripDropDown
The tool strip dropdown menu to which items are appended.
Registers all input parameters for this component.
protected override void RegisterInputParams(GH_InputParamManager inputParamManager);inputParamManager Grasshopper.Kernel.GH_Component.GH_InputParamManager
The manager used to register input parameters.
Registers all output parameters for this component.
protected override void RegisterOutputParams(GH_OutputParamManager outputParamManager);outputParamManager Grasshopper.Kernel.GH_Component.GH_OutputParamManager
The manager used to register output parameters.
Executes the main logic of the component, reading the input object and setting values on the dynamically generated output parameters.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The data access object used to retrieve inputs and set outputs.
Attribute used to mark methods for inspection purposes, providing metadata such as name, nickname, and description.
public class InspectAttribute : System.AttributeInheritance System.Object → System.Attribute → InspectAttribute
Initializes a new instance of the InspectAttribute class.
public InspectAttribute(string name, string nickname, string description);name System.String
The formal name of the inspection.
nickname System.String
The nickname of the inspection.
description System.String
The description of the inspection.
Gets the detailed description of the inspected method.
public string Description { get; }Gets the formal name associated with the inspected method.
public string Name { get; }Gets the nickname or short name associated with the inspected method.
public string Nickname { get; }Manages the discovery and retrieval of inspection methods associated with specific types.
public class InspectManagerInheritance System.Object → InspectManager
Initializes a new instance of the InspectManager class.
public InspectManager();Retrieves a list of inspection methods that are applicable to the specified type.
public System.Collections.Generic.List<DiGi.Rhino.Core.Classes.InspectMethod>? GetInspectMethods(System.Type? type);type System.Type
The type for which to retrieve inspection methods.
System.Collections.Generic.List<InspectMethod>
A list of InspectMethod objects associated with the provided type or its base types; returns null if the internal dictionary fails to initialize.
Provides functionality to inspect and invoke a method associated with an InspectAttribute.
public class InspectMethodInheritance System.Object → InspectMethod
Initializes a new instance of the InspectMethod class.
public InspectMethod(System.Reflection.MethodInfo? methodInfo, DiGi.Rhino.Core.Classes.InspectAttribute? inspectAttribute);methodInfo System.Reflection.MethodInfo
The reflection information of the method.
inspectAttribute InspectAttribute
The attribute associated with the method.
Gets the attribute associated with the inspected method.
public DiGi.Rhino.Core.Classes.InspectAttribute? InspectAttribute { get; }Gets the reflection information of the inspected method.
public System.Reflection.MethodInfo? MethodInfo { get; }Checks if the inspected method is valid and specifically returns an enumerable collection.
public bool IsEnumerable();System.Boolean
True if the method is valid and return type is enumerable; otherwise, false.
Determines whether the inspected method is valid.
public bool IsValid();System.Boolean
True if the method is valid; otherwise, false.
Determines whether the inspected method is valid based on its return type.
public bool IsValid(out bool enumerable);enumerable System.Boolean
When this method returns, contains a boolean value indicating whether the return type is an enumerable collection.
System.Boolean
True if the method is valid; otherwise, false.
Attempts to invoke the inspected method and convert its result to a specified type.
public bool TryGetValue<T>(object? @object, out T? value);T
The target type for the return value.
object System.Object
The object instance to use for invocation (if applicable).
value T
When this method returns, contains the converted value if successful; otherwise, the default value of <typeparam ref="T" />.
System.Boolean
True if the value was successfully retrieved and converted; otherwise, false.
Provides a null implementation of the Grasshopper.Kernel.IGH_Attributes interface, serving as a placeholder or default attribute set that performs no operations.
public class NullAttributesInheritance System.Object → Grasshopper.Kernel.IGH_Attributes → GH_IO.GH_ISerializable → Grasshopper.GUI.Canvas.IGH_ResponsiveObject → Grasshopper.GUI.Canvas.IGH_TooltipAwareObject → NullAttributes
Initializes a new instance of the NullAttributes class.
public NullAttributes();Gets a value indicating whether message balloons are allowed for these attributes.
public bool AllowMessageBalloon { get; }Gets or sets the bounding rectangle of the attributes.
public System.Drawing.RectangleF Bounds { get; set; }System.NotImplementedException
Thrown when setting the value.
Gets the document object associated with these attributes.
public IGH_DocumentObject? DocObject { get; }Grasshopper.Kernel.IGH_DocumentObject
Gets the top-level attribute set in the hierarchy.
public IGH_Attributes? GetTopLevel { get; }Grasshopper.Kernel.IGH_Attributes
Gets a value indicating whether the attributes have an input grip.
public bool HasInputGrip { get; }Gets a value indicating whether the attributes have an output grip.
public bool HasOutputGrip { get; }Gets the position of the input grip on the canvas.
public System.Drawing.PointF InputGrip { get; }Gets the unique identifier for this instance of the attributes.
public System.Guid InstanceGuid { get; }Gets a value indicating whether these attributes are at the top level of the hierarchy.
public bool IsTopLevel { get; }Gets the position of the output grip on the canvas.
public System.Drawing.PointF OutputGrip { get; }Gets or sets the parent attribute set.
public IGH_Attributes? Parent { get; set; }Grasshopper.Kernel.IGH_Attributes
System.NotImplementedException
Thrown when setting the value.
Gets the path name associated with these attributes.
public string PathName { get; }Gets or sets the pivot point of the attributes.
public System.Drawing.PointF Pivot { get; set; }System.NotImplementedException
Thrown when setting the value.
Gets or sets a value indicating whether these attributes are currently selected.
public bool Selected { get; set; }System.NotImplementedException
Thrown when setting the value.
Gets a value indicating whether tooltips are enabled for these attributes.
public bool TooltipEnabled { get; }Appends the current attribute instance to the provided attribute tree list.
public void AppendToAttributeTree(System.Collections.Generic.List<IGH_Attributes> attributes);attributes System.Collections.Generic.List<Grasshopper.Kernel.IGH_Attributes>
The list of attributes to append to.
Notifies the system that the layout of the attributes has expired and needs to be recalculated.
public void ExpireLayout();Determines whether the canvas should be invalidated based on a mouse event.
public bool InvalidateCanvas(GH_Canvas canvas, GH_CanvasMouseEvent e);canvas Grasshopper.GUI.Canvas.GH_Canvas
The canvas where the event occurred.
e Grasshopper.GUI.GH_CanvasMouseEvent
The mouse event arguments.
System.Boolean
true if the canvas should be invalidated; otherwise, false.
Determines whether a specific point on the canvas is within the menu region of these attributes.
public bool IsMenuRegion(System.Drawing.PointF point);point System.Drawing.PointF
The point to test.
System.Boolean
true if the point is in the menu region; otherwise, false.
Determines whether a specific point on the canvas is within the pickable region of these attributes.
public bool IsPickRegion(System.Drawing.PointF point);point System.Drawing.PointF
The point to test.
System.Boolean
true if the point is in the pick region; otherwise, false.
Determines whether a specific rectangular area on the canvas intersects with the pickable region of these attributes.
public bool IsPickRegion(System.Drawing.RectangleF box, GH_PickBox method);The bounding box to test.
method Grasshopper.Kernel.GH_PickBox
The picking method used.
System.Boolean
true if the area is in the pick region; otherwise, false.
Determines whether a specific point on the canvas is within the tooltip region of these attributes.
public bool IsTooltipRegion(System.Drawing.PointF canvasPoint);canvasPoint System.Drawing.PointF
The point to test.
System.Boolean
true if the point is in the tooltip region; otherwise, false.
Generates a new unique identifier for this instance.
public void NewInstanceGuid();System.NotImplementedException
Thrown because this method is not implemented.
Assigns a specific unique identifier to this instance.
public void NewInstanceGuid(System.Guid newID);newID System.Guid
The new GUID to assign.
System.NotImplementedException
Thrown because this method is not implemented.
Performs the layout calculations for the attributes.
public void PerformLayout();System.NotImplementedException
Thrown because this method is not implemented.
Reads the attributes from a serialization reader.
public bool Read(GH_IReader reader);reader GH_IO.Serialization.GH_IReader
The reader to read data from.
System.Boolean
true if reading was successful; otherwise, false.
Renders the attributes onto the Grasshopper canvas using the specified channel.
public void RenderToCanvas(GH_Canvas canvas, GH_CanvasChannel channel);canvas Grasshopper.GUI.Canvas.GH_Canvas
The canvas to render on.
channel Grasshopper.GUI.Canvas.GH_CanvasChannel
The rendering channel to use.
Handles the key down event on the canvas.
public GH_ObjectResponse RespondToKeyDown(GH_Canvas sender, System.Windows.Forms.KeyEventArgs e);sender Grasshopper.GUI.Canvas.GH_Canvas
The canvas that sent the event.
e System.Windows.Forms.KeyEventArgs
The key event arguments.
Grasshopper.GUI.Canvas.GH_ObjectResponse
A Grasshopper.GUI.Canvas.GH_ObjectResponse indicating how the event was handled.
Handles the key up event on the canvas.
public GH_ObjectResponse RespondToKeyUp(GH_Canvas sender, System.Windows.Forms.KeyEventArgs e);sender Grasshopper.GUI.Canvas.GH_Canvas
The canvas that sent the event.
e System.Windows.Forms.KeyEventArgs
The key event arguments.
Grasshopper.GUI.Canvas.GH_ObjectResponse
A Grasshopper.GUI.Canvas.GH_ObjectResponse indicating how the event was handled.
Handles the mouse double-click event on the canvas.
public GH_ObjectResponse RespondToMouseDoubleClick(GH_Canvas sender, GH_CanvasMouseEvent e);sender Grasshopper.GUI.Canvas.GH_Canvas
The canvas that sent the event.
e Grasshopper.GUI.GH_CanvasMouseEvent
The mouse event arguments.
Grasshopper.GUI.Canvas.GH_ObjectResponse
A Grasshopper.GUI.Canvas.GH_ObjectResponse indicating how the event was handled.
Handles the mouse down event on the canvas.
public GH_ObjectResponse RespondToMouseDown(GH_Canvas sender, GH_CanvasMouseEvent e);sender Grasshopper.GUI.Canvas.GH_Canvas
The canvas that sent the event.
e Grasshopper.GUI.GH_CanvasMouseEvent
The mouse event arguments.
Grasshopper.GUI.Canvas.GH_ObjectResponse
A Grasshopper.GUI.Canvas.GH_ObjectResponse indicating how the event was handled.
Handles the mouse move event on the canvas.
public GH_ObjectResponse RespondToMouseMove(GH_Canvas sender, GH_CanvasMouseEvent e);sender Grasshopper.GUI.Canvas.GH_Canvas
The canvas that sent the event.
e Grasshopper.GUI.GH_CanvasMouseEvent
The mouse event arguments.
Grasshopper.GUI.Canvas.GH_ObjectResponse
A Grasshopper.GUI.Canvas.GH_ObjectResponse indicating how the event was handled.
Handles the mouse up event on the canvas.
public GH_ObjectResponse RespondToMouseUp(GH_Canvas sender, GH_CanvasMouseEvent e);sender Grasshopper.GUI.Canvas.GH_Canvas
The canvas that sent the event.
e Grasshopper.GUI.GH_CanvasMouseEvent
The mouse event arguments.
Grasshopper.GUI.Canvas.GH_ObjectResponse
A Grasshopper.GUI.Canvas.GH_ObjectResponse indicating how the event was handled.
Configures the tooltip display for these attributes at a specific canvas point.
public void SetupTooltip(System.Drawing.PointF canvasPoint, GH_TooltipDisplayEventArgs e);canvasPoint System.Drawing.PointF
The point on the canvas where the tooltip is triggered.
e Grasshopper.GUI.GH_TooltipDisplayEventArgs
The tooltip display event arguments.
Writes the attributes to a serialization writer.
public bool Write(GH_IWriter writer);writer GH_IO.Serialization.GH_IWriter
The writer to write data to.
System.Boolean
true if writing was successful; otherwise, false.
Represents a component that allows the selection of a number comparison type.
public class NumberComparisonType : DiGi.Rhino.Core.Classes.EnumComponent<DiGi.Core.Enums.NumberComparisonType>Inheritance Grasshopper.Kernel.GH_Component → DiGi.Rhino.Core.Classes.EnumComponent<DiGi.Core.Enums.NumberComparisonType> → NumberComparisonType
Initializes a new instance of the NumberComparisonType class.
public NumberComparisonType();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }A Grasshopper component that reads serializable objects from a specified file path.
public class Read : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → Read
Initializes a new instance of the Read class.
public Read();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component, determining how it is displayed in the Grasshopper canvas.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object is used to retrieve from inputs and store in outputs.
A component that removes a specific parameter definition from a parametrized object.
public class RemoveValue : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → RemoveValue
Initializes a new instance of the RemoveValue class.
public RemoveValue();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }Executes the logic to remove a specific parameter definition from the provided parametrized object.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object used to retrieve data from inputs and store results in outputs.
Provides assembly information for the DiGi.Rhino.Core Grasshopper plugin.
public class RhinoInfoInheritance Grasshopper.Kernel.GH_AssemblyInfo → RhinoInfo
Gets the preferred contact details for the author.
public override string AuthorContact { get; }Gets the name of the author or company.
public override string AuthorName { get; }Gets a short string describing the purpose of this GHA library.
public override string Description { get; }Gets a 24x24 pixel bitmap to represent this GHA library.
public override System.Drawing.Bitmap? Icon { get; }Gets the unique identifier for this assembly.
public override System.Guid Id { get; }Gets the name of the GHA library.
public override string Name { get; }A Grasshopper component that serializes a collection of DiGi.Core.Interfaces.ISerializableObject objects into a JSON string format.
public class Serialize : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → Serialize
Initializes a new instance of object.
public Serialize();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component, which determines how it is displayed in the Grasshopper canvas.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object is used to retrieve from inputs and store in outputs.
A Grasshopper component that sets a value for a given parameter definition on a parametrized object.
public class SetValue : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → SetValue
Initializes a new instance of object.
public SetValue();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object is used to retrieve from inputs and store in outputs.
Represents the text comparison type component, providing functionality to specify how two strings are compared.
public class TextComparisonType : DiGi.Rhino.Core.Classes.EnumComponent<DiGi.Core.Enums.TextComparisonType>Inheritance Grasshopper.Kernel.GH_Component → DiGi.Rhino.Core.Classes.EnumComponent<DiGi.Core.Enums.TextComparisonType> → TextComparisonType
Initializes a new instance of the TextComparisonType class.
public TextComparisonType();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Represents a Grasshopper component that generates a time series based on a specified start time, end time, and step interval.
public class TimeSeries : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → TimeSeries
Initializes a new instance of the TimeSeries class.
public TimeSeries();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component, determining its visibility and priority in the Grasshopper canvas.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object is used to retrieve from inputs and store in outputs.
A Grasshopper component that retrieves a .NET System.Type based on its full assembly-qualified name.
public class TypeByFullName : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → TypeByFullName
Initializes a new instance of the TypeByFullName class.
public TypeByFullName();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component, which determines its visual representation in the Grasshopper canvas.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object is used to retrieve from inputs and store in outputs.
A Grasshopper component that retrieves the type of a given input object.
public class TypeByObject : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → TypeByObject
Initializes a new instance of the TypeByObject class.
public TypeByObject();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component, which defines how it is displayed in the Grasshopper canvas.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object is used to retrieve from inputs and store in outputs.
Represents a component for handling Coordinated Universal Time (UTC) time zones.
public class UTC : DiGi.Rhino.Core.Classes.EnumComponent<DiGi.Core.Enums.UTC>Inheritance Grasshopper.Kernel.GH_Component → DiGi.Rhino.Core.Classes.EnumComponent<DiGi.Core.Enums.UTC> → UTC
Initializes a new instance of the UTC class.
public UTC();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Provides a base implementation for Grasshopper components that support dynamic addition and removal of parameters based on predefined templates.
public abstract class VariableParameterComponent : DiGi.Rhino.Core.Classes.ComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent
Derived
↳ Address
↳ Coordinates
↳ Deserialize
↳ FilterByMask
↳ FilterByNumber
↳ FilterByText
↳ GetValue
↳ Read
↳ RemoveValue
↳ Serialize
↳ SetValue
↳ TimeSeries
↳ TypeByFullName
↳ TypeByObject
↳ Write
Initializes a new instance of the VariableParameterComponent class.
public VariableParameterComponent(string name, string nickname, string description, string category, string subCategory);name System.String
The name of the component.
nickname System.String
The nickname of the component.
description System.String
The description of the component.
category System.String
The category the component belongs to.
subCategory System.String
The sub-category the component belongs to.
Gets the template definitions for the input parameters.
protected abstract DiGi.Rhino.Core.Classes.Param[]? Inputs { protected get; }Gets the template definitions for the output parameters.
protected abstract DiGi.Rhino.Core.Classes.Param[]? Outputs { protected get; }Determines whether a parameter can be inserted at the specified index on the given side of the component.
public bool CanInsertParameter(GH_ParameterSide parameterSide, int index);parameterSide Grasshopper.Kernel.GH_ParameterSide
The side (Input or Output) where the parameter is to be inserted.
index System.Int32
The index position for insertion.
System.Boolean
true if the parameter can be inserted; otherwise, false.
Determines whether a parameter can be removed from the specified index on the given side of the component.
public bool CanRemoveParameter(GH_ParameterSide parameterSide, int index);parameterSide Grasshopper.Kernel.GH_ParameterSide
The side (Input or Output) where the parameter is to be removed.
index System.Int32
The index position of the parameter to remove.
System.Boolean
true if the parameter can be removed; otherwise, false.
Creates a new parameter based on the template definition for the specified side and index.
public IGH_Param? CreateParameter(GH_ParameterSide parameterSide, int index);parameterSide Grasshopper.Kernel.GH_ParameterSide
The side (Input or Output) where the parameter is to be created.
index System.Int32
The index position for creation.
Grasshopper.Kernel.IGH_Param
A cloned instance of the template parameter, or null if no suitable template exists.
Destroys a parameter at the specified index on the given side of the component.
public virtual bool DestroyParameter(GH_ParameterSide parameterSide, int index);parameterSide Grasshopper.Kernel.GH_ParameterSide
The side (Input or Output) where the parameter is to be destroyed.
index System.Int32
The index position of the parameter to destroy.
System.Boolean
true if the parameter was successfully destroyed; otherwise, false.
Registers the default input parameters based on the provided templates.
protected sealed override void RegisterInputParams(GH_InputParamManager inputParamManager);inputParamManager Grasshopper.Kernel.GH_Component.GH_InputParamManager
The manager used to register input parameters.
Registers the default output parameters based on the provided templates.
protected sealed override void RegisterOutputParams(GH_OutputParamManager outputParamManager);outputParamManager Grasshopper.Kernel.GH_Component.GH_OutputParamManager
The manager used to register output parameters.
Performs maintenance tasks on the variable parameters of the component.
public void VariableParameterMaintenance();A Grasshopper component that serializes a collection of DiGi.Core.Interfaces.ISerializableObject instances and writes them to a file in JSON format.
public class Write : DiGi.Rhino.Core.Classes.VariableParameterComponentInheritance Grasshopper.Kernel.GH_Component → Component → Grasshopper.Kernel.IGH_VariableParameterComponent → VariableParameterComponent → Write
Initializes a new instance of the Write class.
public Write();Gets the unique ID for this component. Do not change this ID after release.
public override System.Guid ComponentGuid { get; }Gets the exposure level of the component, which determines how it is displayed and interacted with in the Grasshopper canvas.
public override GH_Exposure Exposure { get; }Grasshopper.Kernel.GH_Exposure
Registers all the input parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Inputs { protected get; }Registers all the output parameters for this component.
protected override DiGi.Rhino.Core.Classes.Param[] Outputs { protected get; }This is the method that actually does the work.
protected override void SolveInstance(IGH_DataAccess dataAccess);dataAccess Grasshopper.Kernel.IGH_DataAccess
The DA object is used to retrieve from inputs and store in outputs.
Represents a wrapper for a Grasshopper parameter, including its visibility settings.
public readonly struct ParamInitializes a new instance of the Param struct with default visibility set to Binding.
public Param(IGH_Param gH_Param);gH_Param Grasshopper.Kernel.IGH_Param
The Grasshopper parameter to wrap.
Initializes a new instance of the Param struct with specified visibility.
public Param(IGH_Param gH_Param, DiGi.Rhino.Core.Enums.ParameterVisibility parameterVisibility);gH_Param Grasshopper.Kernel.IGH_Param
The Grasshopper parameter to wrap.
parameterVisibility ParameterVisibility
The visibility setting for the parameter.
Gets the underlying Grasshopper parameter instance.
public readonly IGH_Param GH_Param;Gets the visibility setting for this parameter.
public readonly ParameterVisibility ParameterVisibility;