This class is used during Component construction to add input parameters.
Properties
ParamCount
#Returns the number of input parameters already part of this component.
Overrides: GH_ParamManager.ParamCount
Indexers
Param
#Gets the input parameter at the given index.
Parameters:
| index (int) |
Overrides: GH_ParamManager.Param
Methods
AddAngleParameter
#Add a floating point Number parameter to the input list of this component. The parameter will be aware that it is representing angles.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (double) | A default value to store in the parameter Persistent Data. |
AddAngleParameter
#public int AddAngleParameter(string name, string nickname, string description, GH_ParamAccess access, IEnumerable<double> default)
Add a floating point Number parameter to the input list of this component. The parameter will be aware that it is representing angles.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (IEnumerable<double>) | A collection of default values to store in the parameter Persistent Data. |
AddAngleParameter
#public int AddAngleParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a floating point Number parameter to the input list of this component. The parameter will be aware that it is representing angles.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddArcParameter
#Add a 3D Arc parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (Arc) | A default value to store in the parameter Persistent Data. |
AddArcParameter
#Add a 3D Arc parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddBooleanParameter
#Add a Boolean parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (bool) | A default value to store in the parameter Persistent Data. |
AddBooleanParameter
#public int AddBooleanParameter(string name, string nickname, string description, GH_ParamAccess access, IEnumerable<bool> default)
Add a Boolean parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (IEnumerable<bool>) | A collection of default values to store in the parameter Persistent Data. |
AddBooleanParameter
#public int AddBooleanParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Boolean parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddBoxParameter
#Add a 3D Box parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (Box) | A default value to store in the parameter Persistent Data. |
AddBoxParameter
#Add a 3D Box parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddBrepParameter
#public int AddBrepParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Brep parameter to the input list of this component. Brep parameters can handle both trimmed and untrimmed single or multi-faced Breps.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddCircleParameter
#Add a 3D Circle parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (Circle) | A default value to store in the parameter Persistent Data. |
AddCircleParameter
#public int AddCircleParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Circle parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddColourParameter
#public int AddColourParameter(string name, string nickname, string description, GH_ParamAccess access, Color default)
Add an ARGB Colour parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (Color) | A default value to store in the parameter Persistent Data. |
AddColourParameter
#public int AddColourParameter(string name, string nickname, string description, GH_ParamAccess access, IEnumerable<Color> default)
Add an ARGB Colour parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (IEnumerable<Color>) | A collection of default values to store in the parameter Persistent Data. |
AddColourParameter
#public int AddColourParameter(string name, string nickname, string description, GH_ParamAccess access)
Add an ARGB Colour parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddComplexNumberParameter
#public int AddComplexNumberParameter(string name, string nickname, string description, GH_ParamAccess access, GH_ComplexNumber default)
Add a Complex Number parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (GH_ComplexNumber) | A default value to store in the parameter Persistent Data. |
AddComplexNumberParameter
#public int AddComplexNumberParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Complex Number parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddCultureParameter
#public int AddCultureParameter(string name, string nickname, string description, GH_ParamAccess access, CultureInfo default)
Add a Culture parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (CultureInfo) | A default value to store in the parameter Persistent Data. |
AddCultureParameter
#public int AddCultureParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Cultue parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddCurveParameter
#public int AddCurveParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Curve parameter to the input list of this component. Curve parameters can handle all curve types (Lines, Polylines, Circles, Arcs, NurbsCurves etc.)
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddFieldParameter
#public int AddFieldParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Field parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddGenericParameter
#public int AddGenericParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Generic parameter to the input list of this component. Generic parameters can handle all types of data.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddGeometryParameter
#public int AddGeometryParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a generic 3D Geometry parameter to the input list of this component. Geometry parameters can handle all types that represent actual shapes.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddGroupParameter
#public int AddGroupParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Transform Group parameter to the input list of this component. Groups are collections of geometry that are transformed as one, they are not the same as Rhino groups.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddIntegerParameter
#public int AddIntegerParameter(string name, string nickname, string description, GH_ParamAccess access, IEnumerable<int> default)
Add a Integer parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (IEnumerable<int>) | A collection of default values to store in the parameter Persistent Data. |
AddIntegerParameter
#Add a Integer parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (int) | A default value to store in the parameter Persistent Data. |
AddIntegerParameter
#public int AddIntegerParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Integer parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddInterval2DParameter
#public int AddInterval2DParameter(string name, string nickname, string description, GH_ParamAccess access)
Add an Interval2D (i.e. uv domain) parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddIntervalParameter
#public int AddIntervalParameter(string name, string nickname, string description, GH_ParamAccess access, IEnumerable<Interval> default)
Add an Interval (i.e. numeric domain) parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (IEnumerable<Interval>) | A collection of default values to store in the parameter Persistent Data. |
AddIntervalParameter
#Add an Interval (i.e. numeric domain) parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (Interval) | A default value to store in the parameter Persistent Data. |
AddIntervalParameter
#public int AddIntervalParameter(string name, string nickname, string description, GH_ParamAccess access)
Add an Interval (i.e. numeric domain) parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddLineParameter
#Add a 3D Line parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (Line) | A default value to store in the parameter Persistent Data. |
AddLineParameter
#public int AddLineParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Line parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddMatrixParameter
#public int AddMatrixParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Matrix parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddMeshFaceParameter
#public int AddMeshFaceParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a topological MeshFace parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddMeshParameter
#public int AddMeshParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Mesh parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddNumberParameter
#Add a floating point Number parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (double) | A default value to store in the parameter Persistent Data. |
AddNumberParameter
#public int AddNumberParameter(string name, string nickname, string description, GH_ParamAccess access, IEnumerable<double> default)
Add a floating point Number parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (IEnumerable<double>) | A collection of default values to store in the parameter Persistent Data. |
AddNumberParameter
#public int AddNumberParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a floating point Number parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddParameter
#Generic parameter addition. If you cannot use one of the utility methods provided by this class, you can register a customized parameter using this method.
Parameters:
| param (IGH_Param) | The parameter to add. |
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
Returns: Index of the newly added parameter.
AddParameter
#Generic parameter addition. If you cannot use one of the utility methods provided by this class, you can register a customized parameter using this method.
Parameters:
| param (IGH_Param) | The parameter to add. |
Returns: Index of the newly added parameter.
AddPathParameter
#public int AddPathParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Data Path parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddPlaneParameter
#Add a 3D Plane parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (Plane) | A default value to store in the parameter Persistent Data. |
AddPlaneParameter
#public int AddPlaneParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Plane parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddPointParameter
#public int AddPointParameter(string name, string nickname, string description, GH_ParamAccess access, IEnumerable<Point3d> default)
Register a new 3D point param with multiple default coordinates.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (IEnumerable<Point3d>) | A collection of default values to store in the parameter Persistent Data. |
AddPointParameter
#Register a new 3D point param with a single default coordinate.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (Point3d) | A default value to store in the parameter Persistent Data. |
AddPointParameter
#public int AddPointParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Point parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddRectangleParameter
#public int AddRectangleParameter(string name, string nickname, string description, GH_ParamAccess access, Rectangle3d default)
Add a 3D Rectangle parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (Rectangle3d) | A default value to store in the parameter Persistent Data. |
AddRectangleParameter
#public int AddRectangleParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Rectangle parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddScriptVariableParameter
#public int AddScriptVariableParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Script Variable parameter to the input list of this component. Script variable parameters are used almost exclusively in VB/C#/Python components so you probably don't want this one.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddSubDParameter
#public int AddSubDParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Sub-D parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddSurfaceParameter
#public int AddSurfaceParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Surface parameter to the input list of this component. Surface parameters can handle both trimmed and untrimmed single-faced Breps.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddTextParameter
#public int AddTextParameter(string name, string nickname, string description, GH_ParamAccess access, IEnumerable<string> default)
Add a Text parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (IEnumerable<string>) | A collection of default values to store in the parameter Persistent Data. |
AddTextParameter
#Add a Text parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (string) | A default value to store in the parameter Persistent Data. |
AddTextParameter
#public int AddTextParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Text parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddTimeParameter
#Add a Time parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (DateTime) | A default value to store in the parameter Persistent Data. |
AddTimeParameter
#public int AddTimeParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Time parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddTransformParameter
#public int AddTransformParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Transformation parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
AddVectorParameter
#Add a 3D Vector parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
| default (Vector3d) | A default value to store in the parameter Persistent Data. |
AddVectorParameter
#public int AddVectorParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Vector parameter to the input list of this component.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear, single sentences are best. |
| access (GH_ParamAccess) | Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. |
FixUpParameter
Assign some common fields to a parameter object.
HideParameter
#Hide a specific input parameter. If the parameter at the given index implements IGH_PreviewObject then the Hidden flag will be set to True. Otherwise, nothing will happen.
Parameters:
| index (int) | Index of parameter to hide. |
Overrides: GH_ParamManager.HideParameter
Register_2DIntervalParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_2DIntervalParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddInterval2DParameter()
Register a new two-dimensional Interval param
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_2DIntervalParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_2DIntervalParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddInterval2DParameter()
Register a new two-dimensional Interval param
Register_ArcParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ArcParam(string name, string nickname, string description, Arc default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddArcParameter()
Register a new 3D arc param with a default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (Arc) | The default arc. |
| access (GH_ParamAccess) |
Register_ArcParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ArcParam(string name, string nickname, string description, Arc default)
obsoleteThis method has been replaced with AddArcParameter()
Register a new 3D arc param with a default value.
Register_ArcParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ArcParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddArcParameter()
Register a new 3D arc param with no default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_ArcParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ArcParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddArcParameter()
Register a new 3D arc param with no default value.
Register_BooleanParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_BooleanParam(string name, string nickname, string description, bool default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddBooleanParameter()
Register a new Boolean primitive param with a default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (bool) | The default value. |
| access (GH_ParamAccess) |
Register_BooleanParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_BooleanParam(string name, string nickname, string description, bool default)
obsoleteThis method has been replaced with AddBooleanParameter()
Register a new Boolean primitive param with a default value.
Register_BooleanParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_BooleanParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddBooleanParameter()
Register a new Boolean primitive param with no default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_BooleanParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_BooleanParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddBooleanParameter()
Register a new Boolean primitive param with no default value.
Register_BoxParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_BoxParam(string name, string nickname, string description, Box Default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddBoxParameter()
Register a new 3D box param with a default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| Default (Box) | The default box. |
| access (GH_ParamAccess) |
Register_BoxParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_BoxParam(string name, string nickname, string description, Box default)
obsoleteThis method has been replaced with AddBoxParameter()
Register a new 3D box param with a default value.
Register_BoxParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_BoxParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddBoxParameter()
Register a new 3D box param with no default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_BoxParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_BoxParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddBoxParameter()
Register a new 3D box param with no default value.
Register_BRepParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_BRepParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddBrepParameter()
Register a new 3D Brep param.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_BRepParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_BRepParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddBrepParameter()
Register a new 3D Brep param.
Register_CircleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_CircleParam(string name, string nickname, string description, Circle default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddCircleParameter()
Register a new 3D circle param with a default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (Circle) | The default circle. |
| access (GH_ParamAccess) |
Register_CircleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_CircleParam(string name, string nickname, string description, Circle default)
obsoleteThis method has been replaced with AddCircleParameter()
Register a new 3D circle param with a default value.
Register_CircleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_CircleParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddCircleParameter()
Register a new 3D circle param with no default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_CircleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_CircleParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddCircleParameter()
Register a new 3D circle param with no default value.
Register_ColourParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ColourParam(string name, string nickname, string description, Color default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddColourParameter()
Register a new colour primitive param with a default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (Color) | The default value. |
| access (GH_ParamAccess) |
Register_ColourParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ColourParam(string name, string nickname, string description, Color default)
obsoleteThis method has been replaced with AddColourParameter()
Register a new colour primitive param with a default value.
Register_ColourParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ColourParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddColourParameter()
Register a new colour primitive param.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_ColourParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ColourParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddColourParameter()
Register a new colour primitive param.
Register_ComplexParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ComplexParam(string name, string nickname, string description, GH_ComplexNumber Default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddComplexNumberParameter()
Register a new Complex primitive param with a default value. This parameter type includes an expression parser.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| Default (GH_ComplexNumber) | The default value. |
| access (GH_ParamAccess) |
Register_ComplexParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ComplexParam(string name, string nickname, string description, GH_ComplexNumber default)
obsoleteThis method has been replaced with AddComplexNumberParameter()
Register a new Complex primitive param with a default value. This parameter type includes an expression parser.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (GH_ComplexNumber) |
Register_ComplexParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ComplexParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddComplexNumberParameter()
Register a new Complex primitive param with no default value. This parameter type includes an expression parser.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_ComplexParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ComplexParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddComplexNumberParameter()
Register a new Complex primitive param with no default value. This parameter type includes an expression parser.
Register_CurveParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_CurveParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddCurveParameter()
Register a new 3D curve param.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_CurveParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_CurveParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddCurveParameter()
Register a new 3D curve param.
Register_DoubleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_DoubleParam(string name, string nickname, string description, double default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddNumberParameter()
Register a new Double primitive param with a default value. This parameter type includes an expression parser.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (double) | The default value. |
| access (GH_ParamAccess) |
Register_DoubleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_DoubleParam(string name, string nickname, string description, double default)
obsoleteThis method has been replaced with AddNumberParameter()
Register a new Double primitive param with a default value. This parameter type includes an expression parser.
Register_DoubleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_DoubleParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddNumberParameter()
Register a new Double primitive param with no default value. This parameter type includes an expression parser.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_DoubleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_DoubleParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddNumberParameter()
Register a new Double primitive param with no default value. This parameter type includes an expression parser.
Register_FieldParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_FieldParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddFieldParameter()
Register a new field parameter.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) | Parameter access type. This affects the DataMatching behaviour. |
Register_FieldParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_FieldParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddFieldParameter()
Register a new field parameter.
Register_GenericParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_GenericParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddGenericParameter()
Register a new generic parameter (contains Object type). Generic parameters are sometimes not capable of duplicating data, so use these with caution.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_GenericParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_GenericParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddGenericParameter()
Register a new generic parameter (contains Object type). Generic parameters are sometimes not capable of duplicating data, so use these with caution.
Register_GeometryParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_GeometryParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddGeometryParameter()
Register a new 3D geometry param. This parameter is useful for transform components etc.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_GeometryParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_GeometryParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddGeometryParameter()
Register a new 3D geometry param. This parameter is useful for transform components etc.
Register_GroupParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_GroupParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddGroupParameter()
Register a new geometric group param.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_GroupParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_GroupParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddGroupParameter()
Register a new geometric group param.
Register_IntegerParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_IntegerParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddIntegerParameter()
Register a new integer primitive param. This parameter type includes an expression parser.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_IntegerParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_IntegerParam(string name, string nickname, string description, int default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddIntegerParameter()
Register a new integer primitive param with a default value. This parameter type includes an expression parser.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (int) | The default value. |
| access (GH_ParamAccess) |
Register_IntegerParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_IntegerParam(string name, string nickname, string description, int default)
obsoleteThis method has been replaced with AddIntegerParameter()
Register a new integer primitive param with a default value. This parameter type includes an expression parser.
Register_IntegerParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_IntegerParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddIntegerParameter()
Register a new integer primitive param. This parameter type includes an expression parser.
Register_IntervalParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_IntervalParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddIntervalParameter()
Register a new Interval param with no default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_IntervalParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_IntervalParam(string name, string nickname, string description, Interval default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddIntervalParameter()
Register a new OnInterval param with a default value
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (Interval) | The default value |
| access (GH_ParamAccess) |
Register_IntervalParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_IntervalParam(string name, string nickname, string description, Interval default)
obsoleteThis method has been replaced with AddIntervalParameter()
Register a new OnInterval param with a default value
Register_IntervalParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_IntervalParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddIntervalParameter()
Register a new Interval param with no default value.
Register_LineParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_LineParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddLineParameter()
Register a new 3D line param with no default value
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_LineParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_LineParam(string name, string nickname, string description, Line default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddLineParameter()
Register a new 3D line param with a default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (Line) | The default line. |
| access (GH_ParamAccess) |
Register_LineParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_LineParam(string name, string nickname, string description, Line default)
obsoleteThis method has been replaced with AddLineParameter()
Register a new 3D line param with a default value.
Register_LineParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_LineParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddLineParameter()
Register a new 3D line param with no default value
Register_MatrixParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_MatrixParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddMatrixParameter()
Register a new matrix parameter.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) | Parameter access type. This affects the DataMatching behaviour. |
Register_MatrixParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_MatrixParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddMatrixParameter()
Register a new matrix parameter.
Register_MeshFaceParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_MeshFaceParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddMeshFaceParameter()
Register a new 3D Mesh face param.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_MeshFaceParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_MeshFaceParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddMeshFaceParameter()
Register a new 3D Mesh face param.
Register_MeshParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_MeshParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddMeshParameter()
Register a new 3D Mesh param.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_MeshParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_MeshParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddMeshParameter()
Register a new 3D Mesh param.
Register_PathParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PathParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddPathParameter()
Register a new Data Structure path param.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_PathParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PathParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddPathParameter()
Register a new Data Structure path param.
Register_PlaneParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PlaneParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddPlaneParameter()
Register a new 3D vector param with no default value
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_PlaneParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PlaneParam(string name, string nickname, string description, Plane default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddPlaneParameter()
Register a new 3D vector param with a default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (Plane) | The default plane. |
| access (GH_ParamAccess) |
Register_PlaneParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PlaneParam(string name, string nickname, string description, Plane default)
obsoleteThis method has been replaced with AddPlaneParameter()
Register a new 3D vector param with a default value.
Register_PlaneParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PlaneParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddPlaneParameter()
Register a new 3D vector param with no default value
Register_PointParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PointParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddPointParameter()
Register a new 3D point param with no default coordinate.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) | Parameter access type. This affects the DataMatching behaviour. |
Register_PointParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PointParam(string name, string nickname, string description, IEnumerable<Point3d> default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddPointParameter()
Register a new 3D point param with multiple default coordinates.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (IEnumerable<Point3d>) | The default coordinates. |
| access (GH_ParamAccess) | Parameter access type. This affects the DataMatching behaviour. |
Register_PointParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PointParam(string name, string nickname, string description, Point3d default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddPointParameter()
Register a new 3D point param with a single default coordinate.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (Point3d) | The default coordinate. |
| access (GH_ParamAccess) | Parameter access type. This affects the DataMatching behaviour. |
Register_PointParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PointParam(string name, string nickname, string description, Point3d default)
obsoleteThis method has been replaced with AddPointParameter()
Register a new 3D point param with a single default coordinate.
Register_PointParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_PointParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddPointParameter()
Register a new 3D point param with no default coordinate.
Register_RectangleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_RectangleParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddRectangleParameter()
Register a new 3D rectangle param with no default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_RectangleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_RectangleParam(string name, string nickname, string description, Rectangle3d default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddRectangleParameter()
Register a new 3D rectangle param with a default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (Rectangle3d) | The default rectangle. |
| access (GH_ParamAccess) |
Register_RectangleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_RectangleParam(string name, string nickname, string description, Rectangle3d default)
obsoleteThis method has been replaced with AddRectangleParameter()
Register a new 3D rectangle param with a default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (Rectangle3d) | The default rectangle. |
Register_RectangleParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_RectangleParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddRectangleParameter()
Register a new 3D rectangle param with no default value.
Register_ScriptParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_ScriptParam(string name, string nickname, string description, bool bIsList = false)
obsoleteThis method has been replaced with AddScriptVariableParameter()
Register a new Script Variable param.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| bIsList (bool = false) | If True, the parameter will be a list parameter which affects the data-matching algorithms |
Register_StringParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_StringParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddTextParameter()
Register a new string primitive param with no default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_StringParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_StringParam(string name, string nickname, string description, string default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddTextParameter()
Register a new string primitive param with a default value.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (string) | The default value. |
| access (GH_ParamAccess) |
Register_StringParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_StringParam(string name, string nickname, string description, string default)
obsoleteThis method has been replaced with AddTextParameter()
Register a new string primitive param with a default value.
Register_StringParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_StringParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddTextParameter()
Register a new string primitive param with no default value.
Register_SurfaceParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_SurfaceParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddSurfaceParameter()
Register a new 3D surface param. Surfaces are Breps can thus be trimmed.
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_SurfaceParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_SurfaceParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddSurfaceParameter()
Register a new 3D surface param. Surfaces are Breps can thus be trimmed.
Register_TransformParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_TransformParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddTransformParameter()
Register a new Transform param
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) |
Register_TransformParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_TransformParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddTransformParameter()
Register a new Transform param
Register_VectorParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_VectorParam(string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddVectorParameter()
Register a new 3D vector param with no default value
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) | Parameter access type. This affects the DataMatching behaviour. |
Register_VectorParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_VectorParam(string name, string nickname, string description, Vector3d default, GH_ParamAccess access)
obsoleteThis method has been replaced with AddVectorParameter()
Register a new 3D vector param with a default value
Parameters:
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| default (Vector3d) | The default vector. |
| access (GH_ParamAccess) | Parameter access type. This affects the DataMatching behaviour. |
Register_VectorParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_VectorParam(string name, string nickname, string description, Vector3d default)
obsoleteThis method has been replaced with AddVectorParameter()
Register a new 3D vector param with a default value
Register_VectorParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void Register_VectorParam(string name, string nickname, string description)
obsoleteThis method has been replaced with AddVectorParameter()
Register a new 3D vector param with no default value
RegisterParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void RegisterParam(IGH_Param new_param, string name, string nickname, string description, GH_ParamAccess access)
obsoleteThis method has been replaced with AddParameter()
Generic parameter registration. This class provides methods to register standard parameters, but if you have a custom type you have to use this generic function.
Parameters:
| new_param (IGH_Param) | The parameter to add. |
| name (string) | The name of the parameter. Keep it short, single words are best. |
| nickname (string) | The nickname of the parameter. Keep it short, single characters are best. |
| description (string) | The description of the parameter. Be succinct but clear. |
| access (GH_ParamAccess) | Parameter access type. This affects the DataMatching behaviour. |
RegisterParam
#[EditorBrowsable(EditorBrowsableState.Never)]
public void RegisterParam(IGH_Param new_param, string name, string nickname, string description)
obsoleteThis method has been replaced with AddParameter()
Generic parameter registration. This class provides methods to register standard parameters, but if you have a custom type you have to use this generic function.
Remarks: The parameter will not be a list parameter