raygeo.sketch.params
Named sketch parameters and expressions.
A parameter may be a number or a math expression. Expressions are resolved in multiple passes so
they can reference parameters defined later, and unresolved expressions are reported through
unresolved_errors(). The context serializes to the reference {'expressions': {...}} dictionary.
ParameterContext
evaluate()
evaluate(expression: Any) -> float
Evaluates an expression using the current parameters.
| Parameter | Type | Description |
|---|---|---|
expression | Any | |
| Returns | float |
evaluate_all()
evaluate_all(initial_values: Optional[dict] = None) -> None
Resolves every expression, optionally seeded with initial values.
| Parameter | Type | Description |
|---|---|---|
initial_values | Optional[dict] = None | |
| Returns | None |
from_dict()
from_dict(dict: dict) -> ParameterContext
Deserializes a context from the reference dictionary shape.
| Parameter | Type | Description |
|---|---|---|
dict | dict | |
| Returns | ParameterContext |
get()
get(name: str, default: float = 0.0) -> float
Returns the evaluated value of a parameter.
| Parameter | Type | Description |
|---|---|---|
name | str | |
default | float = 0.0 | |
| Returns | float |
get_all_values()
get_all_values() -> Any
Returns a copy of all evaluated parameter values.
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
invalidate()
invalidate() -> None
Clears cached values so the next access re-evaluates everything.
| Parameter | Type | Description |
|---|---|---|
| Returns | None |
set()
set(name: str, value: Any) -> None
Sets a parameter from a number or an expression string.
| Parameter | Type | Description |
|---|---|---|
name | str | |
value | Any | |
| Returns | None |
to_dict()
to_dict() -> dict
Serializes the context to the reference dictionary shape.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
unresolved_errors()
unresolved_errors() -> dict[str, str]
Expressions that remained unresolved during the last evaluation.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict[str, str] |