Click or drag to resize
PoMeshContouring Class

Class to build contour lines on a 2D mesh.

Inheritance Hierarchy

Namespace: OIV.MeshViz.Data
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class PoMeshContouring : PoMesh2D

The PoMeshContouring type exposes the following members.

Constructors
  NameDescription
Public methodPoMeshContouring

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoBaseKit.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodCreatePathToPart(String, Boolean)
Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr).
(Inherited from SoBaseKit.)
Public methodCreatePathToPart(String, Boolean, SoPath)

Returns a path that begins at this nodekit and ends at partName.

(Inherited from SoBaseKit.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoBaseKit.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

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.)
Public methodGetBoundingBox
(Inherited from SoBaseKit.)
Public methodStatic memberGetClassNodekitCatalog

Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.

Public methodGetDataMapping

Returns the current OIV.MeshViz.Graph.PbDataMapping object.

(Inherited from PoMesh.)
Public methodGetDomain

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.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetFormat
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetIsovaluesList

Returns the current OIV.MeshViz.Graph.PbIsovaluesList object.

(Inherited from PoMesh.)
Public methodGetMatrix
(Inherited from SoBaseKit.)
Public methodGetMesh

Gets the current surface mesh.

(Inherited from PoMesh2D.)
Public methodGetMiscTextAttr

Gets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object.

Public methodGetModuleDataMapping

Returns the current OIV.MeshViz.Graph.PbDataMapping object for the association color-vectors module.

(Inherited from PoMesh.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNodekitCatalog (Inherited from SoBaseKit.)
Public methodGetPart

Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

(Inherited from SoBaseKit.)
Public methodGetPartString

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.)
Public methodGetPrimitiveCount
(Inherited from SoBaseKit.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUpdateMethod

Gets update method.

(Inherited from PoBase.)
Public methodGetViewportIsEnabled (Inherited from SoBaseKit.)
Public methodGetViewportOrigin (Inherited from SoBaseKit.)
Public methodGetViewportSize (Inherited from SoBaseKit.)
Public methodGLRender
(Inherited from SoBaseKit.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoBaseKit.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal.

(Inherited from SoBaseKit.)
Public methodIsBuilt

Indicates if the node kit has been built at least once.

(Inherited from PoBase.)
Public methodIsModified

Return true, if the kit has been modified, else otherwise.

(Inherited from PoBase.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoBaseKit.)
Public methodRebuild

Forces the node kit to be rebuilt immediately.

(Inherited from PoBase.)
Public methodSearch
(Inherited from SoBaseKit.)
Public methodSet(String)

This function allows field values of parts (nodes) to be set in several different parts simultaneously.

(Inherited from SoBaseKit.)
Public methodSet(String, String)

This function allows field values of parts (nodes) to be set.

(Inherited from SoBaseKit.)
Public methodSetDataMapping

Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object for the association color-value.

(Inherited from PoMesh.)
Public methodSetDomain

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.)
Public methodSetFormat

Sets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format for annotations of contour lines.

Public methodSetIsovaluesList

Sets a reference to a OIV.MeshViz.Graph.PbIsovaluesList object to define a list of isovalues.

(Inherited from PoMesh.)
Public methodSetMesh(PbMesh)

Sets a reference to a OIV.MeshViz.Data.PbMesh object.

(Inherited from PoMesh.)
Public methodSetMesh(PbMesh2D)

Defines the current surface mesh.

(Inherited from PoMesh2D.)
Public methodSetMiscTextAttr

Sets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object for miscellaneous text attributes of annotations of contour lines.

Public methodSetModuleDataMapping

Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object for the association color-vectors module.

(Inherited from PoMesh.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetPart

Inserts the given node (not a copy) as the new part specified by partName.

(Inherited from SoBaseKit.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodSetUpdateMethod

Sets scene graph update method.

(Inherited from PoBase.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodTouchKit

Indicates the node kit is modified.

(Inherited from PoBase.)
Public methodWrite
(Inherited from SoBaseKit.)
Top
Properties
  NameDescription
Public propertyannotClippingPolygon

This is a polygon where no annotations are present outside it.

Public propertyannotCrossStatus

Controls the annotations and contour lines crossing.

Public propertyannotFontFactor

Font size factor of annotations of contour lines.

Public propertyannotFontSize

Font size of annotations of contour lines.

Public propertyannotGap

Curvilinear distance between two annotations of a same contour line.

Public propertyannotIsBackground

Defines if the annotations are framed by a background.

Public propertyannotIsContourClip

Defines if the contour lines are clipped by the annotations.

Public propertyannotIsVisible

Contour lines annotations visibility.

Public propertyannotPath

Annotations path.

Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoBaseKit.)
Public propertycoloringType

Defines the type of method used to color each mesh element, mesh edge or mesh contour line of a representation.

(Inherited from PoMesh.)
Public propertycreaseAngle

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.)
Public propertyfirstMajor

Defines the first major contour lines.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymajorPeriod

Defines the major and the minor contour lines.

Public propertymoduleDataMapping

Field used to do coloring according the module of the vectors.

(Inherited from PoMesh.)
Public propertysmoothTextureContouring

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.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertyvaluesIndex

Defines the index of the set of values for the coloring.

(Inherited from PoMesh.)
Public propertyvaluesIndexForCellFilter

Specifies the index of the set of values used to filter cells for this mesh representation.

(Inherited from PoMesh.)
Public propertyvecsIndex

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.)
Public propertyzValuesIndex

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
  NameDescription
Public eventPostRebuild
(Inherited from PoBase.)
Public eventPreRebuild
(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><b>PoMeshContouring</b> {</ul> <ul><ul><b>Separator</b> <tt>alternateRep</tt> (from PoBase) {<br /> </ul></ul> <ul><ul><ul><b>AppearanceKit</b> <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</i></ul></ul></ul> <ul><ul><ul><b>MatrixTransform</b> <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the domain transformation.</i></ul></ul></ul> <ul><ul><ul><b>Separator</b> <tt>majorContourLineSep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw major contour lines.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>majorContourLineApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of major contour lines.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>majorContourLine</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw major contour lines.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <b>Separator</b> <tt>minorContourLineSep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw minor contour lines.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>minorContourLineApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of minor contour lines.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>minorContourLine</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw minor contour lines.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>annotBackgroundSep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw background of annotations.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>annotBackgroundApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of background of annotations.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>annotBackground</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoFaceSet shape to draw background of annotations.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>annotBackgroundBorderSep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw background border of annotations.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>annotBackgroundBorderApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of background border of annotations.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>annotBackgroundBorder</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw background border of annotations.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>annotTextSep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw the text of annotations.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>annotTexApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>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.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>annotText</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shapes to draw the text of annotations.</i></ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul><br /> </ul></ul> </body> </html>

See Also