Package com.openinventor.meshviz.graph

Class PoLinearAxis

java.lang.Object
com.openinventor.inventor.Inventor
com.openinventor.inventor.misc.SoBase
com.openinventor.inventor.fields.SoFieldContainer
com.openinventor.inventor.nodes.SoNode
com.openinventor.inventor.nodekits.SoBaseKit
com.openinventor.meshviz.graph.PoBase
com.openinventor.meshviz.graph.PoGraphMaster
com.openinventor.meshviz.graph.PoBaseAxis
com.openinventor.meshviz.graph.PoAxis
com.openinventor.meshviz.graph.PoCartesianAxis
com.openinventor.meshviz.graph.PoLinearAxis
All Implemented Interfaces:
SafeDisposable
public class PoLinearAxis extends PoCartesianAxis
Class to build a linear axis. This class builds a linear axis. This axis will be generated between the point start and the point end. The graduations (tick marks, labels, etc) will be in the plane given by the field PoCartesianAxis.type.

By default, the text of the displayed graduations (the tick mark labels) are based on the actual coordinates of the axis (start and end). The text of the graduations is based on the specified range if the gradStart and gradEnd fields are not equal.

The graduations format depends on the current numerical display format. If the method setFormat(format) is called, the current numerical display format is "format". Otherwise the numerical display format is the inherited value from PoNumericDisplayFormat (default AUTO).

See PoAxis for discussion of axis attributes.

    Axis Attributes

Many other kinds of axes can generated, for example:

Multiple axes can generated conveniently using PoGroup2Axis, etc.

File format/default:

PoLinearAxis {

    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
    start 0 0 0
    end 1
    gradStart 0
    gradEnd 0
    type XY
    step 0
    gradFit GRAD_UNFIT
    multFactorPosition MULT_FACTOR_END
    multFactorDistAxis 0
}

See Also:

  • Field Details

    • step

      public final SoSFFloat step
      Defines the step for the axis. If this value is <= 0, the step is automatically calculated.

    • gradFit

      public final SoSFEnum<PoLinearAxis.GradFits> gradFit
      This flag indicates if the first graduation is rounded or not.

    • multFactorPosition

      public final SoSFEnum<PoLinearAxis.MultFactorPositions> multFactorPosition
      Position of the multiplicative factor.

    • multFactorDistAxis

      public final SoSFFloat multFactorDistAxis
      Distance from the multiplicative factor to the axis. This value is a percentage of the current domain (cf PoBase description). If this value is <= 0, the distance is automatically calculated.

  • Constructor Details

    • PoLinearAxis

      public PoLinearAxis(SbVec3f _start, float _end, PoCartesianAxis.Types _type)
      Calls PoLinearAxis(_start, _end, _type, (float)0.0).

    • PoLinearAxis

      public PoLinearAxis(SbVec3f _start, float _end, PoCartesianAxis.Types _type, float _gradStart, float _gradEnd)
      Calls PoLinearAxis(_start, _end, _type, _gradStart, _gradEnd, (float)0.0).

    • PoLinearAxis

      public PoLinearAxis()
      Default constructor.

    • PoLinearAxis

      public PoLinearAxis(SbVec3f _start, float _end, PoCartesianAxis.Types _type, float _step)
      Constructor.

    • PoLinearAxis

      public PoLinearAxis(SbVec3f _start, float _end, PoCartesianAxis.Types _type, float _gradStart, float _gradEnd, float _step)
      Constructor.

      Since:
      Open Inventor 9.3

  • Method Details

    • getMultFactor

      public PoLinearAxis.MultFactor getMultFactor()
      Returns the current multiplicative factor attributes (those computed can be different from the associated field).

    • getClassNodekitCatalog

      public static SoNodekitCatalog getClassNodekitCatalog()
      Returns the SoNodekitCatalog for this class.

    • setFormat

      public void setFormat(PbNumericDisplayFormat format)
      Sets a reference to a PbNumericDisplayFormat object for the numerical display format for the graduations. If this method is not called (or called passing NULL as argument), the numerical display format defined in the current inherited state (defined with the property node PoNumericDisplayFormat) is used.

    • getFormat

      public PbNumericDisplayFormat getFormat()
      Gets a reference to the PbNumericDisplayFormat object for the numerical display format for the graduations. Returns null if none specified.

    • getStep

      public float getStep()
      Returns the current step attribute (the step computed can be different from the associated field).