PoMeshContouring

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.data.Po3DdataMaster
        
        com.openinventor.meshviz.data.PoMesh
        
        com.openinventor.meshviz.data.PoMesh2D
        
        com.openinventor.meshviz.data.PoMeshContouring

All Implemented Interfaces:: SafeDisposable, SoGetView

public class PoMeshContouring
extends PoMesh2D

Class to build contour lines on a 2D mesh. Builds contour lines on a 2D mesh. These contour lines are computed from a level values list and the nodes scalar values of the mesh. The level value list is defined by the PoMesh.setIsovaluesList() method or by the current PoIsovaluesList node during the traversal.

All contour lines can have the same color (PoMesh.coloringType = COLOR_INHERITED) or can have a color depending on the values of the contouring lines (PoMesh.coloringType != COLOR_INHERITED).

Contour lines are separated into 2 groups: major contour lines which can be annotated by their value, and minor contour lines which cannot be annotated. Major contour line are defined by the value of fields majorPeriod and firstMajor. They are annotated only if the field annotIsVisible is true. The way of putting annotations along contour lines is defined by the value of the fields annotPath, annotCrossStatus, annotGap and annotClippingPolygon.

When the annotation are visible, the way of drawing the text of the level values depends on the current numeric display format and also on the current miscellaneous text attributes. 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). 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).

Note: Contour line annotations are not displayed if the mesh is not defined in the XY plane. For example, if a 2D mesh is defined as follows: X coordinates are constant, Y coordinates vary, and Z coordinates vary, (and zValuesIndex set with a value different from -1), the contour lines will be not annotated. In order to annotate contour lines for a mesh not defined in the XY plane, define it in the XY plane and apply a rotation.

File format/default:

PoMeshContouring {

valuesIndex	-1
coloringType	COLOR_INHERITED
zValuesIndex	-1
vecsIndex	-1
valuesIndexForCellFilter	-1
moduleDataMapping	NULL
majorPeriod	3
firstMajor	1
annotIsVisible	false
annotPath	TANGENTIAL_PATH
annotCrossStatus	CROSS_CONTOUR
annotIsBackground	false
annotIsContourClip	false
annotGap	1
annotClippingPolygon	0 0
annotFontSize	0

}

<!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="Heading1009">CATALOG PARTS</A></h4> <ul>PoMeshContouring {</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.</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>Separator <tt>majorContourLineSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw major contour lines.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>majorContourLineApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of major contour lines.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>majorContourLine</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw major contour lines.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>minorContourLineSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw minor contour lines.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>minorContourLineApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of minor contour lines.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>minorContourLine</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw minor contour lines.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>annotBackgroundSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw background of annotations.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>annotBackgroundApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of background of annotations.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>annotBackground</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw background of annotations.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>annotBackgroundBorderSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw background border of annotations.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>annotBackgroundBorderApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of background border of annotations.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>annotBackgroundBorder</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw background border of annotations.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>annotTextSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the text of annotations.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>annotTexApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the text of annotations. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>annotText</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shapes to draw the text of annotations.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul> </ul></ul> </body> </html>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PoMeshContouring.AnnotCrossStatusType` Controls the annotations of contour lines.
`static class`	`PoMeshContouring.AnnotPaths` Type of annotations path.

Nested classes/interfaces inherited from class com.openinventor.meshviz.data.PoMesh
PoMesh.ColoringTypes

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
`SoMFVec2f`	`annotClippingPolygon` This is a polygon where no annotations are present outside it.
`SoSFEnum<PoMeshContouring.AnnotCrossStatusType>`	`annotCrossStatus` Controls the annotations and contour lines crossing.
`SoSFFloat`	`annotFontFactor` Font size factor of annotations of contour lines.
`SoSFFloat`	`annotFontSize` Font size of annotations of contour lines.
`SoSFFloat`	`annotGap` Curvilinear distance between two annotations of a same contour line.
`SoSFBool`	`annotIsBackground` Defines if the annotations are framed by a background.
`SoSFBool`	`annotIsContourClip` Defines if the contour lines are clipped by the annotations.
`SoSFBool`	`annotIsVisible` Contour lines annotations visibility.
`SoSFEnum<PoMeshContouring.AnnotPaths>`	`annotPath` Annotations path.
`static int`	`CROSS_CONTOUR` Deprecated. Use `PoMeshContouring.AnnotCrossStatusType.CROSS_CONTOUR` instead.
`static int`	`CROSS_MINOR_CONTOUR` Deprecated. Use `PoMeshContouring.AnnotCrossStatusType.CROSS_MINOR_CONTOUR` instead.
`static int`	`DONT_CROSS_CONTOUR` Deprecated. Use `PoMeshContouring.AnnotCrossStatusType.DONT_CROSS_CONTOUR` instead.
`SoSFUShort`	`firstMajor` Defines the first major contour lines.
`static int`	`HORIZONTAL_PATH` Deprecated. Use `PoMeshContouring.AnnotPaths.HORIZONTAL_PATH` instead.
`SoSFUShort`	`majorPeriod` Defines the major and the minor contour lines.
`static int`	`TANGENTIAL_PATH` Deprecated. Use `PoMeshContouring.AnnotPaths.TANGENTIAL_PATH` instead.
`static int`	`VERTICAL_PATH` Deprecated. Use `PoMeshContouring.AnnotPaths.VERTICAL_PATH` instead.

Fields inherited from class com.openinventor.meshviz.data.PoMesh2D
zValuesIndex

Fields inherited from class com.openinventor.meshviz.data.PoMesh
COLOR_AVERAGE, COLOR_CONTOURING, COLOR_INHERITED, COLOR_MAPPING, COLOR_TEXTURE_CONTOURING, coloringType, creaseAngle, moduleDataMapping, smoothTextureContouring, valuesIndex, valuesIndexForCellFilter, vecsIndex

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

PoMeshContouring()
Constructor.

Constructors
Constructor and Description
`PoMeshContouring()` 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 the reference to a `PbNumericDisplayFormat`.
`PbMiscTextAttr`	`getMiscTextAttr()` Gets a reference to `PbMiscTextAttr` object.
`void`	`setFormat(PbNumericDisplayFormat format)` Sets a reference to a `PbNumericDisplayFormat` object for the numerical display format for annotations of contour lines.
`void`	`setMiscTextAttr(PbMiscTextAttr textAttr)` Sets a reference to `PbMiscTextAttr` object for miscellaneous text attributes of annotations of contour lines.

Methods inherited from class com.openinventor.meshviz.data.PoMesh2D
getMesh, setMesh

Methods inherited from class com.openinventor.meshviz.data.PoMesh
getDataMapping, getIsovaluesList, getModuleDataMapping, setDataMapping, setIsovaluesList, setMesh, setModuleDataMapping

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
 - TANGENTIAL_PATH
```
@Deprecated
public static final int TANGENTIAL_PATH
```
 Deprecated. Use PoMeshContouring.AnnotPaths.TANGENTIAL_PATH instead.
 - HORIZONTAL_PATH
```
@Deprecated
public static final int HORIZONTAL_PATH
```
 Deprecated. Use PoMeshContouring.AnnotPaths.HORIZONTAL_PATH instead.
 - VERTICAL_PATH
```
@Deprecated
public static final int VERTICAL_PATH
```
 Deprecated. Use PoMeshContouring.AnnotPaths.VERTICAL_PATH instead.
 - CROSS_CONTOUR
```
@Deprecated
public static final int CROSS_CONTOUR
```
 Deprecated. Use PoMeshContouring.AnnotCrossStatusType.CROSS_CONTOUR instead.
 - CROSS_MINOR_CONTOUR
```
@Deprecated
public static final int CROSS_MINOR_CONTOUR
```
 Deprecated. Use PoMeshContouring.AnnotCrossStatusType.CROSS_MINOR_CONTOUR instead.
 - DONT_CROSS_CONTOUR
```
@Deprecated
public static final int DONT_CROSS_CONTOUR
```
 Deprecated. Use PoMeshContouring.AnnotCrossStatusType.DONT_CROSS_CONTOUR instead.
 - majorPeriod
```
public final SoSFUShort majorPeriod
```
 Defines the major and the minor contour lines. majorPeriod is the period of major contour lines. Only major contour lines can be annotated. See also firstMajor. By default, majorPeriod = 3.
 - firstMajor
```
public final SoSFUShort firstMajor
```
 Defines the first major contour lines. See also majorPeriod. By default, firstMajor = 1.
 - annotIsVisible
```
public final SoSFBool annotIsVisible
```
 Contour lines annotations visibility. By default, annotIsVisible = false
 - annotPath
```
public final SoSFEnum<PoMeshContouring.AnnotPaths> annotPath
```
 Annotations path.
 - TANGENTIAL_PATH, annotations are tangential to the contour lines.
 - HORIZONTAL_PATH, annotations are horizontal.
 - VERTICAL_PATH, annotations are vertical.
 By default, annotPath = TANGENTIAL_PATH.
 - annotCrossStatus
```
public final SoSFEnum<PoMeshContouring.AnnotCrossStatusType> annotCrossStatus
```
 Controls the annotations and contour lines crossing.
 - CROSS_CONTOUR, annotations may cross contour lines.
 - CROSS_MINOR_CONTOUR, annotations may cross only minor contour lines (but not major contour lines).
 - DONT_CROSS_CONTOUR annotations do not cross any contour lines.
 By default, annotCrossStatus = CROSS_CONTOUR.
 Note that annotations may always cross the annotated contour line, however this field prevents annotations from crossing other contour lines.
 - annotIsBackground
```
public final SoSFBool annotIsBackground
```
 Defines if the annotations are framed by a background. By default, annotIsBackground = false
 - annotIsContourClip
```
public final SoSFBool annotIsContourClip
```
 Defines if the contour lines are clipped by the annotations. By default, annotIsContourClip = false
 - annotGap
```
public final SoSFFloat annotGap
```
 Curvilinear distance between two annotations of a same contour line. It is a multiplicative factor of the domain size or of the clipping polygon size (if it is defined). The distance used is equal to annotGap * Ds, where Ds is the max of the width and the height of the domain or of the polygon. By default, annotGap = 1.
 - annotClippingPolygon
```
public final SoMFVec2f annotClippingPolygon
```
 This is a polygon where no annotations are present outside it. If the point list is empty, the mesh limits will be used instead. By default, annotClippingPolygon = (0,0)
 - annotFontSize
```
public final SoSFFloat annotFontSize
```
 Font size of annotations of contour lines. This value is a multiplicative factor of the domain size or of the clipping polygon size (if it is defined). The font size used is equal to annotFontSize * Ds, where Ds is the max of the width and the height of the domain or of the clipping polygon. If this value is <= 0, the annotations font size is fixed at 0.04. By default, annotFontSize = 0.
 - annotFontFactor
```
public final SoSFFloat annotFontFactor
```
 Font size factor of annotations of contour lines. This field is only interpreted when an SoProjection node is applicable to contouring. By default, annotFontFactor = 1.
- Constructor Detail
 - PoMeshContouring
```
public PoMeshContouring()
```
 Constructor.
- Method Detail
 - setMiscTextAttr
```
public void setMiscTextAttr(PbMiscTextAttr textAttr)
```
 Sets a reference to PbMiscTextAttr object for miscellaneous text attributes of annotations of contour lines. If this method is not called the text attributes used are those of the default constructor of PbMiscTextAttr.
 - getClassNodekitCatalog
```
public static SoNodekitCatalog getClassNodekitCatalog()
```
 Returns the SoNodekitCatalog for this class.
 - getFormat
```
public PbNumericDisplayFormat getFormat()
```
 Gets the reference to a PbNumericDisplayFormat. See setFormat.
 - getMiscTextAttr
```
public PbMiscTextAttr getMiscTextAttr()
```
 Gets a reference to PbMiscTextAttr object. See setMiscTextAttr.
 - setFormat
```
public void setFormat(PbNumericDisplayFormat format)
```
 Sets a reference to a PbNumericDisplayFormat object for the numerical display format for annotations of contour lines. If this method is not called the format used is the one of the default constructor of PbNumericDisplayFormat.

Class PoMeshContouring

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.meshviz.data.PoMesh

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

Fields inherited from class com.openinventor.meshviz.data.PoMesh

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

Methods inherited from class com.openinventor.meshviz.data.PoMesh

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

TANGENTIAL_PATH

HORIZONTAL_PATH

VERTICAL_PATH

CROSS_CONTOUR

CROSS_MINOR_CONTOUR

DONT_CROSS_CONTOUR

majorPeriod

firstMajor

annotIsVisible

annotPath

annotCrossStatus

annotIsBackground

annotIsContourClip

annotGap

annotClippingPolygon

annotFontSize

annotFontFactor

Constructor Detail

PoMeshContouring

Method Detail

setMiscTextAttr

getClassNodekitCatalog

getFormat

getMiscTextAttr

setFormat