PoLabel

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.PoChart
        
        com.openinventor.meshviz.graph.PoLabel

All Implemented Interfaces:: SafeDisposable, SoGetView

public class PoLabel
extends PoChart

Class to build a label field. Builds a 2D label field on 1D mesh (PoIrregularMesh1D or PoRegularMesh1D). The abscissas of the labels are given by the geometry of the current mesh 1D, and the ordinates are given by one of the value-set of the current mesh 1D specified by the field yValuesIndex. Names attached to each label are given by one of the string-set of the current mesh 1D specified by the field stringsIndex.

The fields position, threshold and offset allows the user to set the label position and the field valueType set the values to display as labels. This class also takes into account of the current mesh 1D hints (PoMesh1DHints), and the current mesh 1D filter (PoMesh1DFilter) to filter the geometry of the current mesh 1D. The current label hints (PoLabelHints) is used to specify the appearance of labels. If the offset is different from null and, if the field isLabelLineVisible of the current label hints is set to true then, a line representing the offset is drawn. All labels depend on the current miscellaneous text attributes which defines the font names, line length and so on (PoMiscTextAttr). All numerical values depend on the current numerical display format (PoNumericDisplayFormat).

The interpretation of colorBinding is the following :

INHERITED: All labels are colored with the same inherited color.
PER_PART, PER_VERTEX: A color is used for each label.

File format/default:

PoLabel {

colorBinding	INHERITED
yValuesIndex	-1
colorValuesIndex	1
material	NULL
stringsIndex	0
axis	X
valueType	VALUE
position	VALUE_POS
threshold	0.
offset	0. 0. 0.
fontSize	0.0

}

<html> <head> <link REL="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta name="GENERATOR" content="Microsoft FrontPage 3.0"> <title></title> </head> <body> <h4><a name="Heading249">CATALOG PARTS</a></h4> <blockquote> PoLabel { </blockquote> <blockquote> <blockquote> Separator <tt>alternateRep</tt> (from PoBase) { </blockquote> <blockquote> <blockquote> AppearanceKit <tt>appearance</tt> (from PoBase) </blockquote> </blockquote> <blockquote> <blockquote> Specifies the appearance of all the kit. By default lightModel.model=PHONG. </blockquote> </blockquote> <blockquote> <blockquote> MatrixTransform <tt>domainTransform</tt> (from PoBase) </blockquote> </blockquote> <blockquote> <blockquote> Corresponds to the domain transformation. Group <tt>label</tt> </blockquote> </blockquote> <blockquote> <blockquote> Contains a list of couple SoMaterial and SoText3/SoAnnoText3/SoAsciiText (cf PoBase.setTextType() and PoBase.setVRML2Mode() for choosing the text type) if the field colorBinding is different from INHERITED, a list of SoText3/SoAnnoText3/SoAsciiText otherwise. Separator <tt>labelLineSep</tt> { Contains properties and shapes to draw the label lines.<ul> AppearanceKit <tt>labelLineApp</tt> </ul> <ul> Specifies the appearance of the label lines. </ul> <ul> Group <tt>labelLine</tt> </ul> <ul> Contains a SoLineSet shape to draw the label lines. </ul> } </blockquote> } </blockquote> </blockquote> <blockquote> } </blockquote> </body> </html>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PoLabel.AxisType` values computation.
`static class`	`PoLabel.Positions` Position of the labels.
`static class`	`PoLabel.ValueTypes` Type of value displayed by the labels.

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

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
`SoSFEnum<PoLabel.AxisType>`	`axis` Defines from which axis the position and type of displayed values computation is done.
`SoSFFloat`	`fontSize` Font size of labels.
`static int`	`MIDDLE_POS` Deprecated. Use `PoLabel.Positions.MIDDLE_POS` instead.
`static int`	`NAME` Deprecated. Use `PoLabel.ValueTypes.NAME` instead.
`SoMFVec3f`	`offset` Defines an offset applied to the label.
`SoSFEnum<PoLabel.Positions>`	`position` Defines the position of the labels.
`SoSFInt32`	`stringsIndex` Defines the index of the set of strings used for the names attached to labels when valueType is equal to NAME.
`SoSFFloat`	`threshold` Defines the threshold used to the set position of the label.
`static int`	`THRESHOLD_POS` Deprecated. Use `PoLabel.Positions.THRESHOLD_POS` instead.
`static int`	`VALUE` Deprecated. Use `PoLabel.ValueTypes.VALUE` instead.
`static int`	`VALUE_POS` Deprecated. Use `PoLabel.Positions.VALUE_POS` instead.
`SoSFBitMask<PoLabel.ValueTypes>`	`valueType` Defines the type of values displayed by the labels.
`static int`	`X` Deprecated. Use `PoLabel.AxisType.X` instead.
`static int`	`Y` Deprecated. Use `PoLabel.AxisType.Y` instead.

Fields inherited from class com.openinventor.meshviz.graph.PoChart
colorBinding, colorValuesIndex, INHERITED, material, PER_PART, PER_VERTEX, yValuesIndex

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

PoLabel()
Constructor.

Constructors
Constructor and Description
`PoLabel()` Constructor.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static SoNodekitCatalog getClassNodekitCatalog()
Returns the SoNodekitCatalog for this class.
- 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

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static SoNodekitCatalog`	`getClassNodekitCatalog()` Returns the `SoNodekitCatalog` for this class.

- Field Detail
 - VALUE
```
@Deprecated
public static final int VALUE
```
 Deprecated. Use PoLabel.ValueTypes.VALUE instead.
 - NAME
```
@Deprecated
public static final int NAME
```
 Deprecated. Use PoLabel.ValueTypes.NAME instead.
 - VALUE_POS
```
@Deprecated
public static final int VALUE_POS
```
 Deprecated. Use PoLabel.Positions.VALUE_POS instead.
 - MIDDLE_POS
```
@Deprecated
public static final int MIDDLE_POS
```
 Deprecated. Use PoLabel.Positions.MIDDLE_POS instead.
 - THRESHOLD_POS
```
@Deprecated
public static final int THRESHOLD_POS
```
 Deprecated. Use PoLabel.Positions.THRESHOLD_POS instead.
 - X
```
@Deprecated
public static final int X
```
 Deprecated. Use PoLabel.AxisType.X instead.
 - Y
```
@Deprecated
public static final int Y
```
 Deprecated. Use PoLabel.AxisType.Y instead.
 - stringsIndex
```
public final SoSFInt32 stringsIndex
```
 Defines the index of the set of strings used for the names attached to labels when valueType is equal to NAME. If the field value is negative, no names is attached to labels.
 - axis
```
public final SoSFEnum<PoLabel.AxisType> axis
```
 Defines from which axis the position and type of displayed values computation is done. All values in brackets correspond to the Y-axis.
 - valueType
```
public final SoSFBitMask<PoLabel.ValueTypes> valueType
```
 Defines the type of values displayed by the labels. There are two ways to display the labels :
 - VALUE: The values displayed correspond to the the ordinates (resp. abscissas) of the current mesh 1D geometry.
 - NAME: The values displayed correspond to the names associated to the strings-set specified by the field stringsIndex.
 - position
```
public final SoSFEnum<PoLabel.Positions> position
```
 Defines the position of the labels. There are three ways to define this position :
 - VALUE_POS: The label position is the given by the current mesh geometry.
 - MIDDLE_POS: The abscissas (resp. ordinate) is given by the current mesh geometry and the ordinate (resp. abscissas) is at the middle between the mesh ordinate (reps. abscissas) and a threshold.
 - THRESHOLD_POS: The abscissas (resp. ordinate) is given by the current mesh geometry and the ordinate (resp. abscissas) is the threshold field.
 - threshold
```
public final SoSFFloat threshold
```
 Defines the threshold used to the set position of the label.
 - offset
```
public final SoMFVec3f offset
```
 Defines an offset applied to the label. This offset is combinated with the label position. If the number of offsets is inferior to the number of labels, they are cyclically used.
 - fontSize
```
public final SoSFFloat fontSize
```
 Font size of labels. If this value is less or equal to 0, the font size is fixed at 0.04. This value is a percentage of the current domain (cf PoBase description).
- Constructor Detail
 - PoLabel
```
public PoLabel()
```
 Constructor.
- Method Detail
 - getClassNodekitCatalog
```
public static SoNodekitCatalog getClassNodekitCatalog()
```
 Returns the SoNodekitCatalog for this class.

Class PoLabel

Nested Class Summary

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

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

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

VALUE

NAME

VALUE_POS

MIDDLE_POS

THRESHOLD_POS

X

Y

stringsIndex

axis

valueType

position

threshold

offset

fontSize

Constructor Detail

PoLabel

Method Detail

getClassNodekitCatalog