com.openinventor.meshviz.graph.PoErrorCurve

All Implemented Interfaces:: SafeDisposable

public class PoErrorCurve extends PoGraphMaster

Class to build an error curve represention. Class to build an error curve in the plane XY. An error curve is a curve (defined by a point list) with a low curve and a high curve which represent the error.

File format/default:

PoErrorCurve {

point	0 0
lowY	0
highY	0
variationType	REL_VARIATION
errorCurveRep	HIGH_LOW_CLOSE

}

<!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="Heading373">CATALOG PARTS</A></h4> <ul>The catalog part interpretation depends on errorCurveRep field. - HIGH_LOW_CLOSE representation (the groups errorCurve3, errorCurve4 and errorCurve 4 are set to NULL): </ul> <ul>PoErrorCurve {</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>errorCurve1Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the close bars.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve1App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the close bars.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve1</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw the close bars.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>errorCurve2Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw vertical lines.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve2App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of vertical lines.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve2</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw vertical lines.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul></ul></ul> <ul>- LINE_BAR representation (the groups errorCurve5 is set to NULL): </ul> <ul>PoErrorCurve {</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>errorCurve1Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw points.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve1App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of points.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve1</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw points.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>errorCurve2Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw horizontal lower lines.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve2App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of horizontal lower lines.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve2</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw horizontal lower lines.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>errorCurve3Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw horizontal upper lines.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve3App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of horizontal upper lines.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve3</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw horizontal upper lines.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>errorCurve4Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw vertical lines.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve4App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of vertical lines.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve4</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw vertical lines.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul></ul></ul> <ul>- FILLED representation: </ul> <ul>PoErrorCurve {</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>errorCurve1Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw lower part.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve1App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of lower part.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve1</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw lower part.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>errorCurve2Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw upper part.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve2App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of upper part.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve2</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw upper part.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>errorCurve3Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw lower curve.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve3App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of lower curve.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve3</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw lower curve.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>errorCurve4Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw middle curve.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve4App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of middle curve.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve4</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw middle curve.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>errorCurve5Sep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw upper curve.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>errorCurve5App</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of upper curve.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>errorCurve5</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw upper curve.</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

Description

static enum

PoErrorCurve.ErrorCurveReps

Type of error curve representation.

static enum

PoErrorCurve.VariationTypes

Type of interpretation of the fields lowY and highY.

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

Description

final SoSFEnum<PoErrorCurve.ErrorCurveReps>

errorCurveRep

Defines the error curve representation.

final SoMFFloat

highY

List of the high ordinates for the high curve.

final SoMFFloat

lowY

List of the low ordinates for the low curve.

final SoMFVec2f

point

List of coordinates of the error curve.

final SoSFEnum<PoErrorCurve.VariationTypes>

variationType

Defines the interpretation of the values lowY and highY.

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

Description

PoErrorCurve()

Default constructor.

PoErrorCurve(SbVec2f[] _point, float[] _lowY, float[] _highY)

Calls PoErrorCurve(_point, _lowY, _highY, PoErrorCurve.VariationTypes.valueOf( PoErrorCurve.VariationTypes.REL_VARIATION.getValue() ), PoErrorCurve.ErrorCurveReps.valueOf( PoErrorCurve.ErrorCurveReps.HIGH_LOW_CLOSE.getValue() )).

PoErrorCurve(SbVec2f[] _point, float[] _lowY, float[] _highY, PoErrorCurve.VariationTypes type)

Calls PoErrorCurve(_point, _lowY, _highY, type, PoErrorCurve.ErrorCurveReps.valueOf( PoErrorCurve.ErrorCurveReps.HIGH_LOW_CLOSE.getValue() )).

PoErrorCurve(SbVec2f[] _point, float[] _lowY, float[] _highY, PoErrorCurve.VariationTypes type, PoErrorCurve.ErrorCurveReps rep)

Constructor.
Method Summary

Modifier and Type

Method

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

Field Details
- point
 
 public final SoMFVec2f point
 
 List of coordinates of the error curve.
- lowY
 
 public final SoMFFloat lowY
 
 List of the low ordinates for the low curve. The number of low ordinates must be equal to the number of points of point.
- highY
 
 public final SoMFFloat highY
 
 List of the high ordinates for the high curve. The number of high ordinates must be equal to the number of points of point.
- variationType
 
 public final SoSFEnum<PoErrorCurve.VariationTypes> variationType
 Defines the interpretation of the values lowY and highY. The ordinate yl of the i-th point of the low curve depends on the value of this field:
 
 FIXED_VARIATION: yl = lowY[i]
 
 REL_VARIATION: yl = point[i][1] - lowY[i]
 
 PERCENT_FIXED_VARIATION: yl = point[i][1] * lowY[i]
 
 PERCENT_REL_VARIATION: yl = point[i][1] - (lowY[i] * point[i][1])
 
 The same method is used to compute yh, the ordinate of the i-th point of the high curve.
- errorCurveRep
 
 public final SoSFEnum<PoErrorCurve.ErrorCurveReps> errorCurveRep
 
 Defines the error curve representation. There are three types of representations: high low close representation (HIGH_LOW_CLOSE), line bar representation (LINE_BAR) and filling representation (FILLED).
Constructor Details
- PoErrorCurve
  
  public PoErrorCurve(SbVec2f[] _point, float[] _lowY, float[] _highY)
  
  Calls PoErrorCurve(_point, _lowY, _highY, PoErrorCurve.VariationTypes.valueOf( PoErrorCurve.VariationTypes.REL_VARIATION.getValue() ), PoErrorCurve.ErrorCurveReps.valueOf( PoErrorCurve.ErrorCurveReps.HIGH_LOW_CLOSE.getValue() )).
- PoErrorCurve
  
  public PoErrorCurve(SbVec2f[] _point, float[] _lowY, float[] _highY, PoErrorCurve.VariationTypes type)
  
  Calls PoErrorCurve(_point, _lowY, _highY, type, PoErrorCurve.ErrorCurveReps.valueOf( PoErrorCurve.ErrorCurveReps.HIGH_LOW_CLOSE.getValue() )).
- PoErrorCurve
  
  public PoErrorCurve(SbVec2f[] _point, float[] _lowY, float[] _highY, PoErrorCurve.VariationTypes type, PoErrorCurve.ErrorCurveReps rep)
  
  Constructor.
- PoErrorCurve
  
  public PoErrorCurve()
  
  Default constructor.
Method Details
- getClassNodekitCatalog
  
  public static SoNodekitCatalog getClassNodekitCatalog()
  
  Returns the SoNodekitCatalog for this class.

Class PoErrorCurve

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 Details

point

lowY

highY

variationType

errorCurveRep

Constructor Details

PoErrorCurve

PoErrorCurve

PoErrorCurve

PoErrorCurve

Method Details

getClassNodekitCatalog