Package com.openinventor.meshviz.graph

Class PoLinearValueLegend

  • All Implemented Interfaces:
    SafeDisposable
    public class PoLinearValueLegend
extends PoAutoValueLegend
    Class to build a linear auto value legend. Class to build a linear value legend. The space between boxes is null and their width (or their height) is proportional to the difference between two consecutive values. The legend is composed of one column (or one row depending on the orientation of the legend). There are three possible representations:
    • The values displayed are calculated from a data mapping object or an isovalue list object.
    • The values displayed are calculated as with a linear axis. They are linearly distributed depending on the min and the max of the values of the data mapping object or the isovalue list object.
    • Only the min and the max of the values of the data mapping object or the isovalue list object are displayed. The fields incrementType, numColumns, and boxRatio are not used for this representation.

    File format/default:

    PoLinearValueLegend {

      titleVisibility VISIBILITY_OFF
      titlePosition POS_BOTTOM
      titlePath RIGHT_PATH
      titleFontSize 0
      titleFontName ""
      titleString ""
      valueVisibility VISIBILITY_ON
      valuePosition POS_RIGHT
      valueFontName ""
      valueAddStringVisibility false
      valueAddString ""
      marginType REL_MARGIN
      marginLeft 0.05
      marginRight 0.05
      marginBottom 0.05
      marginTop 0.05
      incrementType VERTICAL_INCREMENT
      numColumns 1
      boxRatio 1
      periodValue 1
      firstValue 1
      lastValue 32767
      start 0 0
      end 1 1
      valueDistribution ALL_VALUES
      maxValueSize 0.6
      lowerUndefString "UNDEF<"
      upperUndefString "UNDEF>"
      lowerUpperBoxes true
    }

    <!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="Heading725">CATALOG PARTS</A></h4> <ul><b>PoLinearValueLegend</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.</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>Separator</b> <tt>backgroundSep</tt> (from PoLegend) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw the background of the legend.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>backgroundApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the background of the legend.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>background</tt> (from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoFaceSet shape to draw the background of the legend.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>backgroundBorderSep</tt> (from PoLegend) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw background border of the legend.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>backgroundBorderApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of background border of the legend.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>backgroundBorder</tt> (from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw background border of the legend.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>boxSep</tt> (from PoLegend) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw boxes of the legend.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>boxApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of boxes of the legend.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>box</tt> (from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoQuadMesh shape to draw the boxes of the legend.</i></ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul><ul><b>Separator</b> <tt>boxBorderSep</tt> (from PoLegend){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw borders of boxes of the legend.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>boxBorderApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of borders of boxes of the legend.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>boxBorder </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw borders of boxes of the legend.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>titleSep</tt> (from PoLegend){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw title of the legend.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>titleApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of title of the legend. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>title </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoAnnoText3 shape to draw title of the legend.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>valueTextSep</tt> (from PoLegend){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw text of values of the legend.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>valueTextApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of text of values of the legend. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>valueText</tt> (from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shapes to draw text of values of the legend.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>multFactorSep</tt> (from PoValueLegend){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw text of multiplicative factor.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>multFactorApp </tt>(from PoValueLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of text of multiplicative factor. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>multFactor</tt> (from PoValueLegend)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shapes to draw text of multiplicative factor.</i></ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <p> </body> </html>

    • Field Detail

      • maxValueSize

        public final SoSFFloat maxValueSize
        Indicates the maximum size of text values. If the legend is vertical, this value is the maximum percentage of the width of text values relative to the legend width (without margin). If the legend is horizontal, this value is the maximum percentage of the height of text values relative to the legend height (without margin).

      • lowerUpperBoxes

        public final SoSFBool lowerUpperBoxes
        Indicates if lower and upper boxes should be displayed. The color of the lower box is the color associated with values less than the minimum, and the color of the upper box is the color associated with values greater than the maximum.

        Since:
        Open Inventor 6.0

    • Constructor Detail

      • PoLinearValueLegend

        public PoLinearValueLegend​(SbVec2f _start,
                           SbVec2f _end)
        Calls PoLinearValueLegend(_start, _end, PoLinearValueLegend.ValueDistributions.valueOf( PoLinearValueLegend.ValueDistributions.ALL_VALUES.getValue() )).

      • PoLinearValueLegend

        public PoLinearValueLegend()
        Default constructor.