LibreOffice
LibreOffice 6.4 SDK API Reference
Public Types | Public Attributes | List of all members
StrokeAttributes Struct Reference

This structure contains all attributes required for path stroking. More...

import"StrokeAttributes.idl";

Public Types

typedef sequence< double > DashArray
 Array of ink on and off lengths, measured in user coordinate space. More...
 
typedef sequence< double > LineArray
 Array of line widths and spacings for multiple-line strokes. More...
 

Public Attributes

double StrokeWidth
 Defines the width of the stroke, measured in user coordinate space. More...
 
double MiterLimit
 Determines the maximal length of the diagonal in mitered corners. More...
 
byte StartCapType
 The start shape of the stroke. More...
 
byte EndCapType
 The end shape of the stroke. More...
 
byte JoinType
 The join shape of the stroke. More...
 

Detailed Description

This structure contains all attributes required for path stroking.

Path stroking is the process of drawing a polygon with a thick pen. The various attributes contained in this structure can be used to customize that process.

Member Typedef Documentation

◆ DashArray

sequence<double> DashArray

Array of ink on and off lengths, measured in user coordinate space.

The first element specifies the length of the first "on" segment of the dashing, the second element the length of the first "off" segment, and so forth. Give zero elements here for solid strokes. This array always have an even number of elements, with zero, as usual, counting as even here. Furthermore, each entry in this array must have a value that is positive (or 0.0)

◆ LineArray

sequence<double> LineArray

Array of line widths and spacings for multiple-line strokes.

The entries here are relative to the StrokeAttributes::StrokeWidth attribute above, i.e. the total width of all lines and spacings will always equal StrokeAttributes::StrokeWidth. The first element specifies the width of the rightmost line, when traveling from the start point of the path to the end point. The second element specifies the space between the first line and the second line, and so forth. If the array ends with a spacing, this spacing is included in the total width of the multiple-line stroke. That is, the stroke becomes asymmetric.

Member Data Documentation

◆ EndCapType

byte EndCapType

The end shape of the stroke.

The end point is the last point of every polygon of the path poly-polygon.

See also
PathCapType

◆ JoinType

byte JoinType

The join shape of the stroke.

After every sub-stroke, i.e. after every line or curve segment within a single path polygon, a shape of this type is inserted into the stroke to glue the segments together. Please note that distinct polygons within the path poly-polygon are not connected, and therefore also not joined via the shape specified here.

See also
PathJoinType

◆ MiterLimit

double MiterLimit

Determines the maximal length of the diagonal in mitered corners.

This attribute is only used when StrokeAttributes::JoinType is set to PathJoinType::MITER. Should the length of a corner's diagonal exceed this limit, a beveled join is used instead. This value must be positive (or 0.0, which is equivalent to setting StrokeAttributes::JoinType to PathJoinType::BEVEL.

Before performing the actual comparison, implementations will multiply the MiterLimit with the current StrokeWidth, such that, with phi being the angle between the two joining segments, MiterLimit=1/sin(phi/2.0).

◆ StartCapType

byte StartCapType

The start shape of the stroke.

The start point is the first point of every polygon of the path poly-polygon.

See also
PathCapType

◆ StrokeWidth

double StrokeWidth

Defines the width of the stroke, measured in user coordinate space.

This value must be positive (or 0.0)


The documentation for this struct was generated from the following file: