SCIFreehandDrawingAnnotation Class Reference


                        
                        
                        stroke

Defines the stroke style for this brush annotation.

Declaration

Objective-C

@property (nonatomic, strong, nonnull) SCIPenStyle *stroke;

Swift

var stroke: SCIPenStyle { get set }


                        
                        
                        drawId

A unique identifier for this brush annotation.

Declaration

Objective-C

@property (nonatomic, strong, nonnull) NSString *drawId;

Swift

var drawId: String { get set }


                        
                        
                        selectionOffset

Extra padding applied around the selection rectangle.

Declaration

Objective-C

@property (nonatomic) CGFloat selectionOffset;

Swift

var selectionOffset: CGFloat { get set }


                        
                        
                        -getBaseDataValues

Returns the collection of base data values.

Declaration

Objective-C

- (nonnull NSArray<SCIComparablePoint *> *)getBaseDataValues;

Swift

func getBaseDataValues() -> [SCIComparablePoint]

Return Value

An array of SCIComparablePoint objects representing the base data values.


                        
                        
                        -getBasePoints

Returns the collection of screen-space points which represent the current freehand path drawn by the modifier.

The points are returned as SCIComparablePoint objects, with their x and y values converted using the current axis coordinate calculators. If the modifier is not attached to a surface or the calculators are unavailable, the method returns either NaN points (to preserve count) or an empty array.

Declaration

Objective-C

- (nonnull NSArray<SCIComparablePoint *> *)getBasePoints;

Swift

func getBasePoints() -> [SCIComparablePoint]

Return Value

An array of SCIComparablePoint objects representing the freehand path in screen coordinates.


                        
                        
                        -appendPointWithX:y:

Appends a new point to the brush path.

Call this repeatedly while the user is drawing to build the full stroke.

Declaration

Objective-C

- (void)appendPointWithX:(nonnull id<ISCIComparable>)x
                       y:(nonnull id<ISCIComparable>)y;

Swift

func appendPointWith(x: any ISCIComparable, y: any ISCIComparable)

Parameters

`x`	The x‑coordinate in data space (must conform to ISCIComparable).
`y`	The y‑coordinate in data space (must conform to ISCIComparable).


                        
                        
                        -clearPoints

Clears all points from the brush path, effectively resetting the annotation. After calling this, the annotation will no longer render until new points are added.

Declaration

Objective-C

- (void)clearPoints;

Swift

func clearPoints()