Namespace: PathBuilding
PathBuilding
Classes
Namespaces
Type Definitions
Calculator(previous, current, next) → {PathPoint}
A delegate that calculates the properties of a single path point based on three sequential points from the pointer input
Parameters:
| Name | Type | Description |
|---|---|---|
previous | PathBuilding.PointerData | |
current | PathBuilding.PointerData | |
next | PathBuilding.PointerData | prediction pointer data |
Returns:
path point that will be processed from pipeline
Type
PathPoint
InkBuilderSettings
InkBuilder settings
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
brush | Rendering.Brush | Defines spacing (between two successive samples) and vector inking shape, required for ink builder initialization | ||
layout | Array.<PathBuilding.PathPoint.Property> | The path point layout object that specifies the available properties of a path point. Required for runtime build. | ||
pathPointProps | PathBuilding.PathPointProperties | Static values used when the layout does not include variable ones | ||
pathPointCalculator | PathBuilding.Calculator | Lambda function calculates the path point properties based on pointer input. Required for runtime build. | ||
lastPipelineStage | PathBuilding.Pipeline.Stage | Where pipeline chain ends. Default depends from brush instance. | ||
| Brush2D instance with spacing <= 1 ends with POLYGON_MERGER Brush2D instance with spacing > 1 ends with BRUSH_APPLIER BrushGL instance ends with SPLINE_INTERPOLATOR | ||||
keepAllData | Array.<PathBuilding.Pipeline.Stage> | Provides pipeline result from particular stages | ||
concatSegments | boolean | <optional> | false | This property is applicable for runtime strokes only, built with pipeline where lastPipelineStage is POLYGON_MERGER. When is true completed ink path segments will be merged. |
concatPredictionSegments | boolean | <optional> | false | This property is applicable for runtime strokes only, built with pipeline where lastPipelineStage is POLYGON_MERGER. When is true prediction segments will be merged. |
movingAverageWindowSize | int | <optional> | 15 | Window size of the smoothing filter |
errorThreshold | float | <optional> | 0.15 | Threshold value that determines the allowed difference between the actual and the interpolated curve. Applicable only for vector brushes. |
keepSplineParameters | boolean | <optional> | false | Interpolated spline contains SplineParameter for every sampled point |
PathPointProperties
Pipeline properties which not varies
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
red | byte | <optional> | Red color value | |
green | byte | <optional> | Green color value | |
blue | byte | <optional> | Blue color value | |
alpha | float | <optional> | Alpha color value | |
size | float | <optional> | Size value associated with the path point | |
rotation | float | <optional> | Rotation value associated with the path point | |
scaleX | float | <optional> | 1 | X dimension scale value associated with the path point |
scaleY | float | <optional> | 1 | Y dimension scale value associated with the path point |
scaleZ | float | <optional> | 1 | Z dimension scale value associated with the path point |
offsetX | float | <optional> | 0 | X dimension offset value associated with the path point |
offsetY | float | <optional> | 0 | Y dimension offset value associated with the path point |
offsetZ | float | <optional> | 0 | Z dimension offset value associated with the path point |
PathPointSettings
Pipeline properties which varies
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
red | PathBuilding.PathPoint.PropertySettings | <optional> | Red color channel configuration |
green | PathBuilding.PathPoint.PropertySettings | <optional> | Green color channel configuration |
blue | PathBuilding.PathPoint.PropertySettings | <optional> | Blue color channel configuration |
alpha | PathBuilding.PathPoint.PropertySettings | <optional> | Alpha color channel configuration |
size | PathBuilding.PathPoint.PropertySettings | <optional> | Size channel configuration |
rotation | PathBuilding.PathPoint.PropertySettings | <optional> | Rotation channel configuration |
scaleX | PathBuilding.PathPoint.PropertySettings | <optional> | X dimension scale channel configuration |
scaleY | PathBuilding.PathPoint.PropertySettings | <optional> | Y dimension scale channel configuration |
scaleZ | PathBuilding.PathPoint.PropertySettings | <optional> | Z dimension scale channel configuration |
offsetX | PathBuilding.PathPoint.PropertySettings | <optional> | X dimension offset channel configuration |
offsetY | PathBuilding.PathPoint.PropertySettings | <optional> | Y dimension offset channel configuration |
offsetZ | PathBuilding.PathPoint.PropertySettings | <optional> | Z dimension offset channel configuration |
PathSegment
Path segment
Properties:
| Name | Type | Description |
|---|---|---|
phase | PathBuilding.Pipeline.Phase | On which phase segment is produced |
pipeline | PathBuilding.PipelineData | Runtime pipeline data |
added | PathBuilding.InterpolatedSpline|PathBuilding.InkPath2D | Processed segment |
predicted | PathBuilding.InterpolatedSpline|PathBuilding.InkPath2D | Temproary prediction segment |
PointerDataDelta
Delta distance (vector) and time between 2 points
Properties:
| Name | Type | Description |
|---|---|---|
x | float | Distance by x |
y | float | Distance by y |
length | float | Vector length (magnitude) |
time | int | Time difference |
PropertyCalculator(previous, current, next) → {PathPoint}
A delegate that calculates the value of a single path point property based on three sequential points from the pointer input
Parameters:
| Name | Type | Description |
|---|---|---|
previous | PathBuilding.PointerData | |
current | PathBuilding.PointerData | |
next | PathBuilding.PointerData | prediction pointer data |
Returns:
path point that will be processed from pipeline
Type
PathPoint
Range
Defines min-max range and value transformer
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
min | float | ||
max | float | ||
remap | PathBuilding.ValueTransformer | <optional> | A lambda that that defines a custom transformation on the normalized value in current range |
ValueTransformer(k) → {float}
Defines a custom transformation on the normalized value
Parameters:
| Name | Type | Description |
|---|---|---|
k | float | normalized value |
Returns:
transformed value
Type
float