PoErrorCurve Class Reference
[Curve ]
Class to build an error curve represention.
More...
#include <MeshViz/graph/PoErrorCurve.h >
List of all members.
Public Types
enum VariationType {
FIXED_VARIATION ,
REL_VARIATION ,
PERCENT_FIXED_VARIATION ,
PERCENT_REL_VARIATION
}
enum ErrorCurveRep {
HIGH_LOW_CLOSE ,
LINE_BAR ,
FILLED
}
Public Member Functions
virtual SoType getTypeId () const
virtual const SoNodekitCatalog * getNodekitCatalog () const
PoErrorCurve ()
PoErrorCurve (int numPoints, const SbVec2f *_point, const float *_lowY, const float *_highY, VariationType type=REL_VARIATION, ErrorCurveRep rep=HIGH_LOW_CLOSE)
virtual void rebuild ()
Static Public Member Functions
static SoType getClassTypeId ()
static const SoNodekitCatalog * getClassNodekitCatalog ()
Public Attributes
SoMFVec2f point
SoMFFloat lowY
SoMFFloat highY
SoSFEnum variationType
SoSFEnum errorCurveRep
Detailed Description
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 { }
The catalog part interpretation depends on errorCurveRep field.
- HIGH_LOW_CLOSE representation (the groups errorCurve3, errorCurve4 and
errorCurve 4 are set to NULL):
Separator alternateRep (from PoBase) {
AppearanceKit appearance (from
PoBase)
Specifies the appearance of all the kit. By default
lightModel.model=BASE_COLOR.
MatrixTransform domainTransform (from
PoBase)
Corresponds to the domain transformation.
Separator errorCurve1Sep {
Contains properties and shapes to draw the close
bars.
AppearanceKit errorCurve1App
Specifies the appearance of the close
bars.
Contains a SoLineSet shape to draw the close
bars.
}
Separator errorCurve2Sep {
Contains properties and shapes to draw vertical
lines.
AppearanceKit errorCurve2App
Specifies the appearance of vertical
lines.
Contains a SoLineSet shape to draw vertical
lines.
- LINE_BAR representation (the groups errorCurve5 is set to NULL):
Separator alternateRep (from PoBase) {
AppearanceKit appearance (from
PoBase)
Specifies the appearance of all the kit. By default
lightModel.model=BASE_COLOR.
MatrixTransform domainTransform (from
PoBase)
Corresponds to the domain transformation.
Separator errorCurve1Sep {
Contains properties and shapes to draw points.
AppearanceKit errorCurve1App
Specifies the appearance of points.
Contains a SoLineSet shape to draw
points.
}
Separator errorCurve2Sep {
Contains properties and shapes to draw horizontal lower
lines.
AppearanceKit errorCurve2App
Specifies the appearance of horizontal lower
lines.
Contains a SoLineSet shape to draw horizontal lower
lines.
}
Separator errorCurve3Sep {
Contains properties and shapes to draw horizontal upper
lines.
AppearanceKit errorCurve3App
Specifies the appearance of horizontal upper
lines.
Contains a SoLineSet shape to draw horizontal upper
lines.
}
Separator errorCurve4Sep {
Contains properties and shapes to draw vertical
lines.
AppearanceKit errorCurve4App
Specifies the appearance of vertical
lines.
Contains a SoLineSet shape to draw vertical
lines.
Separator alternateRep (from PoBase) {
AppearanceKit appearance (from
PoBase)
Specifies the appearance of all the kit. By default
lightModel.model=BASE_COLOR.
MatrixTransform domainTransform (from
PoBase)
Corresponds to the domain transformation.
Separator errorCurve1Sep {
Contains properties and shapes to draw lower
part.
AppearanceKit errorCurve1App
Specifies the appearance of lower
part.
Contains a SoFaceSet shape to draw lower
part.
}
Separator errorCurve2Sep {
Contains properties and shapes to draw upper
part.
AppearanceKit errorCurve2App
Specifies the appearance of upper
part.
Contains a SoFaceSet shape to draw upper
part.
}
Separator errorCurve3Sep {
Contains properties and shapes to draw lower
curve.
AppearanceKit errorCurve3App
Specifies the appearance of lower
curve.
Contains a SoLineSet shape to draw lower
curve.
}
Separator errorCurve4Sep {
Contains properties and shapes to draw middle
curve.
AppearanceKit errorCurve4App
Specifies the appearance of middle
curve.
Contains a SoLineSet shape to draw middle
curve.
}
Separator errorCurve5Sep {
Contains properties and shapes to draw upper
curve.
AppearanceKit errorCurve5App
Specifies the appearance of upper
curve.
Contains a SoLineSet shape to draw upper
curve.
Member Enumeration Documentation
Type of error curve representation.
Enumerator:
HIGH_LOW_CLOSE
The error curve is a high low close representation.
LINE_BAR
The error curve is a line bar representation.
FILLED
The error curve is a filled representation.
Type of interpretation of the fields lowY and highY.
Enumerator:
FIXED_VARIATION
REL_VARIATION
PERCENT_FIXED_VARIATION
PERCENT_REL_VARIATION
Constructor & Destructor Documentation
PoErrorCurve::PoErrorCurve
(
)
[inline]
PoErrorCurve::PoErrorCurve
(
int
numPoints ,
const SbVec2f *
_point ,
const float *
_lowY ,
const float *
_highY ,
VariationType
type = REL_VARIATION
,
ErrorCurveRep
rep = HIGH_LOW_CLOSE
)
[inline]
Member Function Documentation
static const SoNodekitCatalog * PoErrorCurve::getClassNodekitCatalog
(
)
[static]
static SoType PoErrorCurve::getClassTypeId
(
)
[static]
Returns the type identifier for this class.
Reimplemented from PoGraphMaster .
virtual const SoNodekitCatalog * PoErrorCurve::getNodekitCatalog
(
)
const [virtual]
virtual SoType PoErrorCurve::getTypeId
(
)
const [virtual]
Returns the type identifier for this specific instance.
Reimplemented from PoGraphMaster .
virtual void PoErrorCurve::rebuild
(
)
[virtual]
Forces node-kit rebuilding.
See PoBase .
Reimplemented from PoBase .
Member Data Documentation
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).
List of the high ordinates for the high curve.
The number of high ordinates must be equal to the number of points of point.
List of the low ordinates for the low curve.
The number of low ordinates must be equal to the number of points of point.
List of coordinates of the error curve.
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.
The documentation for this class was generated from the following file: