Package com.openinventor.meshviz.graph

Class PoPolarLogAxis

  • All Implemented Interfaces:
    SafeDisposable
    public class PoPolarLogAxis
extends PoPolarAxis
    Class to build a logarithmic polar axis. This class builds a polar logarithmic axis in the plane XY. This axis will be generated from the point in polar coordinates (startRadius - offset, theta) to the point (endRadius - offset, theta), however the graduations start at startRadius and finish at endRadius. For instance to build a polar logarithmic axis with the first decade graduation being 103 and the last decade graduation being 10E8 (graduation values are: 10E3, 10E4, 10E5, ...,10E8): startRadius = 3 endRadius = 8.

    File format/default:

    PoPolarLogAxis {

      gradVisibility VISILITY_DEPEND
      gradPosition GRAD_DEPEND
      gradPath PATH_DEPEND
      gradFontName ""
      gradFontSize 0
      gradDistAxis 0
      gradAddStringVisibility false
      gradAddString ""
      marginType REL_MARGIN
      marginStart 0
      marginEnd 0
      titleVisibility VISILITY_DEPEND
      titlePosition TITLE_DEPEND
      titlePath PATH_DEPEND
      titleFontName ""
      titleFontSize 0
      titleDistAxis 0
      titleString ""
      gridVisibility VISILITY_DEPEND
      gridLengthGradSide 0
      gridLengthGradOtherSide 1
      arrowVisibility VISIBILITY_DEPEND
      arrowHeight 0.03
      arrowLength 0.05
      tickVisibility VISIBILITY_DEPEND
      tickPosition TICK_GRAD_SIDE
      tickMainLength 0
      tickSubLength 0
      tickSubDef PERIOD_MAIN_TICK
      tickNumOrPeriod 1
      tickFirstGrad 1
      tickLastGrad 1
      reverseFlag AXIS_REVERSE_DEPEND
      offset 0
      startRadius 0
      endRadius 1
      theta 0
      multFactorPosition MULT_FACTOR_END
      multFactorDistAxis 0
      decadeListDef DECADE_LIST_AUTO
      decadeList 2
      tenPowerRep TEN_POWER_POW10
      decadeRep DECADE_NONE
      decadeFontName ""
      decadeFontSize 0
    }

    <!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="Heading598">CATALOG PARTS</A></h4> <ul><b>PoPolarLogAxis</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><b>MatrixTransform</b> <tt>transform</tt> (from PoAxis)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the axis plane orientation matrix to the start.</i></ul></ul></ul> <ul><ul><ul><b>Separator</b> <tt>bodySep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw the body of the axis.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>bodyApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the body of the axis.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>body </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw the body of the axis.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>arrowSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw the arrow.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>arrowApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the arrow.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>arrow </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoFaceSet shape to draw the arrow.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>subGradTickSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw sub-graduation tick.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>subGradTickApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of sub-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>subGradTick </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw sub-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>subGradGridSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw sub-graduation grid.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>subGradGridApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of sub-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>subGradGrid </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw sub-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>mainGradTickSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw main-graduation tick.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>mainGradTickApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of main-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>mainGradTick </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw main-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>mainGradGridSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw main-graduation grid.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>mainGradGridApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of main-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>mainGradGrid </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw main-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>mainGradTextSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw main-graduation text.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>mainGradTextApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of main-graduation text. 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>mainGradText </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shapes to draw main-graduation text.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>titleSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw title text.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>titleApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of title text. 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 PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoAnnoText3 shape to draw title.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>multFactorSep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw multiplicative factor.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>multFactorApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance 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></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shape to draw multiplicative factor.</i></ul></ul></ul></ul> <ul><ul><ul>}<br> <br> <b>Separator</b> <tt>decadeTextSep </tt>{</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw decade text.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>decadeTextApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance 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>decadeText</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shape to draw decade text.</i></ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul><br> </ul></ul> </body> </html>

    • Field Detail

      • decadeList

        public final SoMFUShort decadeList
        Specifies if the list of decade graduations is given by the user or is automatically computed.

      • decadeListDef

        public final SoSFEnum<PoPolarLogAxis.DecadeListDefs> decadeListDef
        List of graduations between two power of ten graduations (decade graduations). For each integer value i of decadeList, 2 <= i <= 9, only the 8 first values of decadeList are used. This field is used to build the axis only if decadeListDef = DECADE_LIST_NON_AUTO.

      • decadeFontName

        public final SoSFString decadeFontName
        Decade font name. If the font is equal to its default value, the font used is the font of the the current miscellaneous text attributes (cf PoAxis description).

      • decadeFontSize

        public final SoSFFloat decadeFontSize
        Decade graduations font size. If this value is <= 0, the font size is fixed at 0.04 if the graduations do not cross each other. This value is a percentage of the current domain (cf PoBase description).

    • Constructor Detail

      • PoPolarLogAxis

        public PoPolarLogAxis​(float offset,
                      float startRadius,
                      float endRadius,
                      float theta,
                      PoPolarLogAxis.DecadeListDefs decadeListDef,
                      short[] decadeList)
        Calls PoPolarLogAxis(offset, startRadius, endRadius, theta, decadeListDef, decadeList, (short)0).

      • PoPolarLogAxis

        public PoPolarLogAxis​(float offset,
                      float startRadius,
                      float endRadius,
                      float theta,
                      PoPolarLogAxis.DecadeListDefs decadeListDef)
        Calls PoPolarLogAxis(offset, startRadius, endRadius, theta, decadeListDef, (short[])null, (short)0).

      • PoPolarLogAxis

        public PoPolarLogAxis​(float offset,
                      float startRadius,
                      float endRadius,
                      float theta)
        Calls PoPolarLogAxis(offset, startRadius, endRadius, theta, PoPolarLogAxis.DecadeListDefs.valueOf( PoPolarLogAxis.DecadeListDefs.DECADE_LIST_AUTO.getValue() ), (short[])null, (short)0).

      • PoPolarLogAxis

        public PoPolarLogAxis​(float offset,
                      float startRadius,
                      float endRadius,
                      float theta,
                      PoPolarLogAxis.DecadeListDefs decadeListDef,
                      short[] decadeList,
                      short numDecade)
        Constructor.

      • PoPolarLogAxis

        public PoPolarLogAxis()
        Default constructor.

    • Method Detail

      • getLogGrad

        public PoPolarLogAxis.GradAttributes getLogGrad()
        Returns the current logarithmic graduations attributes (those computed can be different from the associated fields).