PoMesh3DVec Class

PoMesh3DVec Class

Representation of vectors data of a volume 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.DataPoMesh3D
                      OIV.MeshViz.DataPoMesh3DVec
                        OIV.MeshViz.DataPoMesh3DVecCrossSection

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

Syntax

C++

Copy

public class PoMesh3DVec : PoMesh3D

Public Class PoMesh3DVec
	Inherits PoMesh3D

public ref class PoMesh3DVec : public PoMesh3D

type PoMesh3DVec =  
    class
        inherit PoMesh3D
    end

The PoMesh3DVec type exposes the following members.

Constructors

	Name	Description
	PoMesh3DVec	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.)
	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 volume mesh. (Inherited from PoMesh3D.)
	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.)
	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(PbMesh3D)	Defines the current volume mesh. (Inherited from PoMesh3D.)
	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
	bodyColoringType	coloring method of the body.
	bodyLengthFactor	Length (or length multiplicative factor) of the body shape.
	bodyLengthType	If bodyLengthType = CONSTANT_LENGTH, each vector has the same body length = bodyLengthFactor .
	bodyRadiusFactor	Radius (or radius multiplicative factor) of the cylinder.
	bodyRadiusType	Defines type of method to compute the cylinder's radius.
	bodyShape	Type of shape (no body, line, cylinder) used to draw the body.
	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.)
	density	Vector field density filter.
	eliminationStatus	If eliminationStatus = TOO_SMALL, the vectors which module is lower than minLength are not drawn.
	endArrowColoringType	Coloring method of the end shape.
	endArrowHeightFactor	Height (or Height multiplicative factor) of the arrow shape.
	endArrowHeightType	Defines the type of method to compute the arrow height.
	endArrowRadiusFactor	The end-arrow's radius is end-arrow's height * endArrowRadiusFactor.
	endArrowShape	Type of shape to be drawn at the end point of the body.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	maxLength	Maximum length of the vector to be drawn.
	minLength	Minimum length of the vector to be drawn.
	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.)
	startArrowColoringType	Coloring method of the start shape.
	startArrowHeightFactor	Height (or Height multiplicative factor) of the arrow shape.
	startArrowHeightType	Defines the type of method to compute the arrow height.
	startArrowRadiusFactor	The start-arrow's radius is start-arrow's height * startArrowRadiusFactor.
	startArrowShape	Type of shape to be drawn at the start point of the body.
	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.)

Top

Events

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

Top

Remarks

Class to build a vectors field on a volume 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 or OIV.MeshViz.Data.PbMesh), 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.PoMesh3DVec {
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
}

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

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