denigma 4.0.0
Loading...
Searching...
No Matches
denigma::classify::smartshape::LineCap Struct Reference

Describes the cap (hook or arrowhead) at one end of a line-type smart shape. More...

#include <general_lines.h>

Public Types

enum class  Type { None , Hook , ArrowheadPreset , ArrowheadCustom }
 The kind of cap at this end of the line. More...
 

Public Attributes

Type type {}
 The cap type.
 
musx::dom::Efix hookLength {}
 Signed hook length: positive extends up.
 
std::optional< musx::dom::ArrowheadPreset > preset
 The preset arrowhead, when the preset id is valid. (Only for Type::ArrowheadPreset.)
 
musx::dom::MusxInstance< musx::dom::others::ShapeDef > customArrowhead
 The arrowhead shape, when resolvable. (Only for Type::ArrowheadCustom.)
 
musx::dom::KnownShapeDefType customArrowheadType { musx::dom::KnownShapeDefType::Unrecognized }
 Recognized type of customArrowhead. (Only for Type::ArrowheadCustom.)
 

Detailed Description

Describes the cap (hook or arrowhead) at one end of a line-type smart shape.

Member Enumeration Documentation

◆ Type

The kind of cap at this end of the line.

Enumerator
None 

No cap.

Hook 

A perpendicular hook. (See hookLength.)

ArrowheadPreset 

One of Finale's preset arrowheads. (See preset.)

ArrowheadCustom 

A Shape Designer arrowhead. (See customArrowhead and customArrowheadType.)

Member Data Documentation

◆ hookLength

musx::dom::Efix denigma::classify::smartshape::LineCap::hookLength {}

Signed hook length: positive extends up.

(Only for Type::Hook.) Built-in line shape types encode direction in the type and length in musx::dom::options::SmartShapeOptions::hookLength; both are normalized into this value.


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