PoPolarLogAxis

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.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>PoPolarLogAxis {</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 to the start.</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> {</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></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></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>} Separator <tt>decadeTextSep </tt>{</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw decade text.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>decadeTextApp</tt></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>decadeText</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shape to draw decade text.</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`	`PoPolarLogAxis.DecadeListDefs` Decade list computed automatically or given by the user.
`static class`	`PoPolarLogAxis.DecadeReps` Type of presentation of the axis decades.
`static class`	`PoPolarLogAxis.GradAttributes`
`static class`	`PoPolarLogAxis.TenPowGradReps` Type of presentation of the power of ten.

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.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.nodes.SoNode
SoNode.RenderModes

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

Field Summary

Fields
Modifier and Type	Field and Description
`SoSFString`	`decadeFontName` Decade font name.
`SoSFFloat`	`decadeFontSize` Decade graduations font size.
`SoMFUShort`	`decadeList` Specifies if the list of decade graduations is given by the user or is automatically computed.
`SoSFEnum<PoPolarLogAxis.DecadeListDefs>`	`decadeListDef` List of graduations between two power of ten graduations (decade graduations).
`SoSFEnum<PoPolarLogAxis.DecadeReps>`	`decadeRep` Defines the representation of the decade graduations between two power of ten graduations.
`SoSFEnum<PoPolarLogAxis.TenPowGradReps>`	`tenPowerRep` Defines the representation of power of ten graduations.

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

Fields inherited from class com.openinventor.meshviz.graph.PoAxis
arrowHeight, arrowLength, arrowVisibility, gradAddString, gradAddStringVisibility, gradDistAxis, gradFontName, gradFontSize, gradPath, gradPosition, gradVisibility, gridLengthGradOtherSide, gridLengthGradSide, gridVisibility, marginEnd, marginStart, marginType, reverseFlag, tickFirstGrad, tickLastGrad, tickMainLength, tickNumOrPeriod, tickPosition, tickSubDef, tickSubLength, tickVisibility, titleDistAxis, titleFontName, titleFontSize, titlePath, titlePosition, titleString, titleVisibility

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
`PoPolarLogAxis()` Default constructor.
`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(float offset, float startRadius, float endRadius, float theta, PoPolarLogAxis.DecadeListDefs decadeListDef)` Calls PoPolarLogAxis(offset, startRadius, endRadius, theta, decadeListDef, (short[])null, (short)0).
`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(float offset, float startRadius, float endRadius, float theta, PoPolarLogAxis.DecadeListDefs decadeListDef, short[] decadeList, short numDecade)` 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.
`PoPolarLogAxis.GradAttributes`	`getLogGrad()` Returns the current logarithmic graduations attributes (those computed can be different from the associated fields).

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, getRenderEngineMode, 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, getName, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor
getNativeResourceHandle

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

- 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.
 - tenPowerRep
```
public final SoSFEnum<PoPolarLogAxis.TenPowGradReps> tenPowerRep
```
 Defines the representation of power of ten graduations. .
 - decadeRep
```
public final SoSFEnum<PoPolarLogAxis.DecadeReps> decadeRep
```
 Defines the representation of the decade graduations between two power of ten graduations.
 - 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).
 - getClassNodekitCatalog
```
public static SoNodekitCatalog getClassNodekitCatalog()
```
 Returns the SoNodekitCatalog for this class.

Class PoPolarLogAxis

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.nodes.SoNode

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.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

decadeList

decadeListDef

tenPowerRep

decadeRep

decadeFontName

decadeFontSize

Constructor Detail

PoPolarLogAxis

PoPolarLogAxis

PoPolarLogAxis

PoPolarLogAxis

PoPolarLogAxis

Method Detail

getLogGrad

getClassNodekitCatalog