Package geomss.geom

Class GenModelNote

    • Method Detail

      • immutable

        public abstract ModelNote immutable()
        Return an immutable version of this note.
        Returns:
        An immutable version of this note.

      • getXHat

        public abstract GeomVector<javax.measure.quantity.Dimensionless> getXHat()
        Return the vector indicating the horizontal axis direction for the text.
        Returns:
        The vector indicating the horizontal axis direction for the text.

      • getYHat

        public abstract GeomVector<javax.measure.quantity.Dimensionless> getYHat()
        Return the vector indicating the vertical axis direction (or ascent direction) for the text.
        Returns:
        The vector indicating the vertical axis direction (or ascent direction) for the text.

      • getNormal

        public Vector<javax.measure.quantity.Dimensionless> getNormal()
        Return the (at least 3D) vector indicating the normal axis direction for the text. When looking down the normal axis, you are looking at the text face-on.
        Returns:
        The (at least 3D) vector indicating the normal axis direction for the text.

      • getHeight

        public abstract Parameter<javax.measure.quantity.Length> getHeight()
        Return the height of the text box in model units.
        Returns:
        The height of the text box in model units.

      • getWidth

        public Parameter<javax.measure.quantity.Length> getWidth()
        Return the width of the text box in model units.
        Returns:
        The width of the text box in model units.

      • changeHeight

        public abstract GenModelNote changeHeight​(Parameter<javax.measure.quantity.Length> height)
        Return a new note object identical to this one, but with the specified height in model space.
        Parameters:
        height - The new height for the note in model space coordinates. May not be null.
        Returns:
        A new note object identical to this one, but with the specified height in model space.

      • size

        public int size()
        Returns the number of child-elements that make up this geometry element. This implementation always returns 1 as a GenModelNote is located at a single point in model space.
        Specified by:
        size in interface GeomElement<GenModelNote>
        Returns:
        The number of child-elements that make up this geometry element.

      • getBoundsMin

        public Point getBoundsMin()
        Return the coordinate point representing the minimum bounding box corner (e.g.: min X, min Y, min Z).
        Specified by:
        getBoundsMin in interface GeomElement<GenModelNote>
        Returns:
        The minimum bounding box coordinate for this geometry element.

      • getBoundsMax

        public Point getBoundsMax()
        Return the coordinate point representing the maximum bounding box corner (e.g.: max X, max Y, max Z).
        Specified by:
        getBoundsMax in interface GeomElement<GenModelNote>
        Returns:
        The maximum bounding box coordinate for this geometry element.

      • getLimitPoint

        public Point getLimitPoint​(int dim,
                           boolean max,
                           double tol)
        Returns the most extreme point, either minimum or maximum, in the specified coordinate direction on this geometry element.
        Specified by:
        getLimitPoint in interface GeomElement<GenModelNote>
        Parameters:
        dim - An index indicating the dimension to find the min/max point for (0=X,1=Y, 2=Z, etc).
        max - Set to true to return the maximum value, false to return the minimum.
        tol - Fractional tolerance to refine the min/max point position to if necessary.
        Returns:
        The point found on this element that is the min or max in the specified coordinate direction.
        See Also:
        getBoundsMin(), getBoundsMax()

      • getOrientation

        public DCMatrix getOrientation()
        Return a direction cosine matrix containing the orientation of the note string.
        Returns:
        A direction cosine matrix containing the orientation of the note string.

      • toText

        public javolution.text.Text toText()
        Returns the text representation of this geometry element that consists of the text string, the orienting plane and location, and the text box height. For example: 
           {aNote = {"A text string.",{1,0,0},{0,1,0},{10 ft, -3 ft, 4.56 ft},0.2 ft}}
        If there is no name, then the output looks like this: 
           {"A text string.",{0,0,1},{0,1,0},{10 ft, -3 ft, 4.56 ft},0.2 ft}
        Specified by:
        toText in interface GeomElement<GenModelNote>
        Overrides:
        toText in class AbstractNote<GenModelNote>
        Returns:
        the text representation of this geometry element.