figureone
    Preparing search index...

    Class default

    FigureElementCollection representing a line.

    This object defines a convient and powerful line FigureElementCollection that includes a solid or dashed line, arrows, a label annotation that can self align with line orientation, and some methods to make it convient to use dynamically.

    See COL_Line for the options that can be used when creating the line.

    The object contains a two additional animation steps. length animates changing the line length, and pulseWidth animates the pulseWidth method. The animation steps are available in the animation manager (FigureElement.animations), and in the animation builder (animations.new and animations.builder).

    Some of the useful methods included in an collections line are:

    • pulseWidth - pulses the line without changing its length
    • grow - starts and animation that executes a single length animation step
    • grow - overrides FigureElement.setMovable and allowing for more complex move options.

    See OBJ_LengthAnimationStep for angle animation step options.

    See OBJ_PulseWidthAnimationStep for pulse angle animation step options.

    To test examples below, append them to the boilerplate.

    // Pulse an annotated line
    figure.add({
      name: 'l',
      make: 'collections.line',
      p1: [-1, 0],
      p2: [1, 0],
      arrow: 'triangle',
      label: {
        text: 'length',
        offset: 0.04,
      },
    });

    figure.elements._l.pulseWidth({ duration: 2 });

    // Animate growing a line while showing it's length
    figure.add({
      name: 'l',
      make: 'collections.line',
      p1: [-1, 0],
      p2: [-0.5, 0],
      align: 'start',
      arrow: { end: { head: 'barb', scale: 2 } },
      label: {
        text: null,
        offset: 0.03,
        precision: 2,
        location: 'start'
      },
    });

    const l = figure.elements._l;
    l.animations.new()
      .length({ start: 0.5, target: 2, duration: 2 })
      .start();

    // Example showing dashed line with an equation label that stays horizontal
    const l = figure.collections.line({
      p1: [0, 0],
      p2: [1.4, 0],
      align: 'start',
      label: {
        text: {                             // label text is an equation
          elements: {
            twopi: '2\u03C0',
          },
          forms: {
            base: ['twopi', ' ', { frac: ['a', 'vinculum', 'b'] } ]
          },
        },
        offset: 0.03,
        orientation: 'horizontal',          // keep label horizontal
        location: 'top',                    // keep label on top of line
      },
      dash: [0.08, 0.02, 0.02, 0.02],
    });
    figure.add('l', l);
    l.setMovable({ type: 'centerTranslateEndRotation'})
    l.setAutoUpdate();

    Hierarchy (View Summary)

    Index

    Methods

    setScene setPosition setRotation setScale setTransform setScenario saveScenario getPath transformPoint spaceTransformMatrix getScale getRotation getPosition setFigurePosition setPositionToElement setTouchable setMovable toggleShow getTransform isMoving toFront toBack add pulse getElement getElements get show hide getBorder setColor setDimColor undim dim getAllPrimitives getAllElements recreateAtlases getChildren isAnimating transformToLine pulseWidth setMove updateMoveTransform setAutoUpdate getLength getAngle setLabel getLabel setLabelToRealLength updateLabel setLength setEndPoints grow getLine getP1 getP2

    Methods

    • Conveniently set the first scale of the element's transform.

      Parameters

      • scaleOrX: number | TypeParsablePoint

        horizontal scale - either define as full x-y point, or as a number. If scaleOrX is a number and y is null, then both x and y will be equally scaled

      • y: number | null = null

        y coordinate if scaleOrX is a number (null)

      • z: number = 1

      Returns void

    • Transform a point between 'draw', 'local', 'figure', 'gl' and 'pixel' spaces.

      plane is only needed when converting from pixel space (a 2D space) to 'figure', 'local' or 'draw' spaces (a 3D space). A ray from the pixel is drawn into the screen and the intersection with the defined plane is returned.

      'pixel' to 'gl' is also a 2D to 3D transformation, but in this case the XY plane at z = 0 is used in gl space.

      Parameters

      • point: TypeParsablePoint
      • fromSpace: "figure" | "pixel" | "gl" | "local" | "draw"

        space to convert point from

      • toSpace: "figure" | "pixel" | "gl" | "local" | "draw"

        space to convert point to

      • toSpacePlane: TypeParsablePlane = ...

      Returns Point

    • Return the first rotation in the element's transform.

      Parameters

      • normalize: "" | "0to360" | "-180to180" = ''

        how to normalize the returned angle where '' returns the raw angle

      Returns number

      scale

    • Get position of element

      By default the first translation of the element's transform is returned. This is effectively the element's location in 'local' coordinates.

      The position of the element relative to its horizontal and vertical bounds can also be returned. Use xAlign to find the x coordinate of the left, center, right or percentage width from left of the element. Use yAlign to find the bottom, middle, top or percentage height from bottom of the element.

      Parameters

      • space: TypeCoordinateSpace = 'local'

        the space to return the position in

      • xAlign: number | "left" | "right" | "center" | "location" = 'location'

        horizontal alignment of position. Use a number to define the horizontal position in percentage width from the left.

      • yAlign: number | "top" | "bottom" | "middle" | "location" = 'location'

        vertical alignment of position. Use a number to define the vertical position in percentage height from the bottom.

      Returns Point

    • Add a figure element to this collection.

      If adding an array of elements, then the added elements will be returned in an array (even if only one element is added). If not adding an array, then that single element will be returned.

      Parameters

      Returns any

      added element, or array of added elements

      // Add name and element
      const collection = figure.add({ make: 'collection' });
      const element = figure.primitives.polygon({ radius: 1 });
      collection.add('name', element);

      // Element only (name will be autogenerated)
      const collection = figure.add({ make: 'collection' });
      const element = figure.primitives.polygon({ radius: 1 });
      collection.add(element);

      // Element definition (if no name is provided, then name will
      // be auto generated)
      const collection = figure.add({ make: 'collection' });
      collection.add({
        make: 'polygon',
        radius: 1,
      });

      // Array of elements
      const collection = figure.add({ make: 'collection' });
      const polygon1 = figure.primitives.polygon({ radius: 1 });
      collection.add([
        polygon1,
        {
          make: 'polygon',
          radius: 0.2,
          color: [0, 0, 1, 1],
        },
      ]);

    • Pulse element.

      An element can be pulsed in scale, a rotation or a translation.

      The scale pulse can either be a single pulse, or a number of copies with a range of scales - which has the effect of making regular polygons thick.

      Either pass in a callback, or an options object defining the pulse and callback.

      Parameters

      • optionsOrElementsOrDone:
            | (string | FigureElement)[]
            | OBJ_Pulse & { elements?: (string | FigureElement)[] }
            | ((arg: any) => void)
            | null
            | undefined = null
      • done: ((arg: any) => void) | null | undefined = null

      Returns void

    • Get element from an element path with '.' separators.

      For instance, if a collection has a child collection 'a', which has a child primitive 'b', then the path would be: 'a.b'.

      Parameters

      Returns any

      element at path. If elementPath is null, then this element is returned. If elementPath is invalid then null is returned.

      element.getElement

      // Get all the elements from a figure
      figure.add(
        {
          name: 'c',
          make: 'collection',
          elements: [
            {
              name: 'tri',
              make: 'triangle',
              height: 0.4,
              width: 0.4,
            },
            {
              name: 'text',
              make: 'text',
              text: 'triangle',
              position: [0, -0.4],
              xAlign: 'center',
            },
          ],
        },
      );

      const c = figure.getElement('c');
      // Elements within collections can be found with dot notation
      const tri = figure.getElement('c.tri');
      // Or the collection can be queried directly
      const text = c.getElement('text');

    • Get the border or touchBorder of a FigureElementCollection in a defined coordinate space.

      Parameters

      • space: Type3DMatrix | TypeCoordinateSpace = 'local'

        ('local)

      • border: "border" | "touchBorder" = 'border'

        ('border')

      • children: (string | FigureElement)[] | null | undefined = null

        choose specific children only - use null for all children (null)

      • shownOnly: boolean = true

        if true then only children that are shown will be used (true)

      Returns any[]

    • A line has:

      • length
      • p1, p2
      • angle
      • position
      • reference alignment

      Two ways to define a line:

      • p1, p2
      • position, align, length, angle

      Line is defined by:

      • primitive line: full length, angle = 0, aligned in draw space with align
      • transform.translate: moves align position
      • transform.rotate: changes angle

      Returns void

    • Turn on and off auto label location and orientation updates when line transform changes. When a line is created with a label, auto update is turned off by default.

      Parameters

      • update: boolean = true

      Returns void

    • Set the length of the line

      Parameters

      • length: number
      • align: number | "start" | "end" | "center" = ...

      Returns void

    • Change the line position, length and angle using end points and an offset.

      For most lines, an offset of 0 will be desired, as this will position the line ends to be at p1 and p2.

      A non-positive offset will position the line in parallel with p1 and p2 but some offset away. A positive offset will position the line on the side it will rotate toward with positive rotation.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods