geometry.as_parameter
geometry.as_parameter(value, name=None)Convert a raw value to a Parameter object automatically.
If the value is already a Parameter, return it as-is. Otherwise, wrap it in the appropriate Parameter type with free=False.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| value | Union[float, Array, Scalar, Vector] | Value to convert | required |
| name | Optional[str] | Optional name for the parameter | None |
Returns
| Name | Type | Description |
|---|---|---|
| Union[Scalar, Vector] | Parameter object |
Examples
>>> as_parameter(1.5)
Scalar(value=1.5, free=False)>>> as_parameter([1, 2, 3])
Vector(value=[1, 2, 3], free=False)>>> existing = Scalar(value=2.0, free=True, name='radius')
>>> as_parameter(existing)
Scalar(value=2.0, free=True, name='radius') # unchanged