PoCurve Class

PoCurve Class

Builds a 2D curve.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodekitsSoBaseKit
              OIV.MeshViz.GraphPoBase
                OIV.MeshViz.GraphPoGraphMaster
                  OIV.MeshViz.GraphPoCurve

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 10.12.3.0 (10.12.3.0)

Syntax

C++

Copy

public class PoCurve : PoGraphMaster

Public Class PoCurve
	Inherits PoGraphMaster

public ref class PoCurve : public PoGraphMaster

type PoCurve =  
    class
        inherit PoGraphMaster
    end

The PoCurve type exposes the following members.

Constructors

	Name	Description
	PoCurve	Default constructor.
	PoCurve(SbVec2f)	Calls PoCurve(_point, OIV.MeshViz.Graph.PoCurve.CurveReps( .PoCurve.CURVE_POLYLINE )).
	PoCurve(SbVec2f, PoCurveCurveReps)	Constructor.

Top

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Inherited from SoNode.)
	Callback	(Inherited from SoBaseKit.)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	CreatePathToPart(String, Boolean)	Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.)
	CreatePathToPart(String, Boolean, SoPath)	Returns a path that begins at this nodekit and ends at partName. (Inherited from SoBaseKit.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Inherited from SoBaseKit.)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). (Inherited from SoNode.)
	GetBoundingBox	(Inherited from SoBaseKit.)
	GetClassNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.
	GetDomain	Gets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. (Inherited from PoBase.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoBaseKit.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. (Inherited from SoBaseKit.)
	GetPart	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. (Inherited from SoBaseKit.)
	GetPartString	Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part. (Inherited from SoBaseKit.)
	GetPrimitiveCount	(Inherited from SoBaseKit.)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUpdateMethod	Gets update method. (Inherited from PoBase.)
	GetViewportIsEnabled	(Inherited from SoBaseKit.)
	GetViewportOrigin	(Inherited from SoBaseKit.)
	GetViewportSize	(Inherited from SoBaseKit.)
	GLRender	(Inherited from SoBaseKit.)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoBaseKit.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. (Inherited from SoBaseKit.)
	IsBuilt	Indicates if the node kit has been built at least once. (Inherited from PoBase.)
	IsModified	Return true, if the kit has been modified, else otherwise. (Inherited from PoBase.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	(Inherited from SoBaseKit.)
	Rebuild	Forces the node kit to be rebuilt immediately. (Inherited from PoBase.)
	Search	(Inherited from SoBaseKit.)
	Set(String)	This function allows field values of parts (nodes) to be set in several different parts simultaneously. (Inherited from SoBaseKit.)
	Set(String, String)	This function allows field values of parts (nodes) to be set. (Inherited from SoBaseKit.)
	SetDomain	Sets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. (Inherited from PoBase.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetPart	Inserts the given node (not a copy) as the new part specified by partName. (Inherited from SoBaseKit.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	SetUpdateMethod	Sets scene graph update method. (Inherited from PoBase.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	TouchKit	Indicates the node kit is modified. (Inherited from PoBase.)
	Write	(Inherited from SoBaseKit.)

Top

Properties

	Name	Description
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoBaseKit.)
	curveRep	Defines the curve representation (polyline, smooth, stair, ...)
	fillingThreshold	Defines the threshold to fill the curve.
	isCurveFilled	Indicates if the curve is filled or not.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	markerFilterType	Defines the type of marker filter.
	markerIndexList	A list of points (of point) is selected by their indices.
	markerIndexPeriod	One point (of point) in every consecutive markerIndexPeriod is selected.
	markerString	The markers are defined by a string.
	markerXList	A list of points (of the computed curve points) is selected by their abscises.
	markerXPeriod	One point (of the computed curve points) in every markerXPeriod is selected.
	point	Point list of the curve.
	raiseFilterType	Defines the type of raise filter.
	raiseIndexList	A list of points (of point) is selected by their indices.
	raiseIndexPeriod	One point (of point) in every consecutive raiseIndexPeriod is selected.
	raiseThreshold	Raise points are vertical lines joining the curve points and the specified threshold.
	raiseXList	A list of points (of the computed curve points) is selected by their abscises.
	raiseXPeriod	One point (of the computed curve points) in every raiseXPeriod is selected.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Events

	Name	Description
	PostRebuild	(Inherited from PoBase.)
	PreRebuild	(Inherited from PoBase.)

Top

Remarks

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

OIV.MeshViz.Graph.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
}

<html> <head> <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>

Reference

OIV.MeshViz.Graph Namespace

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