Class PoLabelField

  • All Implemented Interfaces:
    SafeDisposable

    public class PoLabelField
    extends PoGraphMaster
    Class to build a label field. Class to build a label field in the plane XY. This class represents a set of 2D points annotated by a string and a value.

    All numerical values (if there are visible) depend on the current numerical display format. If the method setFormat(format) is called, the current numeric display format is "format". Otherwise the current numeric display format is specified in the current inherited state (cf property node PoNumericDisplayFormat).

    File format/default:

    PoLabelField {

      point 0 0
      string ""
      value 0
      concatType STRING_BEFORE_VALUE
      fontSize 1
      justification LEFT
      verticalJustification BASE
      coordinateType COORDINATE_IN_CURRENT_UNIT
    }

    <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> <link REL="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> <title></title> </head> <BODY> <h1></h1> <h4> <A NAME="Heading355">CATALOG PARTS</A></h4> <ul><b>PoLabelField</b> {</ul> <ul><ul><b>Separator</b> <tt>alternateRep</tt> (from PoBase) {<br> </ul></ul> <ul><ul><ul><b>AppearanceKit</b> <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR and drawStyle.style=LINES. </i><br> <i>font.size is set to the field fontSize.</i></ul></ul></ul> <ul><ul><ul><b>MatrixTransform</b> <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the domain transformation.</i></ul></ul></ul> <ul><ul><ul><ul></ul></ul></ul></ul> <ul><ul><ul><b>Group</b> <tt>labelField</tt></ul></ul></ul> <ul><ul><ul><i>Contains a list of SoAnnoText3 shapes.</i></ul></ul></ul> <ul><ul>}</ul></ul> <ul>}<br> </ul> </body> </html>

    • Field Detail

      • point

        public final SoMFVec2f point
        List of points which are the coordinates of the strings.
      • string

        public final SoMFString string
        List of strings to display. To be displayed, the number of strings must be equal to the number of points of point.
      • value

        public final SoMFFloat value
        List of values to display. The values are converted into strings according to the current numerical display format. To be displayed, the number of values must be equal to the number of points of point.
      • fontSize

        public final SoSFFloat fontSize
        Font size for strings to display.
      • coordinateType

        public final SoSFEnum<PoLabelField.CoordinateTypes> coordinateType
        Type of coordinates.
        • coordinateType = COORDINATE_IN_DOMAIN: coordinates are expressed in the current domain (cf PoBase description),
        • coordinateType = COORDINATE_IN_CURRENT_UNIT: coordinates are expressed in the current unit.
    • Constructor Detail

      • PoLabelField

        public PoLabelField​(SbVec2f[] _point,
                            java.lang.String[] _string,
                            float[] _value,
                            float _fontSize,
                            PoLabelField.ConcatTypes type)
        Calls PoLabelField(_point, _string, _value, _fontSize, type, PoLabelField.Justifications.valueOf( PoLabelField.Justifications.LEFT.getValue() ), PoLabelField.VerticalJustifications.valueOf( PoLabelField.VerticalJustifications.BASE.getValue() )).
      • PoLabelField

        public PoLabelField​(SbVec2f[] _point,
                            java.lang.String[] _string,
                            float[] _value,
                            float _fontSize)
        Calls PoLabelField(_point, _string, _value, _fontSize, PoLabelField.ConcatTypes.valueOf( PoLabelField.ConcatTypes.STRING_BEFORE_VALUE.getValue() ), PoLabelField.Justifications.valueOf( PoLabelField.Justifications.LEFT.getValue() ), PoLabelField.VerticalJustifications.valueOf( PoLabelField.VerticalJustifications.BASE.getValue() )).
      • PoLabelField

        public PoLabelField​(SbVec2f[] _point,
                            java.lang.String[] _string,
                            float[] _value,
                            float _fontSize,
                            PoLabelField.ConcatTypes type,
                            PoLabelField.Justifications _justification)
        Calls PoLabelField(_point, _string, _value, _fontSize, type, _justification, PoLabelField.VerticalJustifications.valueOf( PoLabelField.VerticalJustifications.BASE.getValue() )).
      • PoLabelField

        public PoLabelField()
        Default constructor.