Package org.scilab.forge.scirenderer.ruler

Interface RulerModel

  • All Known Implementing Classes:
    DefaultRulerModel
    public interface RulerModel
    Author:
    Pierre Lando

    • Field Detail

      • DEFAULT_FIRST_VALUE

        static final double DEFAULT_FIRST_VALUE
        Default first value.
        See Also:
        Constant Field Values

      • DEFAULT_SECOND_VALUE

        static final double DEFAULT_SECOND_VALUE
        Default second value.
        See Also:
        Constant Field Values

      • DEFAULT_FIRST_POINT

        static final Vector3d DEFAULT_FIRST_POINT
        Default first point position.

      • DEFAULT_SECOND_POINT

        static final Vector3d DEFAULT_SECOND_POINT
        Default second point position.

      • DEFAULT_MARGIN

        static final double DEFAULT_MARGIN
        Default margin in pixel.
        See Also:
        Constant Field Values

      • DEFAULT_LINE_VISIBLE

        static final boolean DEFAULT_LINE_VISIBLE
        Default main line visibility.
        See Also:
        Constant Field Values

      • DEFAULT_SPRITE_DISTANCE

        static final int DEFAULT_SPRITE_DISTANCE
        Default org.scilab.forge.scirenderer.sprite.Sprite distance to the main line in pixel.
        See Also:
        Constant Field Values

      • DEFAULT_SUB_TICK_LENGTH

        static final int DEFAULT_SUB_TICK_LENGTH
        Default sub-tick length in pixel.
        See Also:
        Constant Field Values

      • DEFAULT_TICK_LENGTH

        static final int DEFAULT_TICK_LENGTH
        Default tick length in pixel.
        See Also:
        Constant Field Values

      • DEFAULT_MINIMAL_SUB_TICKS_DISTANCE

        static final double DEFAULT_MINIMAL_SUB_TICKS_DISTANCE
        Default minimal sub-ticks distance.
        See Also:
        Constant Field Values

      • DEFAULT_AUTO_TICKS_STATUS

        static final boolean DEFAULT_AUTO_TICKS_STATUS
        Default auto-ticks status.
        See Also:
        Constant Field Values

      • DEFAULT_LOGARITHMIC_STATUS

        static final boolean DEFAULT_LOGARITHMIC_STATUS
        Default logarithmic status.
        See Also:
        Constant Field Values

      • DEFAULT_TICKS_DIRECTION

        static final Vector3d DEFAULT_TICKS_DIRECTION
        Default ticks direction.

      • DEFAULT_COLOR

        static final Color DEFAULT_COLOR
        Default color.

      • DEFAULT_LINE_WIDTH

        static final double DEFAULT_LINE_WIDTH
        Default line width.
        See Also:
        Constant Field Values

    • Method Detail

      • getGraduations

        Graduations getGraduations()
        Return used graduation to draw this ruler.
        Returns:
        the used graduation to draw this ruler.

      • getFirstValue

        double getFirstValue()
        First value getter.
        Returns:
        the first values.

      • getSecondValue

        double getSecondValue()
        Second value getter.
        Returns:
        the second values.

      • getFirstPoint

        Vector3d getFirstPoint()
        First point getter.
        Returns:
        the first point.

      • getSecondPoint

        Vector3d getSecondPoint()
        Second point getter.
        Returns:
        the second point.

      • getTicksDirection

        Vector3d getTicksDirection()
        Ticks direction getter.
        Returns:
        the ticks direction.

      • getTicksLength

        int getTicksLength()
        Ticks length getter.
        Returns:
        the ticks length in pixel.

      • getSubTicksLength

        int getSubTicksLength()
        Sub-ticks length getter.
        Returns:
        the sub-ticks length in pixel.

      • getPosition

        Vector3d getPosition​(double value)
        Return the position corresponding to the given value.
        Parameters:
        value - the given value.
        Returns:
        the position corresponding to the given value.

      • getMargin

        double getMargin()
        Return the accepted margin (in pixel) for label drawing.
        Returns:
        the accepted margin (in pixel) for label drawing.

      • isLineVisible

        boolean isLineVisible()
        Line visibility getter.
        Returns:
        the line visibility status.

      • isAutoTicks

        boolean isAutoTicks()
        Auto-ticking getter.
        Returns:
        the auto-ticking status.

      • isLogarithmic

        boolean isLogarithmic()
        Logarithmic state getter.
        Returns:
        the logarithmic state

      • getSpriteDistance

        int getSpriteDistance()
        Sprite distance getter.
        Returns:
        the sprite distance (in pixel) between the ruler line and the sprites edges.

      • getMinimalSubTicksDistance

        double getMinimalSubTicksDistance()
        Minimal accepted sub-ticks distance getter.
        Returns:
        the minimal accepted sub-ticks distance.

      • getColor

        Color getColor()
        Color getter.
        Returns:
        the color of ruler line and ticks.

      • getLineWidth

        double getLineWidth()
        Line width getter.
        Returns:
        the line width of ruler line, grid and ticks.

      • getSubticksNumber

        int getSubticksNumber()
        Number of subticks.
        Returns:
        the number of subticks or -1 if the computation is automatic.