Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
PoLabel Class Reference

MeshViz Class to build a label field. More...

#include <MeshViz/graph/PoLabel.h>

+ Inheritance diagram for PoLabel:

Public Types

enum  ValueType {
  VALUE ,
  NAME
}
 Type of value displayed by the labels. More...
 
enum  Position {
  VALUE_POS ,
  MIDDLE_POS ,
  THRESHOLD_POS
}
 Position of the labels. More...
 
enum  Axis {
  X ,
  Y
}
 values computation. More...
 
- Public Types inherited from PoChart
enum  ColorBinding {
  INHERITED ,
  PER_VERTEX ,
  PER_PART
}
 Color binding. 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 SoNodekitCataloggetNodekitCatalog () const
 Returns the SoNodekitCatalog for this instance.
 
 PoLabel ()
 Constructor.
 
- 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 PbDomaingetDomain () 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 SoNodecopy (SbBool copyConnections=FALSE) const
 Copy method.
 
virtual SbBool affectsState () const
 See SoNode::affectsState() for explanations.
 
- Public Member Functions inherited from SoBaseKit
 SoBaseKit ()
 Constructor.
 
virtual SoNodegetPart (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 SoNodeKitPathcreatePathToPart (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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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 SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from PoChart
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from PoGraphMaster
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 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 SoNodekitCataloggetClassNodekitCatalog ()
 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 SoNodekitCataloggetClassNodekitCatalog ()
 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 SoNodegetByName (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

SoSFInt32 stringsIndex
 Defines the index of the set of strings used for the names attached to labels when valueType is equal to NAME.
 
SoSFEnum axis
 Defines from which axis the position and type of displayed values computation is done.
 
SoSFBitMask valueType
 Defines the type of values displayed by the labels.
 
SoSFEnum position
 Defines the position of the labels.
 
SoSFFloat threshold
 Defines the threshold used to the set position of the label.
 
SoMFVec3f offset
 Defines an offset applied to the label.
 
SoSFFloat fontSize
 Font size of labels.
 
- Public Attributes inherited from PoChart
SoSFEnum colorBinding
 Specify how the colors are bound to the representation.
 
SoSFInt32 yValuesIndex
 Defines the index of the set of values used by a charting representation as a y-coordinate of each mesh node.
 
SoSFInt32 colorValuesIndex
 Defines the index of the set of values for the coloring.
 
SoSFNode material
 Defines the list of materials used for the coloring.
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

MeshViz Class to build a label field.

Builds a 2D label field on 1D mesh (PoIrregularMesh1D or PoRegularMesh1D). The abscissas of the labels are given by the geometry of the current mesh 1D, and the ordinates are given by one of the value-set of the current mesh 1D specified by the field yValuesIndex. Names attached to each label are given by one of the string-set of the current mesh 1D specified by the field stringsIndex.

The fields position, threshold and offset allows the user to set the label position and the field valueType set the values to display as labels. This class also takes into account of the current mesh 1D hints (PoMesh1DHints), and the current mesh 1D filter (PoMesh1DFilter) to filter the geometry of the current mesh 1D. The current label hints (PoLabelHints) is used to specify the appearance of labels. If the offset is different from null and, if the field isLabelLineVisible of the current label hints is set to TRUE then, a line representing the offset is drawn. All labels depend on the current miscellaneous text attributes which defines the font names, line length and so on (PoMiscTextAttr). All numerical values depend on the current numerical display format (PoNumericDisplayFormat).

The interpretation of colorBinding is the following :

  • INHERITED: All labels are colored with the same inherited color.
  • PER_PART, PER_VERTEX: A color is used for each label.

FILE FORMAT/DEFAULT

    PoLabel {
    colorBinding INHERITED
    yValuesIndex -1
    colorValuesIndex 1
    material NULL
    stringsIndex 0
    axis X
    valueType VALUE
    position VALUE_POS
    threshold 0.
    offset 0. 0. 0.
    fontSize 0.0
    }

    CATALOG PARTS

    PoLabel {

    Separator alternateRep (from PoBase) {

    AppearanceKit appearance (from PoBase)

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

    MatrixTransform domainTransform (from PoBase)

    Corresponds to the domain transformation.

    Group label

    Contains a list of couple SoMaterial and SoText3/SoAnnoText3/SoAsciiText (cf PoBase::setTextType() and PoBase::setVRML2Mode() for choosing the text type) if the field colorBinding is different from INHERITED, a list of SoText3/SoAnnoText3/SoAsciiText otherwise.

    Separator labelLineSep {

    Contains properties and shapes to draw the label lines.

      AppearanceKit labelLineApp

      Specifies the appearance of the label lines.

      Group labelLine

      Contains a SoLineSet shape to draw the label lines.

    }

    }

    }

    Definition at line 87 of file PoLabel.h.

Member Enumeration Documentation

◆ Axis

values computation.

Enumerator

X-Axis

Y-Axis.

Definition at line 152 of file PoLabel.h.

◆ Position

Position of the labels.

Enumerator
VALUE_POS 

The label position is the given by the current mesh geometry.

MIDDLE_POS 

The abscissas (resp ordinate) is given by the current mesh 1D geometry and the ordinate (resp.

abscissas) is at the middle between the mesh ordinate (reps. abscissas) and the threshold field.

THRESHOLD_POS 

The abscissas (resp ordinate) is given by the current mesh 1D geometry and the ordinate (resp.

abscissas) is the threshold field.

Definition at line 124 of file PoLabel.h.

◆ ValueType

Type of value displayed by the labels.

Enumerator
VALUE 

The values displayed correspond to the the ordinates (resp.

abscissas) of the current mesh 1D geometry.

NAME 

The values displayed correspond to the names associated to the strings-set specified by the field stringsIndex.

Definition at line 103 of file PoLabel.h.

Constructor & Destructor Documentation

◆ PoLabel()

PoLabel::PoLabel ( )

Constructor.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoLabel::getClassNodekitCatalog ( )
static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoLabel::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getNodekitCatalog()

virtual const SoNodekitCatalog * PoLabel::getNodekitCatalog ( ) const
virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoChart.

◆ getTypeId()

virtual SoType PoLabel::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from PoChart.

Member Data Documentation

◆ axis

SoSFEnum PoLabel::axis

Defines from which axis the position and type of displayed values computation is done.

All values in brackets correspond to the Y-axis.

Definition at line 176 of file PoLabel.h.

◆ fontSize

SoSFFloat PoLabel::fontSize

Font size of labels.

If this value is less or equal to 0, the font size is fixed at 0.04. This value is a percentage of the current domain (cf PoBase description).

Definition at line 225 of file PoLabel.h.

◆ offset

SoMFVec3f PoLabel::offset

Defines an offset applied to the label.

This offset is combinated with the label position. If the number of offsets is inferior to the number of labels, they are cyclically used.

Definition at line 217 of file PoLabel.h.

◆ position

SoSFEnum PoLabel::position

Defines the position of the labels.

There are three ways to define this position :

  • VALUE_POS: The label position is the given by the current mesh geometry.
  • MIDDLE_POS: The abscissas (resp. ordinate) is given by the current mesh geometry and the ordinate (resp. abscissas) is at the middle between the mesh ordinate (reps. abscissas) and a threshold.
  • THRESHOLD_POS: The abscissas (resp. ordinate) is given by the current mesh geometry and the ordinate (resp. abscissas) is the threshold field.

Definition at line 205 of file PoLabel.h.

◆ stringsIndex

SoSFInt32 PoLabel::stringsIndex

Defines the index of the set of strings used for the names attached to labels when valueType is equal to NAME.

If the field value is negative, no names is attached to labels.

Definition at line 169 of file PoLabel.h.

◆ threshold

SoSFFloat PoLabel::threshold

Defines the threshold used to the set position of the label.

Definition at line 210 of file PoLabel.h.

◆ valueType

SoSFBitMask PoLabel::valueType

Defines the type of values displayed by the labels.

There are two ways to display the labels :

  • VALUE: The values displayed correspond to the the ordinates (resp. abscissas) of the current mesh 1D geometry.
  • NAME: The values displayed correspond to the names associated to the strings-set specified by the field stringsIndex.

Definition at line 189 of file PoLabel.h.


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