PoLabelField

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

All Implemented Interfaces:

SafeDisposable, SoGetView
```
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:
PoLabelField {
}
<!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>PoLabelField {</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 and drawStyle.style=LINES. font.size is set to the field fontSize.</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><ul></ul></ul></ul></ul> <ul><ul><ul>Group <tt>labelField</tt></ul></ul></ul> <ul><ul><ul>Contains a list of SoAnnoText3 shapes.</ul></ul></ul> <ul><ul>}</ul></ul> <ul>} </ul> </body> </html>

Nested Class Summary

Nested Classes
Modifier and Type	Class and 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.Inventor
Inventor.ConstructorCommand

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BASE` Deprecated. Use `PoLabelField.VerticalJustifications.BASE` instead.
`static int`	`BOTTOM` Deprecated. Use `PoLabelField.VerticalJustifications.BOTTOM` instead.
`static int`	`CAP` Deprecated. Use `PoLabelField.VerticalJustifications.CAP` instead.
`static int`	`CENTER` Deprecated. Use `PoLabelField.Justifications.CENTER` instead.
`SoSFEnum<PoLabelField.ConcatTypes>`	`concatType` Concatenation type between values and strings.
`static int`	`COORDINATE_IN_CURRENT_UNIT` Deprecated. Use `PoLabelField.CoordinateTypes.COORDINATE_IN_CURRENT_UNIT` instead.
`static int`	`COORDINATE_IN_DOMAIN` Deprecated. Use `PoLabelField.CoordinateTypes.COORDINATE_IN_DOMAIN` instead.
`SoSFEnum<PoLabelField.CoordinateTypes>`	`coordinateType` Type of coordinates.
`SoSFFloat`	`fontSize` Font size for strings to display.
`static int`	`HALF` Deprecated. Use `PoLabelField.VerticalJustifications.HALF` instead.
`SoSFEnum<PoLabelField.Justifications>`	`justification` Horizontal justification.
`static int`	`LEFT` Deprecated. Use `PoLabelField.Justifications.LEFT` instead.
`SoMFVec2f`	`point` List of points which are the coordinates of the strings.
`static int`	`RIGHT` Deprecated. Use `PoLabelField.Justifications.RIGHT` instead.
`SoMFString`	`string` List of strings to display.
`static int`	`STRING_ABOVE_VALUE` Deprecated. Use `PoLabelField.ConcatTypes.STRING_ABOVE_VALUE` instead.
`static int`	`STRING_BEFORE_VALUE` Deprecated. Use `PoLabelField.ConcatTypes.STRING_BEFORE_VALUE` instead.
`static int`	`TOP` Deprecated. Use `PoLabelField.VerticalJustifications.TOP` instead.
`SoMFFloat`	`value` List of values to display.
`static int`	`VALUE_ABOVE_STRING` Deprecated. Use `PoLabelField.ConcatTypes.VALUE_ABOVE_STRING` instead.
`static int`	`VALUE_BEFORE_STRING` Deprecated. Use `PoLabelField.ConcatTypes.VALUE_BEFORE_STRING` instead.
`SoSFEnum<PoLabelField.VerticalJustifications>`	`verticalJustification` Vertical justification.

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

Constructor Summary

Constructors
Constructor and 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 and Description
`static SoNodekitCatalog`	`getClassNodekitCatalog()` Returns the `SoNodekitCatalog` for this class.
`PbNumericDisplayFormat`	`getFormat()` Gets a reference to a `PbNumericDisplayFormat` object for the numeric display format for the values.
`void`	`setFormat(PbNumericDisplayFormat format)` Sets a reference to a `PbNumericDisplayFormat` 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, 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
 - LEFT
```
@Deprecated
public static final int LEFT
```
 Deprecated. Use PoLabelField.Justifications.LEFT instead.
 - RIGHT
```
@Deprecated
public static final int RIGHT
```
 Deprecated. Use PoLabelField.Justifications.RIGHT instead.
 - CENTER
```
@Deprecated
public static final int CENTER
```
 Deprecated. Use PoLabelField.Justifications.CENTER instead.
 - TOP
```
@Deprecated
public static final int TOP
```
 Deprecated. Use PoLabelField.VerticalJustifications.TOP instead.
 - CAP
```
@Deprecated
public static final int CAP
```
 Deprecated. Use PoLabelField.VerticalJustifications.CAP instead.
 - HALF
```
@Deprecated
public static final int HALF
```
 Deprecated. Use PoLabelField.VerticalJustifications.HALF instead.
 - BASE
```
@Deprecated
public static final int BASE
```
 Deprecated. Use PoLabelField.VerticalJustifications.BASE instead.
 - BOTTOM
```
@Deprecated
public static final int BOTTOM
```
 Deprecated. Use PoLabelField.VerticalJustifications.BOTTOM instead.
 - COORDINATE_IN_DOMAIN
```
@Deprecated
public static final int COORDINATE_IN_DOMAIN
```
 Deprecated. Use PoLabelField.CoordinateTypes.COORDINATE_IN_DOMAIN instead.
 - COORDINATE_IN_CURRENT_UNIT
```
@Deprecated
public static final int COORDINATE_IN_CURRENT_UNIT
```
 Deprecated. Use PoLabelField.CoordinateTypes.COORDINATE_IN_CURRENT_UNIT instead.
 - STRING_BEFORE_VALUE
```
@Deprecated
public static final int STRING_BEFORE_VALUE
```
 Deprecated. Use PoLabelField.ConcatTypes.STRING_BEFORE_VALUE instead.
 - VALUE_BEFORE_STRING
```
@Deprecated
public static final int VALUE_BEFORE_STRING
```
 Deprecated. Use PoLabelField.ConcatTypes.VALUE_BEFORE_STRING instead.
 - STRING_ABOVE_VALUE
```
@Deprecated
public static final int STRING_ABOVE_VALUE
```
 Deprecated. Use PoLabelField.ConcatTypes.STRING_ABOVE_VALUE instead.
 - VALUE_ABOVE_STRING
```
@Deprecated
public static final int VALUE_ABOVE_STRING
```
 Deprecated. Use PoLabelField.ConcatTypes.VALUE_ABOVE_STRING instead.
 - 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.
- Constructor Detail
 - 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)
```
 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,
 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 a PbNumericDisplayFormat object for the numeric display format for the values.
 - 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 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 node PoNumericDisplayFormat) which is used.

point	0 0
string	""
value	0
concatType	STRING_BEFORE_VALUE
fontSize	1
justification	LEFT
verticalJustification	BASE
coordinateType	COORDINATE_IN_CURRENT_UNIT

Class PoLabelField

Nested Class Summary

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

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

Field Summary

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

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

LEFT

RIGHT

CENTER

TOP

CAP

HALF

BASE

BOTTOM

COORDINATE_IN_DOMAIN

COORDINATE_IN_CURRENT_UNIT

STRING_BEFORE_VALUE

VALUE_BEFORE_STRING

STRING_ABOVE_VALUE

VALUE_ABOVE_STRING

point

string

value

concatType

fontSize

justification

verticalJustification

coordinateType

Constructor Detail

PoLabelField

PoLabelField

PoLabelField

PoLabelField

PoLabelField

Method Detail

getFormat

getClassNodekitCatalog

setFormat