Class to build contour lines on a 2D mesh. More...
#include <MeshViz/3Ddata/PoMeshContouring.h>
Public Types | |
enum | AnnotPath { TANGENTIAL_PATH , HORIZONTAL_PATH , VERTICAL_PATH } |
Type of annotations path. More... | |
enum | AnnotCrossStatus { CROSS_CONTOUR , CROSS_MINOR_CONTOUR , DONT_CROSS_CONTOUR } |
Controls the annotations of contour lines. 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) |
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. | |
PoMeshContouring () | |
Constructor. | |
virtual void | rebuild () |
Forces node-kit rebuilding. | |
void | setFormat (PbNumericDisplayFormat *format) |
Sets a reference to a PbNumericDisplayFormat object for the numerical display format for annotations of contour lines. | |
const PbNumericDisplayFormat * | getFormat () const |
Gets the reference to a PbNumericDisplayFormat. | |
void | setMiscTextAttr (PbMiscTextAttr *textAttr) |
Sets a reference to PbMiscTextAttr object for miscellaneous text attributes of annotations of contour lines. | |
const PbMiscTextAttr * | getMiscTextAttr () const |
Gets a reference to PbMiscTextAttr object. | |
Public Member Functions inherited from PoMesh2D | |
void | setMesh (PbMesh2D *mesh) |
Defines the current surface mesh. | |
const PbMesh2D * | getMesh () const |
Gets the current surface 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 ¶meterString) |
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 PoMesh2D | |
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 | |
SoSFUShort | majorPeriod |
Defines the major and the minor contour lines. | |
SoSFUShort | firstMajor |
Defines the first major contour lines. | |
SoSFBool | annotIsVisible |
Contour lines annotations visibility. | |
SoSFEnum | annotPath |
Annotations path. | |
SoSFEnum | annotCrossStatus |
Controls the annotations and contour lines crossing. | |
SoSFBool | annotIsBackground |
Defines if the annotations are framed by a background. | |
SoSFBool | annotIsContourClip |
Defines if the contour lines are clipped by the annotations. | |
SoSFFloat | annotGap |
Curvilinear distance between two annotations of a same contour line. | |
SoMFVec2f | annotClippingPolygon |
This is a polygon where no annotations are present outside it. | |
SoSFFloat | annotFontSize |
Font size of annotations of contour lines. | |
SoSFFloat | annotFontFactor |
Font size factor of annotations of contour lines. | |
Public Attributes inherited from PoMesh2D | |
SoSFShort | zValuesIndex |
Defines the index of the set of values used by a representation as a z-coordinate of each mesh node (-1 by default). | |
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. | |
Class to build contour lines on a 2D mesh.
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 PoMesh::setIsovaluesList() method or by the current PoIsovaluesList node during the traversal. All contour lines can have the same color (PoMesh::coloringType = COLOR_INHERITED) or can have a color depending on the values of the contouring lines (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 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 PoMiscTextAttr). <B> Note: </B> 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.
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 |
Definition at line 105 of file PoMeshContouring.h.
Controls the annotations of contour lines.
Definition at line 168 of file PoMeshContouring.h.
Type of annotations path.
Enumerator | |
---|---|
TANGENTIAL_PATH | Annotations are tangential to the contour lines. |
HORIZONTAL_PATH | Annotations are horizontal. |
VERTICAL_PATH | Annotations are vertical. |
Definition at line 148 of file PoMeshContouring.h.
PoMeshContouring::PoMeshContouring | ( | ) |
Constructor.
|
static |
Returns the SoNodekitCatalog for this class.
|
static |
Returns the type identifier for this class.
const PbNumericDisplayFormat * PoMeshContouring::getFormat | ( | ) | const |
Gets the reference to a PbNumericDisplayFormat.
See setFormat.
const PbMiscTextAttr * PoMeshContouring::getMiscTextAttr | ( | ) | const |
Gets a reference to PbMiscTextAttr object.
See setMiscTextAttr.
|
virtual |
Returns the SoNodekitCatalog for this instance.
Reimplemented from PoMesh2D.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from PoMesh2D.
|
virtual |
void PoMeshContouring::setFormat | ( | PbNumericDisplayFormat * | format | ) |
Sets a reference to a PbNumericDisplayFormat object for the numerical display format for annotations of contour lines.
If this method is not called the format used is the one of the default constructor of PbNumericDisplayFormat.
void PoMeshContouring::setMiscTextAttr | ( | PbMiscTextAttr * | textAttr | ) |
Sets a reference to PbMiscTextAttr object for miscellaneous text attributes of annotations of contour lines.
If this method is not called the text attributes used are those of the default constructor of PbMiscTextAttr.
SoMFVec2f PoMeshContouring::annotClippingPolygon |
This is a polygon where no annotations are present outside it.
If the point list is empty, the mesh limits will be used instead. By default, annotClippingPolygon = (0,0)
Definition at line 255 of file PoMeshContouring.h.
SoSFEnum PoMeshContouring::annotCrossStatus |
Controls the annotations and contour lines crossing.
By default, annotCrossStatus = CROSS_CONTOUR.
Note that annotations may always cross the annotated contour line, however this field prevents annotations from crossing other contour lines.
Definition at line 225 of file PoMeshContouring.h.
SoSFFloat PoMeshContouring::annotFontFactor |
Font size factor of annotations of contour lines.
This field is only interpreted when an SoProjection node is applicable to contouring. By default, annotFontFactor = 1.
Definition at line 275 of file PoMeshContouring.h.
SoSFFloat PoMeshContouring::annotFontSize |
Font size of annotations of contour lines.
This value is a multiplicative factor of the domain size or of the clipping polygon size (if it is defined). The font size used is equal to annotFontSize * Ds, where Ds is the max of the width and the height of the domain or of the clipping polygon. If this value is <= 0, the annotations font size is fixed at 0.04. By default, annotFontSize = 0.
Definition at line 267 of file PoMeshContouring.h.
SoSFFloat PoMeshContouring::annotGap |
Curvilinear distance between two annotations of a same contour line.
It is a multiplicative factor of the domain size or of the clipping polygon size (if it is defined). The distance used is equal to annotGap * Ds, where Ds is the max of the width and the height of the domain or of the polygon. By default, annotGap = 1.
Definition at line 247 of file PoMeshContouring.h.
SoSFBool PoMeshContouring::annotIsBackground |
Defines if the annotations are framed by a background.
By default, annotIsBackground = FALSE
Definition at line 230 of file PoMeshContouring.h.
SoSFBool PoMeshContouring::annotIsContourClip |
Defines if the contour lines are clipped by the annotations.
By default, annotIsContourClip = FALSE
Definition at line 236 of file PoMeshContouring.h.
SoSFBool PoMeshContouring::annotIsVisible |
Contour lines annotations visibility.
By default, annotIsVisible = FALSE
Definition at line 202 of file PoMeshContouring.h.
SoSFEnum PoMeshContouring::annotPath |
Annotations path.
By default, annotPath = TANGENTIAL_PATH.
Definition at line 212 of file PoMeshContouring.h.
SoSFUShort PoMeshContouring::firstMajor |
Defines the first major contour lines.
See also majorPeriod. By default, firstMajor = 1.
Definition at line 196 of file PoMeshContouring.h.
SoSFUShort PoMeshContouring::majorPeriod |
Defines the major and the minor contour lines.
majorPeriod is the period of major contour lines. Only major contour lines can be annotated. See also firstMajor. By default, majorPeriod = 3.
Definition at line 190 of file PoMeshContouring.h.