Representation of vectors on a grid of a cross section. More...

#include <MeshViz/3Ddata/PoMesh3DVecGridCrossSection.h>

Inheritance diagram for PoMesh3DVecGridCrossSection:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance.

	PoMesh3DVecGridCrossSection ()
	Constructor.

virtual void	rebuild ()
	Forces node-kit rebuilding.

Public Member Functions inherited from PoMesh3DVecCrossSection
	PoMesh3DVecCrossSection ()
	Constructor.

Public Member Functions inherited from PoMesh3DVec
	PoMesh3DVec ()
	Constructor.

Public Member Functions inherited from PoMesh3D
void	setMesh (PbMesh3D *mesh)
	Defines the current volume mesh.

const PbMesh3D *	getMesh () const
	Gets the current volume mesh.

Public Member Functions inherited from PoMesh
void	setMesh (PbMesh *mesh)
	Sets a reference to a PbMesh object.

void	setDataMapping (PbDataMapping *data_mapping)
	Sets a reference to a PbDataMapping object for the association color-value.

void	setModuleDataMapping (PbDataMapping *mod_data_mapping)
	Sets a reference to a PbDataMapping object for the association color-vectors module.

void	setIsovaluesList (PbIsovaluesList *isovalues_list)
	Sets a reference to a PbIsovaluesList object to define a list of isovalues.

const PbMesh *	getMesh () const
	Gets the current PbMesh object.

const PbDataMapping *	getDataMapping () const
	Returns the current PbDataMapping object.

const PbDataMapping *	getModuleDataMapping () const
	Returns the current PbDataMapping object for the association color-vectors module.

const PbIsovaluesList *	getIsovaluesList () const
	Returns the current PbIsovaluesList object.

Public Member Functions inherited from PoBase
void	setUpdateMethod (UpdateMethodType type)
	Sets scene graph update method.

UpdateMethodType	getUpdateMethod () const
	Gets update method.

void	setDomain (PbDomain *dom)
	Sets a reference to a PbDomain object used to define the data limits of the graphics to be generated.

const PbDomain *	getDomain () const
	Gets a reference to a PbDomain object used to define the data limits of the graphics to be generated.

void	touchKit ()
	Indicates the node kit is modified.

SbBool	isModified () const
	Return TRUE, if the kit has been modified, else otherwise.

SbBool	isBuilt () const
	Indicates if the node kit has been built at least once.

void	addPreRebuildCallback (PoRebuildCB cb, void data)
	Add a callback function to call when the node kit is rebuilt.

void	addPostRebuildCallback (PoRebuildCB cb, void data)
	Add a callback function to call when the node kit is rebuilt.

void	removePreRebuildCallback (PoRebuildCB cb, void data=NULL)
	Remove a callback function to call when the node kit is rebuilt.

void	removePostRebuildCallback (PoRebuildCB cb, void data)
	Remove a callback function to call when the node kit is rebuilt.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Copy method.

virtual SbBool	affectsState () const
	See SoNode::affectsState() for explanations.

Public Member Functions inherited from SoBaseKit
	SoBaseKit ()
	Constructor.

virtual SoNode *	getPart (const SbName &partName, SbBool makeIfNeeded)
	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

template<typename PartType >
PartType *	getPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.

template<typename PartType >
PartType *	checkPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.

SbString	getPartString (const SoBase *part)
	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.

virtual SoNodeKitPath *	createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at partName.

virtual SbBool	setPart (const SbName &partName, SoNode *newPart)
	Inserts the given node (not a copy) as the new part specified by partName.

SoNONUNICODE SbBool	set (char *nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SbBool	set (const SbString &nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SoNONUNICODE SbBool	set (const char partNameString, const char parameterString)
	This function allows field values of parts (nodes) to be set.

SbBool	set (const SbString &partNameString, const SbString &parameterString)
	This function allows field values of parts (nodes) to be set.

Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Public Member Functions inherited from SoGetView
	SoGetView ()
	Default constructor.

virtual	~SoGetView ()

virtual SbBool	getViewportIsEnabled () const
	Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.

virtual const SbVec2f	getViewportOrigin () const
	Returns SbViewportRegion origin.

virtual const SbVec2f	getViewportSize () const
	Returns SbViewportRegion size.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from PoMesh3DVecCrossSection
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from PoMesh3DVec
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from PoMesh3D
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from PoMesh
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from Po3DdataMaster
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from PoBase
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

static void	setNodeWriteFormat (NodeWriteFormat format)
	Sets the node write format.

static NodeWriteFormat	getNodeWriteFormat ()
	Gets the node write format.

static void	setTextType (TextType type)
	Sets the type of text used.

static TextType	getTextType ()
	Gets the type of text used.

static void	setVRML2Mode (SbBool flag)
	Set the VRML2 mode.

static SbBool	isVRML2Mode ()
	Gets the VRML2 mode (TRUE = VRML2 mode, FALSE Inventor mode)

Static Public Member Functions inherited from SoBaseKit
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.

static void	setSearchingChildren (SbBool newVal)
	Sets if nodekit children are searched during SoSearchAction traversal.

static SbBool	isSearchingChildren ()
	Returns TRUE if nodekit children are searched during SoSearchAction traversal.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFFloat	gridSpacing
	GridSpacing is relating to the number of points on the grid : the smaller gridSpacing is, the greater the number of points is.

Public Attributes inherited from PoMesh3DVecCrossSection
SoSFPlane	plane
	Position of the cross section.

SoSFEnum	projectionType
	Defines how each vector is projected.

Public Attributes inherited from PoMesh3DVec
SoSFInt32	density
	Vector field density filter.

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

SoSFFloat	minLength
	Minimum length of the vector to be drawn.

SoSFFloat	maxLength
	Maximum length of the vector to be drawn.

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

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

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

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

SoSFFloat	bodyRadiusFactor
	Radius (or radius multiplicative factor) of the cylinder.

SoSFEnum	bodyColoringType
	coloring method of the body.

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

SoSFEnum	startArrowHeightType
	Defines the type of method to compute the arrow height.

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

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

SoSFEnum	startArrowColoringType
	Coloring method of the start shape.

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

SoSFEnum	endArrowHeightType
	Defines the type of method to compute the arrow height.

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

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

SoSFEnum	endArrowColoringType
	Coloring method of the end shape.

Public Attributes inherited from PoMesh
SoSFInt32	valuesIndex
	Defines the index of the set of values for the coloring.

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

SoSFInt32	vecsIndex
	Defines the index of the set of vectors for all representations which need a vector at each mesh node (PoBaseStreamLine, PoMesh2DVec, PoMesh3DVec,...)

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

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

SoSFBool	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.

SoSFFloat	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.

Public Attributes inherited from SoBaseKit
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Additional Inherited Members
Public Types inherited from PoMesh3DVecCrossSection
enum	ProjectionType { NO_PROJECTION , PROJECTION_ON_PLANE , PROJECTION_ON_NORMAL }
	Type of projection of vectors. More...

Public Types inherited from PoMesh3DVec
enum	EliminationStatus { NONE , TOO_SMALL , TOO_LONG , TOO_SMALL_OR_LONG }
	Type of vector elimination. More...

enum	BodyShape { NO_BODY , LINE , CYLINDER }
	Type of body shape. More...

enum	BodyLengthType { CONSTANT_LENGTH , RELATIVE_LENGTH }
	Type of body lenght. More...

enum	BodyRadiusType { CONSTANT_RADIUS , RELATIVE_RADIUS }
	Type of body radius. More...

enum	ArrowShape { NO_SHAPE , POINT , CHEVRON , TRIANGLE , RECTANGLE , CONE , BOX , SPHERE , INDIRECT_CHEVRON , INDIRECT_TRIANGLE , INDIRECT_CONE }
	Type of arrow shape. More...

enum	ArrowHeightType { CONSTANT_HEIGHT , RELATIVE_HEIGHT }
	Type of height of an arrow. More...

enum	ArrowColoringType { CONSTANT_COLOR , MODULE_MAPPING_COLOR , SCALAR_MAPPING_COLOR }
	Type of arrow coloring. More...

Public Types inherited from PoMesh
enum	ColoringType { COLOR_INHERITED , COLOR_AVERAGE , COLOR_MAPPING , COLOR_CONTOURING , COLOR_TEXTURE_CONTOURING }
	Coloring type. More...

Public Types inherited from PoBase
enum	UpdateMethodType { UPDATE_METHOD_IMMEDIATE , UPDATE_METHOD_ON_ACTION }
	Type of update method. More...

enum	NodeWriteFormat { FOLD_NODE_WRITE_FORMAT , UNFOLD_NODE_WRITE_FORMAT }
	Type of write format. More...

enum	TextType { SO_TEXT3 , SO_ANNO_TEXT3 }
	Type of Text. More...

typedef void	PoRebuildCB(void userData, PoBase base)

Detailed Description

Representation of vectors on a grid of a cross section.

A grid of points on a #plane of a volume mesh is built. Then a vector 
is computed by interpolation on each point of the grid, possibly projected
(depending on the #projectionType field) and is represented according to the 
different fields of PoMesh3DVec.

It may be time consuming to use this class depending on the value of the gridSpacing.
For each point of the grid, this class looks for the cell that contains
the point by using a probe tool. The vector drawn at the point is computed by 
interpolation between each point of the containing cell.
The probing process may be slow depending on the number of cells, the mesh type, the
spatial organization of the cells, etc...
The quickest way to draw a vector field may be by using the parent class
PoMesh3DVecCrossSection. Note also that if #gridSpacing = 0, this class behaves like 
PoMesh3DVecCrossSection.

FILE FORMAT/DEFAULT

PoMesh3DVecGridCrossSection

plane	Z=0 plane
gridSpacing	0.05
projectionType	NO_PROJECTION
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

CATALOG PARTS

PoMesh3DVecCrossSection

Separator

alternateRep

AppearanceKit

appearance

Specifies the appearance of all the kit. By default lightModel.model=PHONG.

MatrixTransform

domainTransform

Corresponds to the domain transformation.

Separator

bodySep

Contains properties and shapes of the bodies of vectors.

AppearanceKit

bodyApp

Specifies the appearance of the bodies.

Group

bodyGroup

Contains a list of SoLineSet or SoCylinder shape to draw vectors bodies.

Separator startArrowSep {

Contains properties and shapes of the start-shape of vectors.

AppearanceKit

startArrowApp

Specifies the appearance of the start-shapes.

Group

startArrowGroup

Contains a list of nodes to draw the start arrow shapes.

Separator endArrowSep {

Contains properties and shapes of the end-shape of vectors.

AppearanceKit

endArrowApp

Specifies the appearance of the end-shapes.

Group

endArrowGroup

Contains a list of nodes to draw the end arrow shapes.

}

Constructor & Destructor Documentation

◆ PoMesh3DVecGridCrossSection()

PoMesh3DVecGridCrossSection::PoMesh3DVecGridCrossSection ( )

Constructor.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoMesh3DVecGridCrossSection::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoMesh3DVecGridCrossSection::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getNodekitCatalog()

virtual const SoNodekitCatalog * PoMesh3DVecGridCrossSection::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoMesh3DVecCrossSection.

◆ getTypeId()

virtual SoType PoMesh3DVecGridCrossSection::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoMesh3DVecCrossSection.

◆ rebuild()

virtual void PoMesh3DVecGridCrossSection::rebuild ( )

virtual

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoMesh3DVecCrossSection.

Member Data Documentation

◆ gridSpacing

SoSFFloat PoMesh3DVecGridCrossSection::gridSpacing

GridSpacing is relating to the number of points on the grid : the smaller gridSpacing is, the greater the number of points is.

It represents a factor of the biggest size of the mesh. 0.05 by default. If gridSpacing = 0, this class behaves like PoMesh3DVecCrossSection.

Definition at line 125 of file PoMesh3DVecGridCrossSection.h.

The documentation for this class was generated from the following file:

MeshViz/3Ddata/PoMesh3DVecGridCrossSection.h

Open Inventor Release 2023.2.3

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

FILE FORMAT/DEFAULT

CATALOG PARTS

SEE ALSO

Constructor & Destructor Documentation

◆ PoMesh3DVecGridCrossSection()

Member Function Documentation

◆ getClassNodekitCatalog()

◆ getClassTypeId()

◆ getNodekitCatalog()

◆ getTypeId()

◆ rebuild()

Member Data Documentation

◆ gridSpacing