InputAdder

References

public sealed class InputAdder

Utility class for adding component input parameters.

Constructors

InputAdder

public InputAdder(Component component)

Create a new adder.

Parameters:

component (Component)

Component associated with this adder.

Properties

Count

public int Count { get; }

Gets the number of parameters already registered.

Indexers

this[]

public IParameter this[int index] { get; }

Gets the parameter with the specified index.

Parameters:

index (int)

Index of parameter to retrieve.

Returns: Parameter at index.

Methods

Add

public void Add(IParameter parameter, Requirement requirement = Requirement.MustExist)

Add a constructed parameter to this component.

Parameters:

parameter (IParameter)	Parameter instance.
requirement (Requirement = Requirement.MustExist)	Parameter requirement.

AddAngle

public AngleParameter AddAngle(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add an angle parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddArc

public ArcParameter AddArc(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 3D arc parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddBoolean

public BooleanParameter AddBoolean(string name, string code, string info, (string name, string info) truePreset, (string name, string info) falsePreset, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a boolean parameter to this component with named presets for true and false.

Parameters:

name (string)
code (string)
info (string)
truePreset ((string name, string info))
falsePreset ((string name, string info))
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddBoolean

public BooleanParameter AddBoolean(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a boolean parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddBox

public BoxParameter AddBox(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a box parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddCage

public CageParameter AddCage(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a cage parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddCircle

public CircleParameter AddCircle(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 3D circle parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddColour

public ColourParameter AddColour(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add an sRGB Eto colour parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddComplex

public ComplexParameter AddComplex(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a complex number parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddContinuous

public ContinuousDistributionParameter AddContinuous(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a continuous distribution parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddCurve

public CurveParameter AddCurve(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a generic (i.e. object) curve parameter to this component whose values are all supposed to be curve-like. This parameter will store a variety of types (including Line, Arc, Polyline, NurbsCurve, PolyCurve, ...) without conversion. Use the CurveBroker class to operate on generic curve data.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddCurveLocus

public CurveLocusParameter AddCurveLocus(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a CurveLocusParameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddDateTime

public DateTimeParameter AddDateTime(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a Date/Time parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddDeform

public DeformParameter AddDeform(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a non-linear deformation parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddDiscrete

public DiscreteDistributionParameter AddDiscrete(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a discrete distribution parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddEnum<T>

public IntegerParameter AddEnum<T>(string name, string code, string info, T initial, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add an integer parameter with loaded presets from an enumeration to this component. The enum must derive from int and it's probably not a good idea to use a [Flags] enumeration.

Parameters:

name (string)
code (string)
info (string)
initial (T)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddField

public FieldParameter AddField(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 3D field parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddField

public FieldParameter AddField(string name, string code, string info, UiNumber hint, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 3D field parameter to this component. The hint provides the limits for the constant scalar slider, and also the default value.

Parameters:

name (string)
code (string)
info (string)
hint (UiNumber)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddFunction

public FunctionParameter AddFunction(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a function parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddGeneric

public GenericParameter AddGeneric(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a generic parameter which is not limited to any one data type.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddGradient

public GradientParameter AddGradient(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a colour gradient parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddGraph

public GraphParameter AddGraph(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a node-edge graph parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddIndex

public IntegerParameter AddIndex(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add an integer parameter to this component which represents a zero-based index.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddInteger

public IntegerParameter AddInteger(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add an integer parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddInteger

public IntegerParameter AddInteger(string name, string code, string info, UiInteger hint, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add an integer parameter to this component.

Parameters:

name (string)
code (string)
info (string)
hint (UiInteger)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddInterval

public IntervalParameter AddInterval(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add an interval parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddLanguage

public LanguageParameter AddLanguage(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

obsoleteNot actually obsolete, but consider adding Language Pin support to your component instead.

Add a language parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddLine

public LineParameter AddLine(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 3D line parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddMesh

public MeshParameter AddMesh(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a mesh parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddMeshFacet

public MeshFacetParameter AddMeshFacet(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a mesh face parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddMetaData

public MetaDataParameter AddMetaData(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a meta data parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddMetaName

public MetaNameParameter AddMetaName(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a meta data key parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddNPoint

public PointNParameter AddNPoint(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add an N-point parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddNumber

public NumberParameter AddNumber(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 64-bit floating-point parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddNumber

public NumberParameter AddNumber(string name, string code, string info, UiNumber hint, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 64-bit floating-point parameter to this component.

Parameters:

name (string)
code (string)
info (string)
hint (UiNumber)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddNumeric

public NumericParameter AddNumeric(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a generic numeric parameter to this component with no support for Angles, Complex number or BigIntegers.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddPath

public PathParameter AddPath(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a path parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddPlane

public PlaneParameter AddPlane(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 3D plane parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddPoint

public Point3Parameter AddPoint(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 3D point parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddPolyline

public PolylineParameter AddPolyline(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a polyline parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddRandom

public RandomParameter AddRandom(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a random engine parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddRandom

public RandomParameter AddRandom(string usage = null)

Add a random engine parameter with standard phrasing to this component. The name will be "Random" and the username will be "Rn".

Parameters:

usage (string = null)

Ending of the usage phrase.

Returns: The parameter which was added.

AddRectangle

public RectangleParameter AddRectangle(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 3D rectangle parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddRegion

public RegionParameter AddRegion(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 2D region parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddSite

public SiteParameter AddSite(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a site parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

Returns: The parameter which was added.

AddSphere

public SphereParameter AddSphere(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a sphere parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddSurface

public SurfaceParameter AddSurface(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a surface parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddSurfaceLocus

public SurfaceLocusParameter AddSurfaceLocus(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a AddSurfaceLocus(string, string, string, Access, Requirement) to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddText

public TextParameter AddText(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a text parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddTextPattern

public TextPatternParameter AddTextPattern(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a text-pattern parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddTimeSpan

public TimeSpanParameter AddTimeSpan(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a time span parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddTopological

public ConnectionParameter AddTopological(string name, string code, string info)

Add a topological connection parameter to this component. A connection parameter does not collect data fomr anywhere, instead it collects the instance IDs of its inputs. The IParameter.Access of a connection parameter is always Access.Tree, and the IParameter.Requirement is always Requirement.MayBeMissing.

Parameters:

name (string)
code (string)
info (string)

AddTransform

public TransformParameter AddTransform(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a linear transformation parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddTriangle

public TriangleParameter AddTriangle(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 3D triangle parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddTube

public TubeParameter AddTube(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a tube parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddTuple

public TupleParameter AddTuple(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a tuple parameter.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddUvPoint

public Point2Parameter AddUvPoint(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 2D point parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddVector

public VectorParameter AddVector(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a 3D vector parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)

AddView

public ViewParameter AddView(string name, string code, string info, Access access = Access.Item, Requirement requirement = Requirement.MustExist)

Add a view projection parameter to this component.

Parameters:

name (string)
code (string)
info (string)
access (Access = Access.Item)
requirement (Requirement = Requirement.MustExist)