|
Open Inventor Release 2024.1.0
|
|
| |
|
Open Inventor Release 2024.1.0
|
|
|
| |
Abstract class for automatic value legend.
More...
#include <MeshViz/graph/PoAutoValueLegend.h>
Inheritance diagram for PoAutoValueLegend: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. | |
| Public Member Functions inherited from PoValueLegend | |
| void | setIsovaluesList (PbIsovaluesList *isovaluesList) |
| Sets a reference to a PbIsovaluesList object. | |
| const PbIsovaluesList * | getIsovaluesList () const |
| Gets a reference to a PbIsovaluesList object. | |
| void | setDataMapping (PbDataMapping *dataMapping) |
| Sets a reference to a PbDataMapping object to the association color-values. | |
| const PbDataMapping * | getDataMapping () const |
| Gets a reference to a PbDataMapping object to the association color-values. | |
| void | setFormat (PbNumericDisplayFormat *format) |
| Sets a reference to a PbNumericDisplayFormat object for the numerical display format of the legend values. | |
| const PbNumericDisplayFormat * | getFormat () const |
| Gets a reference to a PbNumericDisplayFormat object for the numerical display format of the legend values. | |
| Public Member Functions inherited from PoLegend | |
| void | setMiscTextAttr (PbMiscTextAttr *textAttr) |
| Sets a reference to a PbMiscTextAttr for miscellaneous text attributes of all legend texts. | |
| const PbMiscTextAttr * | getMiscTextAttr () const |
| Gets a reference to a PbMiscTextAttr for miscellaneous text attributes. | |
| 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. | |
| virtual void | rebuild () |
| Forces the node kit to be rebuilt immediately. | |
| 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 PoValueLegend | |
| 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 PoLegend | |
| 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 PoGraphMaster | |
| 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 | |
| SoSFVec2f | start |
| First point of one of the diagonals of the rectangle delimiting the legend. | |
| SoSFVec2f | end |
| Second point of the same diagonal. | |
| Public Attributes inherited from PoValueLegend | |
| SoSFString | upperUndefString |
| String indicating the upper undefined level. | |
| SoSFString | lowerUndefString |
| String indicating the lower undefined level. | |
| SoSFUShort | periodValue |
| Period to display the values in the legend. | |
| SoSFUShort | firstValue |
| Number of the first value to display. | |
| SoSFUShort | lastValue |
| Number of the last value to display. | |
| Public Attributes inherited from PoLegend | |
| SoSFEnum | titleVisibility |
| Title visibility. | |
| SoSFEnum | titlePosition |
| Title position. | |
| SoSFEnum | titlePath |
| Title path. | |
| SoSFFloat | titleFontSize |
| Font size of the title. | |
| SoSFString | titleFontName |
| Font name of the title. | |
| SoSFString | titleString |
| Title string. | |
| SoSFEnum | valueVisibility |
| Values visibility. | |
| SoSFEnum | valuePosition |
| Values positions. | |
| SoSFString | valueFontName |
| Font name of values. | |
| SoSFBool | valueAddStringVisibility |
| Visibility of a string concatenated to the values. | |
| SoSFString | valueAddString |
| String to be concatenated. | |
| SoSFEnum | marginType |
| Margin type. | |
| SoSFFloat | marginLeft |
| Left margin. | |
| SoSFFloat | marginRight |
| Right margin. | |
| SoSFFloat | marginBottom |
| Bottom margin. | |
| SoSFFloat | marginTop |
| Top margin. | |
| SoSFEnum | incrementType |
| Increment type for the values of legend. | |
| SoSFUShort | numColumns |
| Number of columns of the legend. | |
| SoSFFloat | boxRatio |
| Ratio between width and height of the colored boxes in the legend. | |
| Public Attributes inherited from SoBaseKit | |
| SoSFBool | boundingBoxIgnoring |
| Whether to ignore this node during bounding box traversal. | |
Additional Inherited Members | |
| Public Types inherited from PoLegend | |
| enum | Visibility { VISIBILITY_OFF , VISIBILITY_ON } |
| Type of visibility. More... | |
| enum | TextPath { PATH_RIGHT , PATH_LEFT , PATH_UP , PATH_DOWN } |
| Text path. More... | |
| enum | Position { POS_BOTTOM , POS_TOP , POS_RIGHT , POS_LEFT } |
| Type of position. More... | |
| enum | MarginType { REL_MARGIN , FIXED_MARGIN } |
| Type of margins. More... | |
| enum | IncrementType { VERTICAL_INCREMENT , HORIZONTAL_INCREMENT } |
| Type of values incrementation. 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) |
Abstract class for automatic value legend.
This class represents a value legend delimited by a rectangle defined by the points start and end. Values of the legend are drawn from the start point to the end point, so reversing their two points reverses also the value order.
The distribution of the color boxes is handled automatically according to the number of values and the geometry of the rectangle delimiting the legend. The box sizes and the font size are calculated so that the boxes occupy the entire space inside the legend rectangle.
Definition at line 47 of file PoAutoValueLegend.h.
|
static |
Returns the SoNodekitCatalog for this class.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the SoNodekitCatalog for this instance.
Reimplemented from PoValueLegend.
Reimplemented in PoLinearValueLegend, PoNonLinearValueLegend1, PoNonLinearValueLegend2, and PoNonLinearValueLegend3.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from PoValueLegend.
Reimplemented in PoLinearValueLegend, PoNonLinearValueLegend1, PoNonLinearValueLegend2, and PoNonLinearValueLegend3.
| SoSFVec2f PoAutoValueLegend::end |
Second point of the same diagonal.
Definition at line 68 of file PoAutoValueLegend.h.
| SoSFVec2f PoAutoValueLegend::start |
First point of one of the diagonals of the rectangle delimiting the legend.
Values of the legend are drawn from the start point to the end point, so reversing their two points reverses also the values order. For instance if start = SbVec2f(0,0) and end = SbVec2f(0.5, 1), values are drawn from the down to the up.
Definition at line 63 of file PoAutoValueLegend.h.
1.9.8 