PoPolarLinAxis

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.PoPolarAxis
        
        com.openinventor.meshviz.graph.PoPolarLinAxis

All Implemented Interfaces:: SafeDisposable, SoGetView

public class PoPolarLinAxis
extends PoPolarAxis

Class to build a polar linear axis. This class builds a polar linear axis in the plane XY. This axis will be generated from the point in polar coordinate (startRadius + offset, theta) to the point (endRadius + offset, theta), however the graduations start at startRadius and finish at endRadius.

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 current numerical display format is specified in the current inherited state (cf property node PoNumericDisplayFormat).

File format/default:

PoPolarLinAxis {

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
step	0
gradFit	GRAD_UNFIT

}

<!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="Heading589">CATALOG PARTS</A></h4> <ul>PoPolarLinAxis {</ul> <ul><ul>Separator <tt>alternateRep</tt> (from PoBase) { </ul></ul> <ul><ul><ul>AppearanceKit <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</ul></ul></ul> <ul><ul><ul>MatrixTransform <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul>Corresponds to the domain transformation.</ul></ul></ul> <ul><ul><ul>MatrixTransform <tt>transform</tt> (from PoAxis)</ul></ul></ul> <ul><ul><ul>Corresponds to the axis plane orientation matrix.</ul></ul></ul> <ul><ul><ul><ul></ul></ul></ul></ul> <ul><ul><ul>Separator <tt>bodySep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the body of the axis.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>bodyApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the body of the axis.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>body </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw the body of the axis.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>arrowSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the arrow.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>arrowApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the arrow.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>arrow </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw the arrow.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>subGradTickSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw sub-graduation tick.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>subGradTickApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of sub-graduation tick.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>subGradTick </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw sub-graduation tick.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>subGradGridSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw sub-graduation grid.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>subGradGridApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of sub-graduation grid.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>subGradGrid </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw sub-graduation grid.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>mainGradTickSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw main-graduation tick.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>mainGradTickApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of main-graduation tick.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>mainGradTick </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw main-graduation tick.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>mainGradGridSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw main-graduation grid.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>mainGradGridApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of main-graduation grid.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>mainGradGrid </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw main-graduation grid.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>mainGradTextSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw main-graduation text.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>mainGradTextApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of main-graduation text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>mainGradText </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shapes to draw main-graduation text.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>titleSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw title text.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>titleApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of title text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>title </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoAnnoText3 shape to draw title.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>multFactorSep </tt>(from PoPolarAxis) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw multiplicative factor.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>multFactorApp </tt>(from PoPolarAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of multiplicative factor. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>multFactor </tt>(from PoPolarAxis)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shape to draw multiplicative factor.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul> </ul></ul> </body> </html>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PoPolarLinAxis.GradFits
First graduation rounded or not.
- Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoPolarAxis
  PoPolarAxis.MultFactor, PoPolarAxis.MultFactorPositions
- Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoAxis
  PoAxis.ArrowAttributes, PoAxis.AxisReverses, PoAxis.GradAttributes, PoAxis.GradPositions, PoAxis.GridAttributes, PoAxis.MarginAttributes, PoAxis.MarginTypes, PoAxis.TextPaths, PoAxis.TickAttributes, PoAxis.TickPositions, PoAxis.TickSubDefs, PoAxis.TitleAttributes, PoAxis.TitlePositions, PoAxis.Visibilities
- Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoBase
  PoBase.NodeWriteFormats, PoBase.TextTypes, PoBase.UpdateMethodTypes
- Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
  Inventor.ConstructorCommand

Nested Classes
Modifier and Type	Class and Description
`static class`	`PoPolarLinAxis.GradFits` First graduation rounded or not.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`GRAD_FIT` Deprecated. Use `PoPolarLinAxis.GradFits.GRAD_FIT` instead.
`static int`	`GRAD_UNFIT` Deprecated. Use `PoPolarLinAxis.GradFits.GRAD_UNFIT` instead.
`SoSFEnum<PoPolarLinAxis.GradFits>`	`gradFit` This flag indicates if the first graduation is rounded or not.
`SoSFFloat`	`step` Defines the step for the axis.

Fields inherited from class com.openinventor.meshviz.graph.PoPolarAxis
endRadius, MULT_FACTOR_END, MULT_FACTOR_EXTR, MULT_FACTOR_GRAD, MULT_FACTOR_START, multFactorDistAxis, multFactorPosition, offset, startRadius, theta

Fields inherited from class com.openinventor.meshviz.graph.PoAxis
arrowHeight, arrowLength, arrowVisibility, AXIS_NO_REVERSE, AXIS_REVERSE, AXIS_REVERSE_DEPEND, FIXED_MARGIN, GRAD_ABOVE, GRAD_BELOW, GRAD_DEPEND, gradAddString, gradAddStringVisibility, gradDistAxis, gradFontName, gradFontSize, gradPath, gradPosition, gradVisibility, gridLengthGradOtherSide, gridLengthGradSide, gridVisibility, marginEnd, marginStart, marginType, NUM_SUB_TICK, PATH_DEPEND, PATH_DOWN, PATH_LEFT, PATH_RIGHT, PATH_UP, PERIOD_MAIN_TICK, REL_MARGIN, reverseFlag, TICK_ACROSS_AXIS, TICK_GRAD_OTHER_SIDE, TICK_GRAD_SIDE, tickFirstGrad, tickLastGrad, tickMainLength, tickNumOrPeriod, tickPosition, tickSubDef, tickSubLength, tickVisibility, TITLE_DEPEND, TITLE_END, TITLE_MIDDLE, titleDistAxis, titleFontName, titleFontSize, titlePath, titlePosition, titleString, titleVisibility, VISIBILITY_DEPEND, VISIBILITY_OFF, VISIBILITY_ON

Fields inherited from class com.openinventor.meshviz.graph.PoBase
FOLD_NODE_WRITE_FORMAT, SO_ANNO_TEXT3, SO_TEXT3, UNFOLD_NODE_WRITE_FORMAT, UPDATE_METHOD_IMMEDIATE, UPDATE_METHOD_ON_ACTION

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit
boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor and Description
`PoPolarLinAxis()` Default constructor.
`PoPolarLinAxis(float offset, float startRadius, float endRadius, float theta)` Calls PoPolarLinAxis(offset, startRadius, endRadius, theta, (float)0.0).
`PoPolarLinAxis(float offset, float startRadius, float endRadius, float theta, float step)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SoNodekitCatalog`	`getClassNodekitCatalog()` Returns the `SoNodekitCatalog` for this class.
`PbNumericDisplayFormat`	`getFormat()` Gets a reference to a `PbNumericDisplayFormat` object for the numerical display format for the graduations.
`float`	`getStep()` Returns the step (the step computed can be different from the associated field).
`void`	`setFormat(PbNumericDisplayFormat format)` Sets a reference to a `PbNumericDisplayFormat` object for the numerical display format for the graduations.

Methods inherited from class com.openinventor.meshviz.graph.PoPolarAxis
getMultFactor

Methods inherited from class com.openinventor.meshviz.graph.PoAxis
getArrow, getGrad, getGrid, getMargin, getMiscTextAttr, getReverseFlag, getTick, getTitle, setMiscTextAttr

Methods inherited from class com.openinventor.meshviz.graph.PoBase
addPostRebuildCallback, addPreRebuildCallback, getDomain, getNodeWriteFormat, getTextType, getUpdateMethod, isBuilt, isModified, isVRML2Mode, rebuild, setDomain, setNodeWriteFormat, setTextType, setUpdateMethod, setVRML2Mode, touchKit

Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit
getNodekitCatalog, getPart, getPart, getPartString, getViewportIsEnabled, getViewportOrigin, getViewportSize, isSearchingChildren, set, set, setPart, setSearchingChildren

Methods inherited from class com.openinventor.inventor.nodes.SoNode
affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer
copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase
dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor
getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
 - GRAD_FIT
```
@Deprecated
public static final int GRAD_FIT
```
 Deprecated. Use PoPolarLinAxis.GradFits.GRAD_FIT instead.
 - GRAD_UNFIT
```
@Deprecated
public static final int GRAD_UNFIT
```
 Deprecated. Use PoPolarLinAxis.GradFits.GRAD_UNFIT instead.
 - 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<PoPolarLinAxis.GradFits> gradFit
```
 This flag indicates if the first graduation is rounded or not.
- Constructor Detail
 - PoPolarLinAxis
```
public PoPolarLinAxis(float offset,
 float startRadius,
 float endRadius,
 float theta)
```
 Calls PoPolarLinAxis(offset, startRadius, endRadius, theta, (float)0.0).
 - PoPolarLinAxis
```
public PoPolarLinAxis(float offset,
 float startRadius,
 float endRadius,
 float theta,
 float step)
```
 Constructor.
 - PoPolarLinAxis
```
public PoPolarLinAxis()
```
 Default constructor.
- Method Detail
 - getClassNodekitCatalog
```
public static SoNodekitCatalog getClassNodekitCatalog()
```
 Returns the SoNodekitCatalog for this class.
 - getStep
```
public float getStep()
```
 Returns the step (the step computed can be different from the associated field).
 - 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), this is the numerical display format defined in the current inherited state (defined with the property node PoNumericDisplayFormat) which is used.
 - getFormat
```
public PbNumericDisplayFormat getFormat()
```
 Gets a reference to a PbNumericDisplayFormat object for the numerical display format for the graduations.

Class PoPolarLinAxis

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoPolarAxis

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoAxis

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoBase

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Field Summary

Fields inherited from class com.openinventor.meshviz.graph.PoPolarAxis

Fields inherited from class com.openinventor.meshviz.graph.PoAxis

Fields inherited from class com.openinventor.meshviz.graph.PoBase

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit

Fields inherited from class com.openinventor.inventor.Inventor

Constructor Summary

Method Summary

Methods inherited from class com.openinventor.meshviz.graph.PoPolarAxis

Methods inherited from class com.openinventor.meshviz.graph.PoAxis

Methods inherited from class com.openinventor.meshviz.graph.PoBase

Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit

Methods inherited from class com.openinventor.inventor.nodes.SoNode

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

Methods inherited from class com.openinventor.inventor.misc.SoBase

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

GRAD_FIT

GRAD_UNFIT

step

gradFit

Constructor Detail

PoPolarLinAxis

PoPolarLinAxis

PoPolarLinAxis

Method Detail

getClassNodekitCatalog

getStep

setFormat

getFormat