Class PoLabelField
- java.lang.Object
-
- All Implemented Interfaces:
SafeDisposable
public class PoLabelField extends PoGraphMaster
Class to build a label field. Class to build a label field in the plane XY. This class represents a set of 2D points annotated by a string and a value.All numerical values (if there are visible) depend on the current numerical display format. If the method setFormat(format) is called, the current numeric display format is "format". Otherwise the current numeric display format is specified in the current inherited state (cf property node
PoNumericDisplayFormat
).File format/default:
point 0 0 string "" value 0 concatType STRING_BEFORE_VALUE fontSize 1 justification LEFT verticalJustification BASE coordinateType COORDINATE_IN_CURRENT_UNIT <!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="Heading355">CATALOG PARTS</A></h4> <ul><b>PoLabelField</b> {</ul> <ul><ul><b>Separator</b> <tt>alternateRep</tt> (from PoBase) {<br> </ul></ul> <ul><ul><ul><b>AppearanceKit</b> <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR and drawStyle.style=LINES. </i><br> <i>font.size is set to the field fontSize.</i></ul></ul></ul> <ul><ul><ul><b>MatrixTransform</b> <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the domain transformation.</i></ul></ul></ul> <ul><ul><ul><ul></ul></ul></ul></ul> <ul><ul><ul><b>Group</b> <tt>labelField</tt></ul></ul></ul> <ul><ul><ul><i>Contains a list of SoAnnoText3 shapes.</i></ul></ul></ul> <ul><ul>}</ul></ul> <ul>}<br> </ul> </body> </html>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PoLabelField.ConcatTypes
Type of string concatenation.static class
PoLabelField.CoordinateTypes
Type of coordinates.static class
PoLabelField.Justifications
static class
PoLabelField.VerticalJustifications
-
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<PoLabelField.ConcatTypes>
concatType
Concatenation type between values and strings.SoSFEnum<PoLabelField.CoordinateTypes>
coordinateType
Type of coordinates.SoSFFloat
fontSize
Font size for strings to display.SoSFEnum<PoLabelField.Justifications>
justification
Horizontal justification.SoMFVec2f
point
List of points which are the coordinates of the strings.SoMFString
string
List of strings to display.SoMFFloat
value
List of values to display.SoSFEnum<PoLabelField.VerticalJustifications>
verticalJustification
Vertical justification.-
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 PoLabelField()
Default constructor.PoLabelField(SbVec2f[] _point, java.lang.String[] _string, float[] _value, float _fontSize)
Calls PoLabelField(_point, _string, _value, _fontSize, PoLabelField.ConcatTypes.valueOf( PoLabelField.ConcatTypes.STRING_BEFORE_VALUE.getValue() ), PoLabelField.Justifications.valueOf( PoLabelField.Justifications.LEFT.getValue() ), PoLabelField.VerticalJustifications.valueOf( PoLabelField.VerticalJustifications.BASE.getValue() )).PoLabelField(SbVec2f[] _point, java.lang.String[] _string, float[] _value, float _fontSize, PoLabelField.ConcatTypes type)
Calls PoLabelField(_point, _string, _value, _fontSize, type, PoLabelField.Justifications.valueOf( PoLabelField.Justifications.LEFT.getValue() ), PoLabelField.VerticalJustifications.valueOf( PoLabelField.VerticalJustifications.BASE.getValue() )).PoLabelField(SbVec2f[] _point, java.lang.String[] _string, float[] _value, float _fontSize, PoLabelField.ConcatTypes type, PoLabelField.Justifications _justification)
Calls PoLabelField(_point, _string, _value, _fontSize, type, _justification, PoLabelField.VerticalJustifications.valueOf( PoLabelField.VerticalJustifications.BASE.getValue() )).PoLabelField(SbVec2f[] _point, java.lang.String[] _string, float[] _value, float _fontSize, PoLabelField.ConcatTypes type, PoLabelField.Justifications _justification, PoLabelField.VerticalJustifications _verticalJustification)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SoNodekitCatalog
getClassNodekitCatalog()
Returns theSoNodekitCatalog
for this class.PbNumericDisplayFormat
getFormat()
Gets a reference to aPbNumericDisplayFormat
object for the numeric display format for the values.void
setFormat(PbNumericDisplayFormat format)
Sets a reference to aPbNumericDisplayFormat
object for the numeric display format for the values.-
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
-
point
public final SoMFVec2f point
List of points which are the coordinates of the strings.
-
string
public final SoMFString string
List of strings to display. To be displayed, the number of strings must be equal to the number of points of point.
-
value
public final SoMFFloat value
List of values to display. The values are converted into strings according to the current numerical display format. To be displayed, the number of values must be equal to the number of points of point.
-
concatType
public final SoSFEnum<PoLabelField.ConcatTypes> concatType
Concatenation type between values and strings.
-
fontSize
public final SoSFFloat fontSize
Font size for strings to display.
-
justification
public final SoSFEnum<PoLabelField.Justifications> justification
Horizontal justification.
-
verticalJustification
public final SoSFEnum<PoLabelField.VerticalJustifications> verticalJustification
Vertical justification. .
-
coordinateType
public final SoSFEnum<PoLabelField.CoordinateTypes> coordinateType
Type of coordinates.- coordinateType = COORDINATE_IN_DOMAIN: coordinates are expressed in the current domain (cf
PoBase
description), - coordinateType = COORDINATE_IN_CURRENT_UNIT: coordinates are expressed in the current unit.
- coordinateType = COORDINATE_IN_DOMAIN: coordinates are expressed in the current domain (cf
-
-
Constructor Detail
-
PoLabelField
public PoLabelField(SbVec2f[] _point, java.lang.String[] _string, float[] _value, float _fontSize, PoLabelField.ConcatTypes type)
Calls PoLabelField(_point, _string, _value, _fontSize, type, PoLabelField.Justifications.valueOf( PoLabelField.Justifications.LEFT.getValue() ), PoLabelField.VerticalJustifications.valueOf( PoLabelField.VerticalJustifications.BASE.getValue() )).
-
PoLabelField
public PoLabelField(SbVec2f[] _point, java.lang.String[] _string, float[] _value, float _fontSize)
Calls PoLabelField(_point, _string, _value, _fontSize, PoLabelField.ConcatTypes.valueOf( PoLabelField.ConcatTypes.STRING_BEFORE_VALUE.getValue() ), PoLabelField.Justifications.valueOf( PoLabelField.Justifications.LEFT.getValue() ), PoLabelField.VerticalJustifications.valueOf( PoLabelField.VerticalJustifications.BASE.getValue() )).
-
PoLabelField
public PoLabelField(SbVec2f[] _point, java.lang.String[] _string, float[] _value, float _fontSize, PoLabelField.ConcatTypes type, PoLabelField.Justifications _justification)
Calls PoLabelField(_point, _string, _value, _fontSize, type, _justification, PoLabelField.VerticalJustifications.valueOf( PoLabelField.VerticalJustifications.BASE.getValue() )).
-
PoLabelField
public PoLabelField()
Default constructor.
-
PoLabelField
public PoLabelField(SbVec2f[] _point, java.lang.String[] _string, float[] _value, float _fontSize, PoLabelField.ConcatTypes type, PoLabelField.Justifications _justification, PoLabelField.VerticalJustifications _verticalJustification)
Constructor.
-
-
Method Detail
-
getFormat
public PbNumericDisplayFormat getFormat()
Gets a reference to aPbNumericDisplayFormat
object for the numeric display format for the values.
-
getClassNodekitCatalog
public static SoNodekitCatalog getClassNodekitCatalog()
Returns theSoNodekitCatalog
for this class.
-
setFormat
public void setFormat(PbNumericDisplayFormat format)
Sets a reference to aPbNumericDisplayFormat
object for the numeric display format for the values. If this method is not called (or called passing NULL as argument), this is the numeric display format defined in the current inherited state (defined with the property nodePoNumericDisplayFormat
) which is used.
-
-