IShapeFunction Interface |
[Missing <summary> documentation for "T:EwEUtils.Core.IShapeFunction"]
Namespace: EwEUtils.Core
Assembly: EwEUtils (in EwEUtils.dll) Version: 6.6.15981.0 (6.6.15981.0)
SyntaxThe IShapeFunction type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | IsDistribution |
Returns whether the shape function is a true distribution, with fixed
min and max values.
|
| nParameters |
Get the number of parameters needed to configure a shape function.
|
| ParamName |
Get the human legible name of a parameter of a shape function.
|
| ParamStatus |
Get the order a parameter needs to appear in the UI. Any UI should honour
this flag sorting parameters from low to high order.
|
| ParamUnit |
Get the human legible unit for a parameter of a shape function.
|
| ParamValue |
Get/set the value of a parameter of the shape function.
|
| ShapeFunctionType |
Return a (hopefully) unique identifier for a particular shape function,
regardless if this function is built-in to EwE or is provided by a plug-in.
|
Methods| Name | Description | |
|---|---|---|
 | Apply |
Update a shape from the shape function.
|
| Defaults |
Set a shape function parameters to their default values.
|
| Init |
Initialize to a given shape.
|
| IsCompatible |
Return whether a shape function is relevant for a given data type.
|
| Shape |
Returns the actual function data points, as computed from the parameters values.
|
See Also