PoCurve

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

All Implemented Interfaces:: SafeDisposable

public class PoCurve
extends PoGraphMaster

Builds a 2D curve. Class to build a curve in the plane XY. The curve is defined by a set of points. Different representations of the curve can be obtained, such as polyline curve, smooth curve, stair curve or double stair curve. The curve can be filled. Furthermore, some filters control the appearance of markers (on the curve) and raise points (vertical lines from the curve to a threshold).

File format/default:

PoCurve {

point	0 0
curveRep	CURVE_POLYLINE
fillingThreshold	0.0
isCurveFilled	false
markerFilterType	INACTIVE
markerIndexPeriod	0
markerIndexList	0
markerXPeriod	0
markerXList	0
markerString	"."
raiseFilterType	INACTIVE
raiseIndexPeriod	0
raiseIndexList	0
raiseXPeriod	0
raiseXList	0
raiseThreshold	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="Heading346">CATALOG PARTS</A></h4> <ul>PoCurve {</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><ul></ul></ul></ul></ul> <ul><ul><ul>Separator <tt>curveFillingSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to fill the curve.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>curveFillingApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of filling curve.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>curveFilling</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to fill the curve.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>curvePointSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the curve.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>curvePointApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the curve.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>curvePoint</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw the curve.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>markerSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the markers on the curve.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>markerApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of markers. If markerString != ".", the font used for markers is the font set in font.name.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>marker</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoText2 (markerString != ".") or SoPointSet (markerString = ".") shapes to draw the markers.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>raisePointSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the raise points on the curve.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>raisePointApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of raise points.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>raisePoint</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw the raise points.</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 PoCurve.CurveReps
Curve representation.

static class PoCurve.FilterTypes
Filter type.
- 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`PoCurve.CurveReps` Curve representation.
`static class`	`PoCurve.FilterTypes` Filter type.

Field Summary

Fields
Modifier and Type	Field and Description
`SoSFEnum<PoCurve.CurveReps>`	`curveRep` Defines the curve representation (polyline, smooth, stair, ...)
`SoSFFloat`	`fillingThreshold` Defines the threshold to fill the curve.
`SoSFBool`	`isCurveFilled` Indicates if the curve is filled or not.
`SoSFEnum<PoCurve.FilterTypes>`	`markerFilterType` Defines the type of marker filter.
`SoMFInt32`	`markerIndexList` A list of points (of point) is selected by their indices.
`SoSFInt32`	`markerIndexPeriod` One point (of point) in every consecutive markerIndexPeriod is selected.
`SoSFString`	`markerString` The markers are defined by a string.
`SoMFFloat`	`markerXList` A list of points (of the computed curve points) is selected by their abscises.
`SoSFFloat`	`markerXPeriod` One point (of the computed curve points) in every markerXPeriod is selected.
`SoMFVec2f`	`point` Point list of the curve.
`SoSFEnum<PoCurve.FilterTypes>`	`raiseFilterType` Defines the type of raise filter.
`SoMFInt32`	`raiseIndexList` A list of points (of point) is selected by their indices.
`SoSFInt32`	`raiseIndexPeriod` One point (of point) in every consecutive raiseIndexPeriod is selected.
`SoSFFloat`	`raiseThreshold` Raise points are vertical lines joining the curve points and the specified threshold.
`SoMFFloat`	`raiseXList` A list of points (of the computed curve points) is selected by their abscises.
`SoSFFloat`	`raiseXPeriod` One point (of the computed curve points) in every raiseXPeriod is selected.

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
`PoCurve()` Default constructor.
`PoCurve(SbVec2f[] _point)` Calls PoCurve(_point, PoCurve.CurveReps.valueOf( PoCurve.CurveReps.CURVE_POLYLINE.getValue() )).
`PoCurve(SbVec2f[] _point, PoCurve.CurveReps _curveRep)` 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, 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
 - point
```
public final SoMFVec2f point
```
 Point list of the curve.
 - curveRep
```
public final SoSFEnum<PoCurve.CurveReps> curveRep
```
 Defines the curve representation (polyline, smooth, stair, ...)
 - isCurveFilled
```
public final SoSFBool isCurveFilled
```
 Indicates if the curve is filled or not.
 - fillingThreshold
```
public final SoSFFloat fillingThreshold
```
 Defines the threshold to fill the curve.
 - markerFilterType
```
public final SoSFEnum<PoCurve.FilterTypes> markerFilterType
```
 Defines the type of marker filter. This value determines which filter is active (markerIndexPeriod or markerIndexList,...)
 - markerIndexPeriod
```
public final SoSFInt32 markerIndexPeriod
```
 One point (of point) in every consecutive markerIndexPeriod is selected.
 - markerIndexList
```
public final SoMFInt32 markerIndexList
```
 A list of points (of point) is selected by their indices.
 - markerXPeriod
```
public final SoSFFloat markerXPeriod
```
 One point (of the computed curve points) in every markerXPeriod is selected.
 - markerXList
```
public final SoMFFloat markerXList
```
 A list of points (of the computed curve points) is selected by their abscises.
 - markerString
```
public final SoSFString markerString
```
 The markers are defined by a string. If this field is equal to ".", the markers are SoPointSet shapes, otherwise SoText2 shapes. To change the font of text markers, set the catalog part markerApp.font.name. Be careful, in this version, text markers are not vertically aligned.
 - raiseFilterType
```
public final SoSFEnum<PoCurve.FilterTypes> raiseFilterType
```
 Defines the type of raise filter. This value determines which filter is active (raiseIndexPeriod or raiseIndexList,...)
 - raiseIndexPeriod
```
public final SoSFInt32 raiseIndexPeriod
```
 One point (of point) in every consecutive raiseIndexPeriod is selected.
 - raiseIndexList
```
public final SoMFInt32 raiseIndexList
```
 A list of points (of point) is selected by their indices.
 - raiseXPeriod
```
public final SoSFFloat raiseXPeriod
```
 One point (of the computed curve points) in every raiseXPeriod is selected.
 - raiseXList
```
public final SoMFFloat raiseXList
```
 A list of points (of the computed curve points) is selected by their abscises.
 - raiseThreshold
```
public final SoSFFloat raiseThreshold
```
 Raise points are vertical lines joining the curve points and the specified threshold.
- Constructor Detail
 - PoCurve
```
public PoCurve(SbVec2f[] _point)
```
 Calls PoCurve(_point, PoCurve.CurveReps.valueOf( PoCurve.CurveReps.CURVE_POLYLINE.getValue() )).
 - PoCurve
```
public PoCurve(SbVec2f[] _point,
 PoCurve.CurveReps _curveRep)
```
 Constructor.
 - PoCurve
```
public PoCurve()
```
 Default constructor.
- Method Detail
 - getClassNodekitCatalog
```
public static SoNodekitCatalog getClassNodekitCatalog()
```
 Returns the SoNodekitCatalog for this class.

Class PoCurve

Nested Class Summary

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

point

curveRep

isCurveFilled

fillingThreshold

markerFilterType

markerIndexPeriod

markerIndexList

markerXPeriod

markerXList

markerString

raiseFilterType

raiseIndexPeriod

raiseIndexList

raiseXPeriod

raiseXList

raiseThreshold

Constructor Detail

PoCurve

PoCurve

PoCurve

Method Detail

getClassNodekitCatalog