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:

• Log axis (PoLogAxis)
• Time axis (PoTimeAxis)
• General non-numeric axis (PoGenAxis)
• Polar axis (PoPolarLinAxis, PoPolarLogAxis)

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:

PoGenAxis, PoLogAxis, PoLogAxis, PoTimeAxis, PoPolarLinAxis, PoPolarLogAxis !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="Heading544"CATALOG PARTS/A/h4 ulbPoLinearAxis/b {/ul ululbSeparator/b ttalternateRep/tt (from PoBase) {br /ul/ul ulululbAppearanceKit/b ttappearance/tt (from PoBase)/ul/ul/ul ulululiSpecifies the appearance of all the kit. By default lightModel.model=BASE_COLOR./i/ul/ul/ul ulululbMatrixTransform/b ttdomainTransform/tt (from PoBase)/ul/ul/ul ulululiCorresponds to the domain transformation./i/ul/ul/ul ulululbMatrixTransform/b tttransform/tt (from PoAxis)/ul/ul/ul ulululiCorresponds to the axis plane orientation matrix./i/ul/ul/ul ulululbSeparator/b ttbodySep/tt (from PoAxis) {/ul/ul/ul ulululiContains properties and shapes to draw the body of the axis./i/ul/ul/ul ululululbAppearanceKit/b ttbodyApp /tt(from PoAxis)/ul/ul/ul/ul ululululiSpecifies the appearance of the body of the axis./i/ul/ul/ul/ul ululululbGroup/b ttbody /tt(from PoAxis)/ul/ul/ul/ul ululululiContains a SoLineSet shape to draw the body of the axis./i/ul/ul/ul/ul ululul}br br bSeparator/b ttarrowSep/tt (from PoAxis) {/ul/ul/ul ulululiContains properties and shapes to draw the arrow./i/ul/ul/ul ululululbAppearanceKit/b ttarrowApp /tt(from PoAxis)/ul/ul/ul/ul ululululiSpecifies the appearance of the arrow./i/ul/ul/ul/ul ululululbGroup/b ttarrow /tt(from PoAxis)/ul/ul/ul/ul ululululiContains a SoFaceSet shape to draw the arrow./i/ul/ul/ul/ul ululul}br br bSeparator/b ttsubGradTickSep/tt (from PoAxis) {/ul/ul/ul ulululiContains properties and shapes to draw sub-graduation tick./i/ul/ul/ul ululululbAppearanceKit/b ttsubGradTickApp /tt(from PoAxis)/ul/ul/ul/ul ululululiSpecifies the appearance of sub-graduation tick./i/ul/ul/ul/ul ululululbGroup/b ttsubGradTick /tt(from PoAxis)/ul/ul/ul/ul ululululiContains a SoLineSet shape to draw sub-graduation tick./i/ul/ul/ul/ul ululul}br br bSeparator/b ttsubGradGridSep/tt (from PoAxis){/ul/ul/ul ulululiContains properties and shapes to draw sub-graduation grid./i/ul/ul/ul ululululbAppearanceKit/b ttsubGradGridApp /tt(from PoAxis)/ul/ul/ul/ul ululululiSpecifies the appearance of sub-graduation grid./i/ul/ul/ul/ul ululululbGroup/b ttsubGradGrid /tt(from PoAxis)/ul/ul/ul/ul ululululiContains a SoLineSet shape to draw sub-graduation grid./i/ul/ul/ul/ul ululul}br br bSeparator/b ttmainGradTickSep/tt (from PoAxis){/ul/ul/ul ulululiContains properties and shapes to draw main-graduation tick./i/ul/ul/ul ululululbAppearanceKit/b ttmainGradTickApp /tt(from PoAxis)/ul/ul/ul/ul ululululiSpecifies the appearance of main-graduation tick./i/ul/ul/ul/ul ululululbGroup/b ttmainGradTick /tt(from PoAxis)/ul/ul/ul/ul ululululiContains a SoLineSet shape to draw main-graduation tick./i/ul/ul/ul/ul ululul}br br bSeparator/b ttmainGradGridSep/tt (from PoAxis){/ul/ul/ul ulululiContains properties and shapes to draw main-graduation grid./i/ul/ul/ul ululululbAppearanceKit/b ttmainGradGridApp /tt(from PoAxis)/ul/ul/ul/ul ululululiSpecifies the appearance of main-graduation grid./i/ul/ul/ul/ul ululululbGroup/b ttmainGradGrid /tt(from PoAxis)/ul/ul/ul/ul ululululiContains a SoLineSet shape to draw main-graduation grid./i/ul/ul/ul/ul ululul}br br bSeparator/b ttmainGradTextSep/tt (from PoAxis) {/ul/ul/ul ulululiContains properties and shapes to draw main-graduation text./i/ul/ul/ul ululululbAppearanceKit/b ttmainGradTextApp /tt(from PoAxis)/ul/ul/ul/ul ululululiSpecifies 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 ululululbGroup/b ttmainGradText /tt(from PoAxis)/ul/ul/ul/ul ululululiContains a list of SoAnnoText3 shapes to draw main-graduation text./i/ul/ul/ul/ul ululul}br br bSeparator/b tttitleSep/tt (from PoAxis) {/ul/ul/ul ulululiContains properties and shapes to draw title text./i/ul/ul/ul ululululbAppearanceKit/b tttitleApp /tt(from PoAxis)/ul/ul/ul/ul ululululiSpecifies 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 ululululbGroup/b tttitle /tt(from PoAxis)/ul/ul/ul/ul ululululiContains a SoAnnoText3 shape to draw title./i/ul/ul/ul/ul ululul}br br bSeparator/b ttmultFactorSep /tt{/ul/ul/ul ulululiContains properties and shapes to draw multiplicative factor./i/ul/ul/ul ululululbAppearanceKit/b ttmultFactorApp/tt/ul/ul/ul/ul ululululiSpecifies 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 ululululbGroup/b ttmultFactor/tt/ul/ul/ul/ul ululululiContains a list of SoAnnoText3 shape to draw multiplicative factor./i/ul/ul/ul/ul ululul}/ul/ul/ul ulul}/ul/ul ul}/ul ululbr /ul/ul /body /html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PoLinearAxis.GradFits	First graduation rounded or not.
static class	PoLinearAxis.MultFactor
static class	PoLinearAxis.MultFactorPositions

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

PoCartesianAxis.Types

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

SoNode.RenderModes

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field	Description
SoSFEnum<PoLinearAxis.GradFits>	gradFit	This flag indicates if the first graduation is rounded or not.
SoSFFloat	multFactorDistAxis	Distance from the multiplicative factor to the axis.
SoSFEnum<PoLinearAxis.MultFactorPositions>	multFactorPosition	Position of the multiplicative factor.
SoSFFloat	step	Defines the step for the axis.

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

end, gradEnd, gradStart, start, type

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	Description
PoLinearAxis()	Default constructor.
PoLinearAxis(SbVec3f _start, float _end, PoCartesianAxis.Types _type)	Calls PoLinearAxis(_start, _end, _type, (float)0.0).
PoLinearAxis(SbVec3f _start, float _end, PoCartesianAxis.Types _type, float _step)	Constructor.
PoLinearAxis(SbVec3f _start, float _end, PoCartesianAxis.Types _type, float _gradStart, float _gradEnd)	Calls PoLinearAxis(_start, _end, _type, _gradStart, _gradEnd, (float)0.0).
PoLinearAxis(SbVec3f _start, float _end, PoCartesianAxis.Types _type, float _gradStart, float _gradEnd, float _step)	Constructor.

Method Summary

Modifier and Type	Method	Description
static SoNodekitCatalog	getClassNodekitCatalog()	Returns the SoNodekitCatalog for this class.
PbNumericDisplayFormat	getFormat()	Gets a reference to the PbNumericDisplayFormat object for the numerical display format for the graduations.
PoLinearAxis.MultFactor	getMultFactor()	Returns the current multiplicative factor attributes (those computed can be different from the associated field).
float	getStep()	Returns the current step attribute (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.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

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 Detail

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 Detail

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