com.openinventor.meshviz.graph

Class PoValueLegend

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

com.openinventor.meshviz.graph.PoValueLegend

All Implemented Interfaces:

SafeDisposable, SoGetView

Direct Known Subclasses:

PoAutoValueLegend

public class PoValueLegend
extends PoLegend

Abstract class for values legend. This class handles a period of values, a first value and a last value to be displayed in a legend, specific strings.

Values of the legends depend on :

• the current list of isovalues only if this list exists. In this case, values of the legend are the values defined by the current list of isovalues. The current data mapping is only used for coloring boxes of the legend.
• the current data mapping only if the current list of isovalues does no exist. In this case, the values of the legend are the values of the current data mapping. If the current data mapping is linear, about ten values are computed. If the current data mapping is defined by a function or it does not exist, the list of legend values is empty.

If setIsovaluesList(isovaluesList) method is called with "isovaluesList" derived from PbIsovaluesList, the current isovalues list is "isovaluesList". Otherwise the current isovalues list is specified in the current inherited state (cf PoIsovaluesList property node). The current isovalues list does not exist if setIsovaluesList() method is not called and no PoIsovaluesList node is traversed before in the scene graph.

If setDataMapping(dataMapping) method is called with "dataMapping" derived from PbDataMapping, the current data mapping is "dataMapping". Otherwise the current data mapping is specified in the current inherited state (cf property node PoDataMapping and its derived classes). The current data mapping does not exist if setDataMapping() method is not called and no PoDataMapping node is traversed before in the scene graph.

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

Nested Class Summary

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

PoLegend.IncrementTypes, PoLegend.MarginTypes, PoLegend.Positions, PoLegend.TextPaths, PoLegend.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

Field Summary

Fields

Modifier and Type	Field and Description
SoSFUShort	firstValue Number of the first value to display.
SoSFUShort	lastValue Number of the last value to display.
SoSFString	lowerUndefString String indicating the lower undefined level.
SoSFUShort	periodValue Period to display the values in the legend.
SoSFString	upperUndefString String indicating the upper undefined level.

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

boxRatio, FIXED_MARGIN, HORIZONTAL_INCREMENT, incrementType, marginBottom, marginLeft, marginRight, marginTop, marginType, numColumns, PATH_DOWN, PATH_LEFT, PATH_RIGHT, PATH_UP, POS_BOTTOM, POS_LEFT, POS_RIGHT, POS_TOP, REL_MARGIN, titleFontName, titleFontSize, titlePath, titlePosition, titleString, titleVisibility, valueAddString, valueAddStringVisibility, valueFontName, valuePosition, valueVisibility, VERTICAL_INCREMENT, 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

Method Summary

Modifier and Type	Method and Description
static SoNodekitCatalog	getClassNodekitCatalog() Returns the SoNodekitCatalog for this class.
PbDataMapping	getDataMapping() Gets a reference to a PbDataMapping object to the association color-values.
PbNumericDisplayFormat	getFormat() Gets a reference to a PbNumericDisplayFormat object for the numerical display format of the legend values.
PbIsovaluesList	getIsovaluesList() Gets a reference to a PbIsovaluesList object.
void	setDataMapping(PbDataMapping dataMapping) Sets a reference to a PbDataMapping object to the association color-values.
void	setFormat(PbNumericDisplayFormat format) Sets a reference to a PbNumericDisplayFormat object for the numerical display format of the legend values.
void	setIsovaluesList(PbIsovaluesList isovaluesList) Sets a reference to a PbIsovaluesList object.

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

getMiscTextAttr, 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

upperUndefString

public final SoSFString upperUndefString

String indicating the upper undefined level. (Corresponds to the maximum threshold of data mapping. Not used if no data mapping object is specified or if the maximum threshold is disabled).

lowerUndefString

public final SoSFString lowerUndefString

String indicating the lower undefined level. (Corresponds to the minimum threshold of data mapping Not used if no data mapping object is specified or if the minimum threshold is disabled).

periodValue

public final SoSFUShort periodValue

Period to display the values in the legend.

firstValue

public final SoSFUShort firstValue

Number of the first value to display.

lastValue

public final SoSFUShort lastValue

Number of the last value to display.

Method Detail

getFormat

public PbNumericDisplayFormat getFormat()

Gets a reference to a PbNumericDisplayFormat object for the numerical display format of the legend values.

getClassNodekitCatalog

public static SoNodekitCatalog getClassNodekitCatalog()

Returns the SoNodekitCatalog for this class.

setDataMapping

public void setDataMapping(PbDataMapping dataMapping)

Sets a reference to a PbDataMapping object to the association color-values. If this method is not called (or called passing NULL as argument), this is the data mapping defined in the current inherited state (defined with the property node PoDataMapping and its derived classes) which is used.

setFormat

public void setFormat(PbNumericDisplayFormat format)

Sets a reference to a PbNumericDisplayFormat object for the numerical display format of the legend values. 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.

getDataMapping

public PbDataMapping getDataMapping()

Gets a reference to a PbDataMapping object to the association color-values.

getIsovaluesList

public PbIsovaluesList getIsovaluesList()

Gets a reference to a PbIsovaluesList object.

setIsovaluesList

public void setIsovaluesList(PbIsovaluesList isovaluesList)

Sets a reference to a PbIsovaluesList object. A PbIsovaluesList object defines an isovalue list used for the legend values. If this method is not called (or called passing NULL as argument), this is the isovalue list defined in the current inherited state (defined with the property node PoIsovaluesList) which is used.