PoMesh3DVec

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.PoMesh3D
        
        com.openinventor.meshviz.data.PoMesh3DVec

All Implemented Interfaces:: SafeDisposable

Direct Known Subclasses:: PoMesh3DVecCrossSection

public class PoMesh3DVec
extends PoMesh3D

Representation of vectors data of a volume mesh. Class to build a vectors field on a volume mesh. This class handles all vectors attributes. A vector is represented by an arrow made of 3 parts, the body, the start-shape and the end-shape. The body is a line or a cylinder starting from a node of the mesh. The start-shape is a pattern drawn at the node position. The end-shape is a pattern drawn at the other extremity of the body. Several type of pattern can be used to draw the shape. The 3 parts can be scaled and colored according to the value of the different fields of the class.

The current mesh is used for the representation of vectors. See PoMesh for more explanations about the current mesh. The vectors of the mesh to be drawn, are defined by the method addVecsSet of the current mesh (see PoMeshProperty or PbMesh), and by the field PoMesh.vecsIndex. The node of the mesh are used as start point of the representation of the vectors.

File format/default:

PoMesh3DVec {

density	1
eliminationStatus	NONE
minLength	0.0
maxLength	1E30
bodyShape	LINE
bodyLengthType	RELATIVE_LENGTH
bodyLengthFactor	1.0
bodyRadiusType	CONSTANT_RADIUS
bodyRadiusFactor	0.02
bodyColoringType	CONSTANT_COLOR
startArrowShape	NO_SHAPE
startArrowHeightType	RELATIVE_HEIGHT
startArrowHeightFactor	0.1
startArrowRadiusFactor	0.5
startArrowColoringType	CONSTANT_COLOR
endArrowShape	CHEVRON
endArrowHeightType	RELATIVE_HEIGHT
endArrowHeightFactor	0.1
endArrowRadiusFactor	0.5
endArrowColoringType	CONSTANT_COLOR
coloringType	COLOR_INHERITED
valuesIndex	-1
valuesIndexForCellFilter	-1
vecsIndex	-1
moduleDataMapping	NULL

}

<!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="Heading1082">CATALOG PARTS</A></h4> <ul>PoMesh3DVec {</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=PHONG.</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>Separator <tt>bodySep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes of the bodies of vectors.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>bodyApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the bodies.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>bodyGroup</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoLineSet or SoCylinder shape to draw vectors bodies.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>startArrowSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes of the start-shape of vectors.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>startArrowApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the start-shapes.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>startArrowGroup</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of nodes to draw the start arrow shapes.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>endArrowSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes of the end-shape of vectors.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>endArrowApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the end-shapes.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>endArrowGroup</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of nodes to draw the end arrow shapes.</ul></ul></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`	`PoMesh3DVec.ArrowColoringTypes` Type of arrow coloring.
`static class`	`PoMesh3DVec.ArrowHeightTypes` Type of height of an arrow.
`static class`	`PoMesh3DVec.ArrowShapes` Type of arrow shape.
`static class`	`PoMesh3DVec.BodyLengthTypes` Type of body lenght.
`static class`	`PoMesh3DVec.BodyRadiusTypes` Type of body radius.
`static class`	`PoMesh3DVec.BodyShapes` Type of body shape.
`static class`	`PoMesh3DVec.EliminationStatusType` Type of vector elimination.

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.nodes.SoNode
SoNode.RenderModes

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

Field Summary

Fields
Modifier and Type	Field and Description
`SoSFEnum<PoMesh3DVec.ArrowColoringTypes>`	`bodyColoringType` coloring method of the body.
`SoSFFloat`	`bodyLengthFactor` Length (or length multiplicative factor) of the body shape.
`SoSFEnum<PoMesh3DVec.BodyLengthTypes>`	`bodyLengthType` If bodyLengthType = CONSTANT_LENGTH, each vector has the same body length = bodyLengthFactor .
`SoSFFloat`	`bodyRadiusFactor` Radius (or radius multiplicative factor) of the cylinder.
`SoSFEnum<PoMesh3DVec.BodyRadiusTypes>`	`bodyRadiusType` Defines type of method to compute the cylinder's radius.
`SoSFEnum<PoMesh3DVec.BodyShapes>`	`bodyShape` Type of shape (no body, line, cylinder) used to draw the body.
`SoSFInt32`	`density` Vector field density filter.
`SoSFEnum<PoMesh3DVec.EliminationStatusType>`	`eliminationStatus` If eliminationStatus = TOO_SMALL, the vectors which module is lower than minLength are not drawn.
`SoSFEnum<PoMesh3DVec.ArrowColoringTypes>`	`endArrowColoringType` Coloring method of the end shape.
`SoSFFloat`	`endArrowHeightFactor` Height (or Height multiplicative factor) of the arrow shape.
`SoSFEnum<PoMesh3DVec.ArrowHeightTypes>`	`endArrowHeightType` Defines the type of method to compute the arrow height.
`SoSFFloat`	`endArrowRadiusFactor` The end-arrow's radius is end-arrow's height * endArrowRadiusFactor.
`SoSFEnum<PoMesh3DVec.ArrowShapes>`	`endArrowShape` Type of shape to be drawn at the end point of the body.
`SoSFFloat`	`maxLength` Maximum length of the vector to be drawn.
`SoSFFloat`	`minLength` Minimum length of the vector to be drawn.
`SoSFEnum<PoMesh3DVec.ArrowColoringTypes>`	`startArrowColoringType` Coloring method of the start shape.
`SoSFFloat`	`startArrowHeightFactor` Height (or Height multiplicative factor) of the arrow shape.
`SoSFEnum<PoMesh3DVec.ArrowHeightTypes>`	`startArrowHeightType` Defines the type of method to compute the arrow height.
`SoSFFloat`	`startArrowRadiusFactor` The start-arrow's radius is start-arrow's height * startArrowRadiusFactor.
`SoSFEnum<PoMesh3DVec.ArrowShapes>`	`startArrowShape` Type of shape to be drawn at the start point of the body.

Fields inherited from class com.openinventor.meshviz.data.PoMesh
coloringType, creaseAngle, moduleDataMapping, smoothTextureContouring, valuesIndex, valuesIndexForCellFilter, vecsIndex

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

PoMesh3DVec()
Constructor.

Constructors
Constructor and Description
`PoMesh3DVec()` 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.data.PoMesh3D
  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, 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
- 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
 - density
```
public final SoSFInt32 density
```
 Vector field density filter. If density = 1, each vector of the mesh is drawn. If density = 2, one vector every 2 vectors is drawn...
 - eliminationStatus
```
public final SoSFEnum<PoMesh3DVec.EliminationStatusType> eliminationStatus
```
 If eliminationStatus = TOO_SMALL, the vectors which module is lower than minLength are not drawn. If eliminationStatus = TOO_LONG, the vectors which module is greater than maxLength are not drawn. If eliminationStatus = TOO_SMALL_OR_LONG, the vectors which module is lower than minLength or greater than maxLength are not drawn. If eliminationStatus = NONE, each vector selected by the density filter is drawn.
 - minLength
```
public final SoSFFloat minLength
```
 Minimum length of the vector to be drawn. Only used when eliminationStatus is TOO_SMALL or TOO_SMALL_OR_LONG
 - maxLength
```
public final SoSFFloat maxLength
```
 Maximum length of the vector to be drawn. Only used when eliminationStatus is TOO_LONG or TOO_SMALL_OR_LONG
 - bodyShape
```
public final SoSFEnum<PoMesh3DVec.BodyShapes> bodyShape
```
 Type of shape (no body, line, cylinder) used to draw the body. If bodyShape = NO_BODY, the body of each vector is invisible.
 - bodyLengthType
```
public final SoSFEnum<PoMesh3DVec.BodyLengthTypes> bodyLengthType
```
 If bodyLengthType = CONSTANT_LENGTH, each vector has the same body length = bodyLengthFactor . If bodyLengthType = RELATIVE_LENGTH, the body length of a vector is bodyLengthFactor * vector-module.
 - bodyLengthFactor
```
public final SoSFFloat bodyLengthFactor
```
 Length (or length multiplicative factor) of the body shape.
 - bodyRadiusType
```
public final SoSFEnum<PoMesh3DVec.BodyRadiusTypes> bodyRadiusType
```
 Defines type of method to compute the cylinder's radius. If bodyRadiusType = CONSTANT_RADIUS, each vector has the same body radius = bodyRadiusFactor . If bodyRadiusType = RELATIVE_RADIUS, the body radius of a vector is bodyRadiusFactor * vector-module. The body radius is either a line-width or a cylinder-radius depending on the field's value bodyShape.
 - bodyRadiusFactor
```
public final SoSFFloat bodyRadiusFactor
```
 Radius (or radius multiplicative factor) of the cylinder.
 - bodyColoringType
```
public final SoSFEnum<PoMesh3DVec.ArrowColoringTypes> bodyColoringType
```
 coloring method of the body. If bodyColoringType = CONSTANT_COLOR, each vector has the same body color, which is the last found during the scene graph traversal.
 If bodyColoringType = MODULE_MAPPING_COLOR, the body's color of a vector depends on its module, and by using the current module-data-mapping (see PoMesh for explanation of the current module-data-mapping).
 If bodyColoringType = SCALAR_MAPPING_COLOR, the body's color of a vector depends on the scalar value at the mesh node used as the start point of the body. In this case, the current data-mapping is used to compute the color in relation to the scalar-value (see PoMesh for more explanations about the current data-mapping). .
 - startArrowShape
```
public final SoSFEnum<PoMesh3DVec.ArrowShapes> startArrowShape
```
 Type of shape to be drawn at the start point of the body. If startArrowShape = NO_SHAPE, the start-shape of each vector is invisible.
 - startArrowHeightType
```
public final SoSFEnum<PoMesh3DVec.ArrowHeightTypes> startArrowHeightType
```
 Defines the type of method to compute the arrow height. If startArrowHeightType = CONSTANT_HEIGHT, each vector has the same start-shape height = startArrowHeightFactor . If startArrowHeightType = RELATIVE_ HEIGHT, the end-shape height of a vector is startArrowHeightFactor * body's length.
 - startArrowHeightFactor
```
public final SoSFFloat startArrowHeightFactor
```
 Height (or Height multiplicative factor) of the arrow shape.
 - startArrowRadiusFactor
```
public final SoSFFloat startArrowRadiusFactor
```
 The start-arrow's radius is start-arrow's height * startArrowRadiusFactor.
 - startArrowColoringType
```
public final SoSFEnum<PoMesh3DVec.ArrowColoringTypes> startArrowColoringType
```
 Coloring method of the start shape. If startArrowColoringType = CONSTANT_COLOR, each vector has the same start-arrow's color, which is the last found during the scene graph traversal.
 If startArrowColoringType = MODULE_MAPPING_COLOR, the start-arrow's color of a vector depends on its module, and by using the current module-data- mapping (see PoMesh for explanation of the current module-data-mapping).
 If startArrowColoringType = SCALAR_MAPPING_COLOR, the start-arrow's color of a vector depends on the scalar value at the mesh node used as the start point of the start-arrow. In this case, the current data-mapping is used to compute the color in relation to the scalar-value (see PoMesh for more explanations about the current data-mapping).
 - endArrowShape
```
public final SoSFEnum<PoMesh3DVec.ArrowShapes> endArrowShape
```
 Type of shape to be drawn at the end point of the body. If endArrowShape = NO_SHAPE, the end-shape of each vector is invisible.
 - endArrowHeightType
```
public final SoSFEnum<PoMesh3DVec.ArrowHeightTypes> endArrowHeightType
```
 Defines the type of method to compute the arrow height. If endArrowHeightType = CONSTANT_HEIGHT, each vector has the same end-shape height = endArrowHeightFactor . If endArrowHeightType = RELATIVE_ HEIGHT, the end-shape height of a vector is endArrowHeightFactor * body's length.
 - endArrowHeightFactor
```
public final SoSFFloat endArrowHeightFactor
```
 Height (or Height multiplicative factor) of the arrow shape.
 - endArrowRadiusFactor
```
public final SoSFFloat endArrowRadiusFactor
```
 The end-arrow's radius is end-arrow's height * endArrowRadiusFactor.
 - endArrowColoringType
```
public final SoSFEnum<PoMesh3DVec.ArrowColoringTypes> endArrowColoringType
```
 Coloring method of the end shape. If endArrowColoringType = CONSTANT_COLOR, each vector has the same end-arrow's color, which is the last found during the scene graph traversal.
 If endArrowColoringType = MODULE_MAPPING_COLOR, the end-arrow's color of a vector depends on its module, and by using the current module-data- mapping (see PoMesh for explanation of the current module-data-mapping).
 If endArrowColoringType = SCALAR_MAPPING_COLOR, the end-arrow's color of a vector depends on the scalar value at the mesh node used as the end point of the end-arrow. In this case, the current data-mapping is used to compute the color in relation to the scalar-value (see PoMesh for more explanations about the current data-mapping).
- Constructor Detail
 - PoMesh3DVec
```
public PoMesh3DVec()
```
 Constructor.
- Method Detail
 - getClassNodekitCatalog
```
public static SoNodekitCatalog getClassNodekitCatalog()
```
 Returns the SoNodekitCatalog for this class.

Class PoMesh3DVec

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

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

Field Summary

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

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

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

density

eliminationStatus

minLength

maxLength

bodyShape

bodyLengthType

bodyLengthFactor

bodyRadiusType

bodyRadiusFactor

bodyColoringType

startArrowShape

startArrowHeightType

startArrowHeightFactor

startArrowRadiusFactor

startArrowColoringType

endArrowShape

endArrowHeightType

endArrowHeightFactor

endArrowRadiusFactor

endArrowColoringType

Constructor Detail

PoMesh3DVec

Method Detail

getClassNodekitCatalog