PoMeshContouring Class

Class to build contour lines on a 2D mesh.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodekitsSoBaseKit
              OIV.MeshViz.GraphPoBase
                OIV.MeshViz.DataPo3DdataMaster
                  OIV.MeshViz.DataPoMesh
                    OIV.MeshViz.DataPoMesh2D
                      OIV.MeshViz.DataPoMeshContouring

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

Syntax

C++

Copy

public class PoMeshContouring : PoMesh2D

Public Class PoMeshContouring
	Inherits PoMesh2D

public ref class PoMeshContouring : public PoMesh2D

type PoMeshContouring =  
    class
        inherit PoMesh2D
    end

The PoMeshContouring type exposes the following members.

Constructors

	Name	Description
	PoMeshContouring	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.
	GetDataMapping	Returns the current OIV.MeshViz.Graph.PbDataMapping object. (Inherited from PoMesh.)
	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.)
	GetFormat	Gets the reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat.
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetIsovaluesList	Returns the current OIV.MeshViz.Graph.PbIsovaluesList object. (Inherited from PoMesh.)
	GetMatrix	(Inherited from SoBaseKit.)
	GetMesh	Gets the current surface mesh. (Inherited from PoMesh2D.)
	GetMiscTextAttr	Gets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object.
	GetModuleDataMapping	Returns the current OIV.MeshViz.Graph.PbDataMapping object for the association color-vectors module. (Inherited from PoMesh.)
	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.)
	SetDataMapping	Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object for the association color-value. (Inherited from PoMesh.)
	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.)
	SetFormat	Sets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format for annotations of contour lines.
	SetIsovaluesList	Sets a reference to a OIV.MeshViz.Graph.PbIsovaluesList object to define a list of isovalues. (Inherited from PoMesh.)
	SetMesh(PbMesh)	Sets a reference to a OIV.MeshViz.Data.PbMesh object. (Inherited from PoMesh.)
	SetMesh(PbMesh2D)	Defines the current surface mesh. (Inherited from PoMesh2D.)
	SetMiscTextAttr	Sets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object for miscellaneous text attributes of annotations of contour lines.
	SetModuleDataMapping	Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object for the association color-vectors module. (Inherited from PoMesh.)
	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
	annotClippingPolygon	This is a polygon where no annotations are present outside it.
	annotCrossStatus	Controls the annotations and contour lines crossing.
	annotFontFactor	Font size factor of annotations of contour lines.
	annotFontSize	Font size of annotations of contour lines.
	annotGap	Curvilinear distance between two annotations of a same contour line.
	annotIsBackground	Defines if the annotations are framed by a background.
	annotIsContourClip	Defines if the contour lines are clipped by the annotations.
	annotIsVisible	Contour lines annotations visibility.
	annotPath	Annotations path.
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoBaseKit.)
	coloringType	Defines the type of method used to color each mesh element, mesh edge or mesh contour line of a representation. (Inherited from PoMesh.)
	creaseAngle	Indicates the minimum angle (in radians) between two adjacent face normals required to form a sharp crease at the edge when default normals are computed and used. (Inherited from PoMesh.)
	firstMajor	Defines the first major contour lines.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	majorPeriod	Defines the major and the minor contour lines.
	moduleDataMapping	Field used to do coloring according the module of the vectors. (Inherited from PoMesh.)
	smoothTextureContouring	If set to true and combined with COLOR_TEXTURE_CONTOURING coloring type, the texture used for coloring appears smoothed, since a linear interpolation is used instead of a nearest one. (Inherited from PoMesh.)
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)
	valuesIndex	Defines the index of the set of values for the coloring. (Inherited from PoMesh.)
	valuesIndexForCellFilter	Specifies the index of the set of values used to filter cells for this mesh representation. (Inherited from PoMesh.)
	vecsIndex	Defines the index of the set of vectors for all representations which need a vector at each mesh node (OIV.MeshViz.Data.PoBaseStreamLine, OIV.MeshViz.Data.PoMesh2DVec, OIV.MeshViz.Data.PoMesh3DVec,...) (Inherited from PoMesh.)
	zValuesIndex	Defines the index of the set of values used by a representation as a z-coordinate of each mesh node (-1 by default). (Inherited from PoMesh2D.)

Top

Events

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

Top

Remarks

Builds contour lines on a 2D mesh. These contour lines are computed from a level values list and the nodes scalar values of the mesh. The level value list is defined by the OIV.MeshViz.Data.PoMesh.SetIsovaluesList(OIV.MeshViz.Graph.PbIsovaluesList) method or by the current OIV.MeshViz.Nodes.PoIsovaluesList node during the traversal.

All contour lines can have the same color (OIV.MeshViz.Data.PoMesh.coloringType = COLOR_INHERITED) or can have a color depending on the values of the contouring lines (OIV.MeshViz.Data.PoMesh.coloringType != COLOR_INHERITED).

Contour lines are separated into 2 groups: major contour lines which can be annotated by their value, and minor contour lines which cannot be annotated. Major contour line are defined by the value of fields majorPeriod and firstMajor. They are annotated only if the field annotIsVisible is true. The way of putting annotations along contour lines is defined by the value of the fields annotPath, annotCrossStatus, annotGap and annotClippingPolygon.

When the annotation are visible, the way of drawing the text of the level values depends on the current numeric display format and also on the current miscellaneous text attributes. If the method setFormat(format) is called, the current numerical display format is "format". Otherwise the current numerical display format is specified in the current inherited state (cf property node OIV.MeshViz.Nodes.PoNumericDisplayFormat). If the method setMiscTextAttr(textAttr) is called, the current miscellaneous text attributes are defined by "textAttr". Otherwise the current miscellaneous text attributes are specified in the current inherited state (cf property node OIV.MeshViz.Nodes.PoMiscTextAttr).

Note: Contour line annotations are not displayed if the mesh is not defined in the XY plane. For example, if a 2D mesh is defined as follows: X coordinates are constant, Y coordinates vary, and Z coordinates vary, (and zValuesIndex set with a value different from -1), the contour lines will be not annotated. In order to annotate contour lines for a mesh not defined in the XY plane, define it in the XY plane and apply a rotation.

FILE FORMAT/DEFAULT

OIV.MeshViz.Data.PoMeshContouring {
valuesIndex -1
coloringType COLOR_INHERITED
zValuesIndex -1
vecsIndex -1
valuesIndexForCellFilter -1
moduleDataMapping NULL
majorPeriod 3
firstMajor 1
annotIsVisible false
annotPath TANGENTIAL_PATH
annotCrossStatus CROSS_CONTOUR
annotIsBackground false
annotIsContourClip false
annotGap 1
annotClippingPolygon 0 0
annotFontSize 0
}

<html> <head> <title></title> </head> <body> <h1></h1> <h4> <A NAME="Heading1009">CATALOG PARTS</A></h4> <ul>PoMeshContouring {</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>majorContourLineSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw major contour lines.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>majorContourLineApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of major contour lines.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>majorContourLine</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw major contour lines.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>minorContourLineSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw minor contour lines.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>minorContourLineApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of minor contour lines.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>minorContourLine</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw minor contour lines.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>annotBackgroundSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw background of annotations.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>annotBackgroundApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of background of annotations.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>annotBackground</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw background of annotations.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>annotBackgroundBorderSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw background border of annotations.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>annotBackgroundBorderApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of background border of annotations.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>annotBackgroundBorder</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw background border of annotations.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>annotTextSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the text of annotations.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>annotTexApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the text of annotations. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>annotText</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shapes to draw the text of annotations.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul> </ul></ul> </body> </html>

Reference

OIV.MeshViz.Data Namespace

valuesIndex	-1
coloringType	COLOR_INHERITED
zValuesIndex	-1
vecsIndex	-1
valuesIndexForCellFilter	-1
moduleDataMapping	NULL
majorPeriod	3
firstMajor	1
annotIsVisible	false
annotPath	TANGENTIAL_PATH
annotCrossStatus	CROSS_CONTOUR
annotIsBackground	false
annotIsContourClip	false
annotGap	1
annotClippingPolygon	0 0
annotFontSize	0