This class is used during Component construction to add output parameters.
Properties
ParamCount
#Returns the number of output parameters already part of this component.
Overrides: GH_ParamManager.ParamCount
Indexers
Param
#Gets the output parameter at the given index.
Parameters:
| index (int) |
Overrides: GH_ParamManager.Param
Methods
AddArcParameter
#Add a 3D Arc parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddBooleanParameter
#public int AddBooleanParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Boolean parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddBoxParameter
#Add a 3D Box parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddBrepParameter
#public int AddBrepParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Brep parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddCircleParameter
#public int AddCircleParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Circle parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddColourParameter
#public int AddColourParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a ARGB Colour parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddComplexNumberParameter
#public int AddComplexNumberParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Complex Number parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddCultureParameter
#public int AddCultureParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Culture parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddCurveParameter
#public int AddCurveParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Curve parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddFieldParameter
#public int AddFieldParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Field parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddGenericParameter
#public int AddGenericParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Generic parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddGeometryParameter
#public int AddGeometryParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Geometry parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddGroupParameter
#public int AddGroupParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Transform Group parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddIntegerParameter
#public int AddIntegerParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Integer parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddInterval2DParameter
#public int AddInterval2DParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Interval2D (i.e. uv domain) parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddIntervalParameter
#public int AddIntervalParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Interval (i.e. numeric domain) parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddLineParameter
#public int AddLineParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Line parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddMatrixParameter
#public int AddMatrixParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Matrix parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddMeshFaceParameter
#public int AddMeshFaceParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a topological MeshFace parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddMeshParameter
#public int AddMeshParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Mesh parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddNumberParameter
#public int AddNumberParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a floating point Number parameter to the output 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 SetData(), SetDataList() or SetDataTree() 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 SetData(), SetDataList() or SetDataTree() 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 output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddPlaneParameter
#public int AddPlaneParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Plane parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddPointParameter
#public int AddPointParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Point parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddRectangleParameter
#public int AddRectangleParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Rectangle parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddSubDParameter
#public int AddSubDParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Sub-D parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddSurfaceParameter
#public int AddSurfaceParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Surface parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddTextParameter
#public int AddTextParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Text parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddTimeParameter
#public int AddTimeParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Time parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddTransformParameter
#public int AddTransformParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a Transformation parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
AddVectorParameter
#public int AddVectorParameter(string name, string nickname, string description, GH_ParamAccess access)
Add a 3D Vector parameter to the output 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 SetData(), SetDataList() or SetDataTree() respectively. |
FixUpParameter
Assign some common fields to a parameter object.
HideParameter
#Hide a specific output parameter. If the parameter at the given index implement 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
#public void Register_2DIntervalParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new two-dimensional OnInterval 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, you should set this field if you intend to output lists here. |
Register_2DIntervalParam
#Register a new two-dimensional OnInterval parameter
Register_ArcParam
#public void Register_ArcParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D arc 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, you should set this field if you intend to output lists here. |
Register_ArcParam
#Register a new 3D arc parameter
Register_BooleanParam
#public void Register_BooleanParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new Boolean primitive 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, you should set this field if you intend to output lists here. |
Register_BooleanParam
#Register a new Boolean primitive parameter
Register_BoxParam
#public void Register_BoxParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D box 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, you should set this field if you intend to output lists here. |
Register_BoxParam
#Register a new 3D box parameter
Register_BRepParam
#public void Register_BRepParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D Brep 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, you should set this field if you intend to output lists here. |
Register_BRepParam
#Register a new 3D Brep parameter
Register_CircleParam
#public void Register_CircleParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D circle 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, you should set this field if you intend to output lists here. |
Register_CircleParam
#Register a new 3D circle parameter
Register_ColourParam
#public void Register_ColourParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new Colour primitive 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, you should set this field if you intend to output lists here. |
Register_ColourParam
#Register a new Colour primitive parameter
Register_ComplexParam
#public void Register_ComplexParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new Complex primitive 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, you should set this field if you intend to output lists here. |
Register_ComplexParam
#Register a new Complex primitive parameter
Register_CurveParam
#public void Register_CurveParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D curve 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, you should set this field if you intend to output lists here. |
Register_CurveParam
#Register a new 3D curve parameter
Register_DoubleParam
#public void Register_DoubleParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new Double primitive 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, you should set this field if you intend to output lists here. |
Register_DoubleParam
#Register a new Double primitive parameter
Register_FieldParam
#public void Register_FieldParam(string name, string nickname, string description, GH_ParamAccess access)
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, you should set this field if you intend to output lists here. |
Register_FieldParam
#Register a new field parameter
Register_GenericParam
#public void Register_GenericParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new Generic (Object) 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, you should set this field if you intend to output lists here. |
Register_GenericParam
#Register a new Generic (Object) parameter
Register_GeometryParam
#public void Register_GeometryParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D geometry 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, you should set this field if you intend to output lists here. |
Register_GeometryParam
#Register a new 3D geometry parameter
Register_GroupParam
#public void Register_GroupParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new geometric group 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, you should set this field if you intend to output lists here. |
Register_GroupParam
#Register a new geometric group parameter
Register_IntegerParam
#public void Register_IntegerParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new Integer primitive 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, you should set this field if you intend to output lists here. |
Register_IntegerParam
#Register a new Integer primitive parameter
Register_IntervalParam
#public void Register_IntervalParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new Interval 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, you should set this field if you intend to output lists here. |
Register_IntervalParam
#Register a new Interval parameter
Register_LineParam
#public void Register_LineParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D line 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, you should set this field if you intend to output lists here. |
Register_LineParam
#Register a new 3D line parameter
Register_MatrixParam
#public void Register_MatrixParam(string name, string nickname, string description, GH_ParamAccess access)
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, you should set this field if you intend to output lists here. |
Register_MatrixParam
#Register a new matrix parameter
Register_MeshFaceParam
#public void Register_MeshFaceParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D Mesh face 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, you should set this field if you intend to output lists here. |
Register_MeshFaceParam
#Register a new 3D Mesh face parameter
Register_MeshParam
#public void Register_MeshParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D Mesh 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, you should set this field if you intend to output lists here. |
Register_MeshParam
#Register a new 3D Mesh parameter
Register_PathParam
#public void Register_PathParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new Data Structure path 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, you should set this field if you intend to output lists here. |
Register_PathParam
#Register a new Data Structure path parameter
Register_PlaneParam
#public void Register_PlaneParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D plane 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, you should set this field if you intend to output lists here. |
Register_PlaneParam
#Register a new 3D plane parameter
Register_PointParam
#public void Register_PointParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D point 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, you should set this field if you intend to output lists here. |
Register_PointParam
#Register a new 3D point parameter
Register_RectangleParam
#public void Register_RectangleParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D rectangle 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, you should set this field if you intend to output lists here. |
Register_RectangleParam
#Register a new 3D rectangle parameter
Register_StringParam
#public void Register_StringParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new String primitive 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, you should set this field if you intend to output lists here. |
Register_StringParam
#Register a new String primitive parameter
Register_SurfaceParam
#public void Register_SurfaceParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D surface 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, you should set this field if you intend to output lists here. |
Register_SurfaceParam
#Register a new 3D surface parameter
Register_TransformParam
#public void Register_TransformParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new Transform 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, you should set this field if you intend to output lists here. |
Register_TransformParam
#Register a new Transform parameter
Register_VectorParam
#public void Register_VectorParam(string name, string nickname, string description, GH_ParamAccess access)
Register a new 3D vector 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, you should set this field if you intend to output lists here. |
Register_VectorParam
#Register a new 3D vector parameter
RegisterParam
#Generic parameter registration. This class provides methods to register standard parameters, but if you have a special type you're in charge of setting it all up yourself.
Parameters:
| param (IGH_Param) | The parameter to add. |
| access (GH_ParamAccess) | Parameter access, you should set this field if you intend to output lists here. |
RegisterParam
#public void RegisterParam(IGH_Param param, string name, string nickname, string description, GH_ParamAccess access)
Generic parameter registration. This class provides methods to register standard parameters, but if you have a special type you're in charge of setting it all up yourself.
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. |
| access (GH_ParamAccess) | Parameter access, you should set this field if you intend to output lists here. |
RegisterParam
#Generic parameter registration. This class provides methods to register standard parameters, but if you have a special type you're in charge of setting it all up yourself.