PoCurve Class Reference
[Curve]

Builds a 2D curve. More...

#include <MeshViz/graph/PoCurve.h>

Inheritance diagram for PoCurve:

List of all members.

Public Types
enum	FilterType {   INACTIVE,   ALL_POINTS,   INDEX_PERIOD,   INDEX_LIST,   X_PERIOD,   X_LIST }
enum	CurveRep {   CURVE_NONE,   CURVE_POLYLINE,   CURVE_SMOOTH,   CURVE_STAIRS_X,   CURVE_STAIRS_Y,   CURVE_HISTO_X,   CURVE_HISTO_Y,   CURVE_STAIRS_2X,   CURVE_STAIRS_2Y }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoCurve ()
	PoCurve (int numPoints, const SbVec2f *_point, CurveRep _curveRep=CURVE_POLYLINE)
virtual void	rebuild ()
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoMFVec2f	point
SoSFEnum	curveRep
SoSFBool	isCurveFilled
SoSFFloat	fillingThreshold
SoSFEnum	markerFilterType
SoSFInt32	markerIndexPeriod
SoMFInt32	markerIndexList
SoSFFloat	markerXPeriod
SoMFFloat	markerXList
SoSFString	markerString
SoSFEnum	raiseFilterType
SoSFInt32	raiseIndexPeriod
SoMFInt32	raiseIndexList
SoSFFloat	raiseXPeriod
SoMFFloat	raiseXList
SoSFFloat	raiseThreshold

---

Detailed Description

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

}

CATALOG PARTS

PoCurve {
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 curveFillingSep {
Contains properties and shapes to fill the curve.
AppearanceKit curveFillingApp
Specifies the appearance of filling curve.
Group curveFilling
Contains a SoFaceSet shape to fill the curve.
}

Separator curvePointSep {
Contains properties and shapes to draw the curve.
AppearanceKit curvePointApp
Specifies the appearance of the curve.
Group curvePoint
Contains a SoLineSet shape to draw the curve.
}

Separator markerSep {
Contains properties and shapes to draw the markers on the curve.
AppearanceKit markerApp
Specifies the appearance of markers. If markerString != ".", the font used for markers is the font set in font.name.
Group marker
Contains a list of SoText2 (markerString != ".") or SoPointSet (markerString = ".") shapes to draw the markers.
}

Separator raisePointSep {
Contains properties and shapes to draw the raise points on the curve.
AppearanceKit raisePointApp
Specifies the appearance of raise points.
Group raisePoint
Contains a SoLineSet shape to draw the raise points.
}
}
}

---

Member Enumeration Documentation

enum PoCurve::CurveRep

Curve representation.

Enumerator:

CURVE_NONE	No curve is built.
CURVE_POLYLINE	The curve is a sequence of straight lines linking all points.
CURVE_SMOOTH	The curve is a smoothing passing through all points.
CURVE_STAIRS_X	Stair curve passing through all points.
CURVE_STAIRS_Y	Stair curve passing through all points.
CURVE_HISTO_X	Stair curve no necessarily passing through all points.
CURVE_HISTO_Y	Stair curve no necessarily passing through all points.
CURVE_STAIRS_2X	Double stair curve.
CURVE_STAIRS_2Y	Double stair curve.

enum PoCurve::FilterType

Filter type.

Enumerator:

INACTIVE	Filter is inactive.
ALL_POINTS	All points of point are selected.
INDEX_PERIOD	One point of point in every indexPeriod is selected.
INDEX_LIST	A list of points of point is selected by their indices.
X_PERIOD	One point of computed curve points is selected in every xPeriod.
X_LIST	A list of points of computed curve points are selected by a list of abscises.

---

Constructor & Destructor Documentation

PoCurve::PoCurve

(

)

[inline]

Default constructor.

PoCurve::PoCurve	(	int	numPoints,
		const SbVec2f *	_point,
		CurveRep	_curveRep = CURVE_POLYLINE
	)			[inline]

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoCurve::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoGraphMaster.

static SoType PoCurve::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoGraphMaster.

virtual const SoNodekitCatalog* PoCurve::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoGraphMaster.

virtual SoType PoCurve::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoGraphMaster.

virtual void PoCurve::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoSFEnum PoCurve::curveRep

Defines the curve representation (polyline, smooth, stair, .

..)

SoSFFloat PoCurve::fillingThreshold

Defines the threshold to fill the curve.

SoSFBool PoCurve::isCurveFilled

Indicates if the curve is filled or not.

SoSFEnum PoCurve::markerFilterType

Defines the type of marker filter.

This value determines which filter is active (markerIndexPeriod or markerIndexList,...)

SoMFInt32 PoCurve::markerIndexList

A list of points (of point) is selected by their indices.

SoSFInt32 PoCurve::markerIndexPeriod

One point (of point) in every consecutive markerIndexPeriod is selected.

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

SoMFFloat PoCurve::markerXList

A list of points (of the computed curve points) is selected by their abscises.

SoSFFloat PoCurve::markerXPeriod

One point (of the computed curve points) in every markerXPeriod is selected.

SoMFVec2f PoCurve::point

Point list of the curve.

SoSFEnum PoCurve::raiseFilterType

Defines the type of raise filter.

This value determines which filter is active (raiseIndexPeriod or raiseIndexList,...)

SoMFInt32 PoCurve::raiseIndexList

A list of points (of point) is selected by their indices.

SoSFInt32 PoCurve::raiseIndexPeriod

One point (of point) in every consecutive raiseIndexPeriod is selected.

SoSFFloat PoCurve::raiseThreshold

Raise points are vertical lines joining the curve points and the specified threshold.

SoMFFloat PoCurve::raiseXList

A list of points (of the computed curve points) is selected by their abscises.

SoSFFloat PoCurve::raiseXPeriod

One point (of the computed curve points) in every raiseXPeriod is selected.

---

The documentation for this class was generated from the following file:
• MeshViz/graph/PoCurve.h