Click or drag to resize
PoMesh2DVec Class

Representation of vectors data of a surface 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 PoMesh2DVec : PoMesh2D

The PoMesh2DVec type exposes the following members.

Constructors
  NameDescription
Public methodPoMesh2DVec

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 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 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 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 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 propertybodyColoringType

coloring method of the body.

Public propertybodyLengthFactor

Length (or length multiplicative factor) of the body shape.

Public propertybodyLengthType

If bodyLengthType = CONSTANT_LENGTH, each vector has the same body length = bodyLengthFactor .

Public propertybodyRadiusFactor

Radius (or radius multiplicative factor) of the cylinder.

Public propertybodyRadiusType

Defines type of method to compute the cylinder's radius.

Public propertybodyShape

Type of shape (no body, line, cylinder) used to draw the body.

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 propertydensity

Vector field density filter.

Public propertyeliminationStatus

If eliminationStatus = TOO_SMALL, the vectors which module is lower than minLength are not drawn.

Public propertyendArrowColoringType

Coloring method of the end shape.

Public propertyendArrowHeightFactor

Height (or Height multiplicative factor) of the arrow shape.

Public propertyendArrowHeightType

Defines the type of method to compute the arrow height.

Public propertyendArrowRadiusFactor

The end-arrow's radius is end-arrow's height * endArrowRadiusFactor.

Public propertyendArrowShape

Type of shape to be drawn at the end point of the body.

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

Maximum length of the vector to be drawn.

Public propertyminLength

Minimum length of the vector to be drawn.

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 propertystartArrowColoringType

Coloring method of the start shape.

Public propertystartArrowHeightFactor

Height (or Height multiplicative factor) of the arrow shape.

Public propertystartArrowHeightType

Defines the type of method to compute the arrow height.

Public propertystartArrowRadiusFactor

The start-arrow's radius is start-arrow's height * startArrowRadiusFactor.

Public propertystartArrowShape

Type of shape to be drawn at the start point of the body.

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

Class to build a vectors field on a surface mesh. This class handles all vectors attributes. A vector is represented by an arrow made of 3 parts, the body, the start-shape and the end-shape. The body is a line or a cylinder starting from a node of the mesh. The start-shape is a pattern drawn at the node position. The end-shape is a pattern drawn at the other extremity of the body. Several type of pattern can be used to draw the shape. The 3 parts can be scaled and colored according to the value of the different fields of the class.

The current mesh is used for the representation of vectors. See OIV.MeshViz.Data.PoMesh for more explanations about the current mesh. The vectors of the mesh to be drawn, are defined by the method addVecsSet of the current mesh (see OIV.MeshViz.Nodes.PoMeshProperty, OIV.MeshViz.Data.PbMesh or OIV.MeshViz.Data.PbMesh2D), and by the field OIV.MeshViz.Data.PoMesh.vecsIndex. The node of the mesh are used as start point of the representation of the vectors.

FILE FORMAT/DEFAULT

OIV.MeshViz.Data.PoMesh2DVec {
density 1
eliminationStatus NONE
minLength 0.0
maxLength 1E30
bodyShape LINE
bodyLengthType RELATIVE_LENGTH
bodyLengthFactor 1.0
bodyRadiusType CONSTANT_RADIUS
bodyRadiusFactor 0.02
bodyColoringType CONSTANT_COLOR
startArrowShape NO_SHAPE
startArrowHeightType RELATIVE_HEIGHT
startArrowHeightFactor 0.1
startArrowRadiusFactor 0.5
startArrowColoringType CONSTANT_COLOR
endArrowShape CHEVRON
endArrowHeightType RELATIVE_HEIGHT
endArrowHeightFactor 0.1
endArrowRadiusFactor 0.5
endArrowColoringType CONSTANT_COLOR
coloringType COLOR_INHERITED
valuesIndex -1
valuesIndexForCellFilter -1
vecsIndex -1
moduleDataMapping NULL
zValuesIndex -1
}

<html> <head> <title></title> </head> <body> <h1></h1> <h4> <A NAME="Heading1018">CATALOG PARTS</A></h4> <ul><b>PoMesh2DVec</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=PHONG.</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><ul></ul></ul></ul></ul> <ul><ul><ul><b>Separator</b> <tt>bodySep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes of the bodies of vectors.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>bodyApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the bodies.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>bodyGroup</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoLineSet or SoCylinder shape to draw vectors bodies.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>startArrowSep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes of the start-shape of vectors.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>startArrowApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the start-shapes.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>startArrowGroup</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of nodes to draw the start arrow shapes.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>endArrowSep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes of the end-shape of vectors.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>endArrowApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the end-shapes.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>endArrowGroup</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of nodes to draw the end arrow shapes.</i></ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul><ul><br /> </ul></ul></ul> </body> </html>

See Also