Package com.openinventor.meshviz.graph
Class PoLegend
- java.lang.Object
-
- All Implemented Interfaces:
SafeDisposable
- Direct Known Subclasses:
PoItemLegend
,PoValueLegend
public class PoLegend extends PoGraphMaster
Abstract class for legend representations. This class handles the title, the values, the margins and the path of the legend.All legend texts depend on the current miscellaneous text attributes which define the font name, line length and so on. If the method setMiscTextAttr(textAttr) is called, the current miscellaneous text attributes are defined by "textAttr". Otherwise the current miscellaneous text attributes are specified in the current inherited state (cf property node
PoMiscTextAttr
).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PoLegend.IncrementTypes
Type of values incrementation.static class
PoLegend.MarginTypes
Type of margins.static class
PoLegend.Positions
Type of position.static class
PoLegend.TextPaths
Text path.static class
PoLegend.Visibilities
Type of visibility.-
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 SoSFFloat
boxRatio
Ratio between width and height of the colored boxes in the legend.SoSFEnum<PoLegend.IncrementTypes>
incrementType
Increment type for the values of legend.SoSFFloat
marginBottom
Bottom margin.SoSFFloat
marginLeft
Left margin.SoSFFloat
marginRight
Right margin.SoSFFloat
marginTop
Top margin.SoSFEnum<PoLegend.MarginTypes>
marginType
Margin type.SoSFUShort
numColumns
Number of columns of the legend.SoSFString
titleFontName
Font name of the title.SoSFFloat
titleFontSize
Font size of the title.SoSFEnum<PoLegend.TextPaths>
titlePath
Title path.SoSFEnum<PoLegend.Positions>
titlePosition
Title position.SoSFString
titleString
Title string.SoSFEnum<PoLegend.Visibilities>
titleVisibility
Title visibility.SoSFString
valueAddString
String to be concatenated.SoSFBool
valueAddStringVisibility
Visibility of a string concatenated to the values.SoSFString
valueFontName
Font name of values.SoSFEnum<PoLegend.Positions>
valuePosition
Values positions.SoSFEnum<PoLegend.Visibilities>
valueVisibility
Values visibility.-
Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit
boundingBoxIgnoring
-
Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SoNodekitCatalog
getClassNodekitCatalog()
Returns theSoNodekitCatalog
for this class.PbMiscTextAttr
getMiscTextAttr()
Gets a reference to aPbMiscTextAttr
for miscellaneous text attributes.void
setMiscTextAttr(PbMiscTextAttr textAttr)
Sets a reference to aPbMiscTextAttr
for miscellaneous text attributes of all legend texts.-
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
-
-
-
-
Field Detail
-
titleVisibility
public final SoSFEnum<PoLegend.Visibilities> titleVisibility
Title visibility.
-
titlePosition
public final SoSFEnum<PoLegend.Positions> titlePosition
Title position.
-
titlePath
public final SoSFEnum<PoLegend.TextPaths> titlePath
Title path. .
-
titleFontSize
public final SoSFFloat titleFontSize
Font size of the title.
-
titleFontName
public final SoSFString titleFontName
Font name of the title. If the font is equal to its default value, the font used is the font of the current miscellaneous text attributes.
-
titleString
public final SoSFString titleString
Title string.
-
valueVisibility
public final SoSFEnum<PoLegend.Visibilities> valueVisibility
Values visibility.
-
valuePosition
public final SoSFEnum<PoLegend.Positions> valuePosition
Values positions.
-
valueFontName
public final SoSFString valueFontName
Font name of values. If the font is equal to its default value, the font used is the font of the current miscellaneous text attributes.
-
valueAddStringVisibility
public final SoSFBool valueAddStringVisibility
Visibility of a string concatenated to the values.
-
valueAddString
public final SoSFString valueAddString
String to be concatenated.
-
marginType
public final SoSFEnum<PoLegend.MarginTypes> marginType
Margin type.
-
marginLeft
public final SoSFFloat marginLeft
Left margin.
-
marginRight
public final SoSFFloat marginRight
Right margin.
-
marginBottom
public final SoSFFloat marginBottom
Bottom margin.
-
marginTop
public final SoSFFloat marginTop
Top margin.
-
incrementType
public final SoSFEnum<PoLegend.IncrementTypes> incrementType
Increment type for the values of legend. (the values can be incremented vertically or horizontally).
-
numColumns
public final SoSFUShort numColumns
Number of columns of the legend.
-
boxRatio
public final SoSFFloat boxRatio
Ratio between width and height of the colored boxes in the legend.
-
-
Method Detail
-
getMiscTextAttr
public PbMiscTextAttr getMiscTextAttr()
Gets a reference to aPbMiscTextAttr
for miscellaneous text attributes.
-
setMiscTextAttr
public void setMiscTextAttr(PbMiscTextAttr textAttr)
Sets a reference to aPbMiscTextAttr
for miscellaneous text attributes of all legend texts. If this method is not called (or called passing NULL as argument), this is the miscellaneous text attributes defined in the current inherited state (defined with the property nodePoMiscTextAttr
) which are used.
-
getClassNodekitCatalog
public static SoNodekitCatalog getClassNodekitCatalog()
Returns theSoNodekitCatalog
for this class.
-
-