Module org.tquadrat.foundation.svg
Package org.tquadrat.foundation.svg

Interface SVGPath

All Superinterfaces:
AllowsConditionalProcessingAttributes, AllowsGlobalEventAttributes, AllowsGraphicalEventAttributes, AllowsPresentationAttributes, AllowsStyleAttributes, Element, SVGElement, SVGElementWithChildren
All Known Implementing Classes:
SVGElementAdapter, SVGGenericElement, SVGPathImpl
@ClassVersion(sourceVersion="$Id: SVGPath.java 1074 2023-10-02 12:05:06Z tquadrat $") @API(status=STABLE, since="0.0.5") public sealed interface SVGPath extends SVGElementWithChildren, AllowsConditionalProcessingAttributes, AllowsGlobalEventAttributes, AllowsGraphicalEventAttributes, AllowsPresentationAttributes, AllowsStyleAttributes permits SVGElementAdapter, SVGPathImpl
The definition of the SVG <path> element.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: SVGPath.java 1074 2023-10-02 12:05:06Z tquadrat $
Since:
0.0.5
UML Diagram
UML Diagram for "org.tquadrat.foundation.svg.SVGPath"⁠

UML Diagram for "org.tquadrat.foundation.svg.SVGPath"

UML Diagram for "org.tquadrat.foundation.svg.SVGPath"⁠

  • Method Details

    • setPathDefinition

      void setPathDefinition(SVGPathElement... pathElements)
      Sets the path definition for this SVG <path> element.
      Parameters:
      pathElements - The elements of the path.

    • setPathLength

      void setPathLength(SVGNumber.SVGUserUnitValue length)
      Sets the length of the path represented by this SVG <path> element.
      Parameters:
      length - The author's computation of the total length of the path, in user units. This type is used to calibrate the user agent's own distance-along-a-path calculations with that of the author. The user agent will scale all distance-along-a-path computations by the ratio of this type to the user agent's own computed type for total path length.

      A type of zero is valid, but a negative type is an error.
      Throws:
      IllegalArgumentException - The type is less than 0.

    • setPathLength

      default void setPathLength(double length)
      Sets the length of the path represented by this SVG <path> element.
      Parameters:
      length - The author's computation of the total length of the path, in user units. This type is used to calibrate the user agent's own distance-along-a-path calculations with that of the author. The user agent will scale all distance-along-a-path computations by the ratio of this type to the user agent's own computed type for total path length.

      A type of zero is valid, but a negative type is an error.
      Throws:
      IllegalArgumentException - The type is less than 0.

    • setPathLength

      default void setPathLength(long length)
      Sets the length of the path represented by this SVG <path> element.
      Parameters:
      length - The author's computation of the total length of the path, in user units. This type is used to calibrate the user agent's own distance-along-a-path calculations with that of the author. The user agent will scale all distance-along-a-path computations by the ratio of this type to the user agent's own computed type for total path length.

      A type of zero is valid, but a negative type is an error.
      Throws:
      IllegalArgumentException - The type is less than 0.