TTS-Mimosa Docs
    Preparing search index...

    Class Prickles

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    are frequency length orientation persistance sources

    Methods

    addSource setLength setLengthMinMax

    Constructors

    Properties

    are: "absent" | "present" | "present or absent"

    Are prickles present (armed structure), absent (unarmed structure), or both (armed or unarmed)?

    If absent, the length should be null.

    frequency: "sparsely armed" | "serially armed" | "densely armed"

    Prickles frequency.

    length: { max?: number; min?: number; value?: number }

    Prickles length in milimeters (mm).

    It should be null when present is false.

    orientation:
        | "decurved"
        | "recurved"
        | "straight"
        | ("decurved" | "recurved" | "straight")[]

    Orientation of prickles.

    persistance: "persistent" | "caducous"

    Prickles persistance.

    sources: Source[]

    Source.

    Methods

    • Sets a single value for length.

      Parameters

      • value: number

        The length value in milimeters (mm).

      Returns void

      Error if present is false and value is not null.

    • Sets the length values, considering the value of present.

      Parameters

      • min: number

        The minimum length value in milimeters (mm).

      • max: number

        The maximum length value in milimeters (mm).

      Returns void

      Error if present is false and either min or max is not null.

      Error if min is greater than or equal to max.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods