Open Inventor Release 2024.2.0
 
Loading...
Searching...
No Matches
PoErrorCurve Class Reference

MeshViz Class to build an error curve represention. More...

#include <MeshViz/graph/PoErrorCurve.h>

+ Inheritance diagram for PoErrorCurve:

Public Types

enum  VariationType {
  FIXED_VARIATION ,
  REL_VARIATION ,
  PERCENT_FIXED_VARIATION ,
  PERCENT_REL_VARIATION
}
 Type of interpretation of the fields lowY and highY. More...
 
enum  ErrorCurveRep {
  HIGH_LOW_CLOSE ,
  LINE_BAR ,
  FILLED
}
 Type of error curve representation. 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.
 
 PoErrorCurve ()
 Default constructor.
 
 PoErrorCurve (int numPoints, const SbVec2f *_point, const float *_lowY, const float *_highY, VariationType type=REL_VARIATION, ErrorCurveRep rep=HIGH_LOW_CLOSE)
 Constructor.
 
virtual void rebuild ()
 Forces node-kit rebuilding.
 
- 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 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

SoMFVec2f point
 List of coordinates of the error curve.
 
SoMFFloat lowY
 List of the low ordinates for the low curve.
 
SoMFFloat highY
 List of the high ordinates for the high curve.
 
SoSFEnum variationType
 Defines the interpretation of the values lowY and highY.
 
SoSFEnum errorCurveRep
 Defines the error curve representation.
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

MeshViz Class to build an error curve represention.

Class to build an error curve in the plane XY. An error curve is a curve (defined by a point list) with a low curve and a high curve which represent the error.

FILE FORMAT/DEFAULT

    PoErrorCurve {
    point 0 0
    lowY 0
    highY 0
    variationType REL_VARIATION
    errorCurveRep HIGH_LOW_CLOSE
    }

    CATALOG PARTS

      The catalog part interpretation depends on errorCurveRep field.

      - HIGH_LOW_CLOSE representation (the groups errorCurve3, errorCurve4 and errorCurve 4 are set to NULL):
      PoErrorCurve {
        Separator alternateRep (from PoBase) {
          AppearanceKit appearance (from PoBase)
          Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.
          MatrixTransform domainTransform (from PoBase)
          Corresponds to the domain transformation.
            Separator errorCurve1Sep {
            Contains properties and shapes to draw the close bars.
              AppearanceKit errorCurve1App
              Specifies the appearance of the close bars.
              Group errorCurve1
              Contains a SoLineSet shape to draw the close bars.
            }

            Separator errorCurve2Sep {
            Contains properties and shapes to draw vertical lines.
              AppearanceKit errorCurve2App
              Specifies the appearance of vertical lines.
              Group errorCurve2
              Contains a SoLineSet shape to draw vertical lines.
            }
          }
        }
          - LINE_BAR representation (the groups errorCurve5 is set to NULL):
          PoErrorCurve {
            Separator alternateRep (from PoBase) {
              AppearanceKit appearance (from PoBase)
              Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.
              MatrixTransform domainTransform (from PoBase)
              Corresponds to the domain transformation.
              Separator errorCurve1Sep {
              Contains properties and shapes to draw points.
                AppearanceKit errorCurve1App
                Specifies the appearance of points.
                Group errorCurve1
                Contains a SoLineSet shape to draw points.
              }

              Separator errorCurve2Sep {
              Contains properties and shapes to draw horizontal lower lines.
                AppearanceKit errorCurve2App
                Specifies the appearance of horizontal lower lines.
                Group errorCurve2
                Contains a SoLineSet shape to draw horizontal lower lines.
              }

              Separator errorCurve3Sep {
              Contains properties and shapes to draw horizontal upper lines.
                AppearanceKit errorCurve3App
                Specifies the appearance of horizontal upper lines.
                Group errorCurve3
                Contains a SoLineSet shape to draw horizontal upper lines.
              }

              Separator errorCurve4Sep {
              Contains properties and shapes to draw vertical lines.
                AppearanceKit errorCurve4App
                Specifies the appearance of vertical lines.
                Group errorCurve4
                Contains a SoLineSet shape to draw vertical lines.
              }
            }
          }
            - FILLED representation:
            PoErrorCurve {
              Separator alternateRep (from PoBase) {
                AppearanceKit appearance (from PoBase)
                Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.
                MatrixTransform domainTransform (from PoBase)
                Corresponds to the domain transformation.
                Separator errorCurve1Sep {
                Contains properties and shapes to draw lower part.
                  AppearanceKit errorCurve1App
                  Specifies the appearance of lower part.
                  Group errorCurve1
                  Contains a SoFaceSet shape to draw lower part.
                }

                Separator errorCurve2Sep {
                Contains properties and shapes to draw upper part.
                  AppearanceKit errorCurve2App
                  Specifies the appearance of upper part.
                  Group errorCurve2
                  Contains a SoFaceSet shape to draw upper part.
                }

                Separator errorCurve3Sep {
                Contains properties and shapes to draw lower curve.
                  AppearanceKit errorCurve3App
                  Specifies the appearance of lower curve.
                  Group errorCurve3
                  Contains a SoLineSet shape to draw lower curve.
                }

                Separator errorCurve4Sep {
                Contains properties and shapes to draw middle curve.
                  AppearanceKit errorCurve4App
                  Specifies the appearance of middle curve.
                  Group errorCurve4
                  Contains a SoLineSet shape to draw middle curve.
                }

                Separator errorCurve5Sep {
                Contains properties and shapes to draw upper curve.
                  AppearanceKit errorCurve5App
                  Specifies the appearance of upper curve.
                  Group errorCurve5
                  Contains a SoLineSet shape to draw upper curve.
                }
              }
            }

          Definition at line 58 of file PoErrorCurve.h.

        Member Enumeration Documentation

        ◆ ErrorCurveRep

        Type of error curve representation.

        Enumerator
        HIGH_LOW_CLOSE 

        The error curve is a high low close representation.

        LINE_BAR 

        The error curve is a line bar representation.

        FILLED 

        The error curve is a filled representation.

        Definition at line 99 of file PoErrorCurve.h.

        ◆ VariationType

        Type of interpretation of the fields lowY and highY.

        Enumerator
        FIXED_VARIATION 
        REL_VARIATION 
        PERCENT_FIXED_VARIATION 
        PERCENT_REL_VARIATION 

        Definition at line 89 of file PoErrorCurve.h.

        Constructor & Destructor Documentation

        ◆ PoErrorCurve() [1/2]

        PoErrorCurve::PoErrorCurve ( )
        inline

        Default constructor.

        Definition at line 163 of file PoErrorCurve.h.

        ◆ PoErrorCurve() [2/2]

        PoErrorCurve::PoErrorCurve ( int  numPoints,
        const SbVec2f _point,
        const float *  _lowY,
        const float *  _highY,
        VariationType  type = REL_VARIATION,
        ErrorCurveRep  rep = HIGH_LOW_CLOSE 
        )
        inline

        Constructor.

        Definition at line 170 of file PoErrorCurve.h.

        Member Function Documentation

        ◆ getClassNodekitCatalog()

        static const SoNodekitCatalog * PoErrorCurve::getClassNodekitCatalog ( )
        static

        Returns the SoNodekitCatalog for this class.

        ◆ getClassTypeId()

        static SoType PoErrorCurve::getClassTypeId ( )
        static

        Returns the type identifier for this class.


        ◆ getNodekitCatalog()

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

        Returns the SoNodekitCatalog for this instance.

        Reimplemented from PoGraphMaster.

        ◆ getTypeId()

        virtual SoType PoErrorCurve::getTypeId ( ) const
        virtual

        Returns the type identifier for this specific instance.

        Reimplemented from PoGraphMaster.

        ◆ rebuild()

        virtual void PoErrorCurve::rebuild ( )
        virtual

        Forces node-kit rebuilding.

        See PoBase.

        Reimplemented from PoBase.

        Member Data Documentation

        ◆ errorCurveRep

        SoSFEnum PoErrorCurve::errorCurveRep

        Defines the error curve representation.

        There are three types of representations: high low close representation (HIGH_LOW_CLOSE), line bar representation (LINE_BAR) and filling representation (FILLED).

        Definition at line 154 of file PoErrorCurve.h.

        ◆ highY

        SoMFFloat PoErrorCurve::highY

        List of the high ordinates for the high curve.

        The number of high ordinates must be equal to the number of points of point.

        Definition at line 133 of file PoErrorCurve.h.

        ◆ lowY

        SoMFFloat PoErrorCurve::lowY

        List of the low ordinates for the low curve.

        The number of low ordinates must be equal to the number of points of point.

        Definition at line 127 of file PoErrorCurve.h.

        ◆ point

        SoMFVec2f PoErrorCurve::point

        List of coordinates of the error curve.

        Definition at line 121 of file PoErrorCurve.h.

        ◆ variationType

        SoSFEnum PoErrorCurve::variationType

        Defines the interpretation of the values lowY and highY.

        The ordinate yl of the i-th point of the low curve depends on the value of this field:

        • FIXED_VARIATION: yl = lowY[i]
        • REL_VARIATION: yl = point[i][1] - lowY[i]
        • PERCENT_FIXED_VARIATION: yl = point[i][1] * lowY[i]
        • PERCENT_REL_VARIATION: yl = point[i][1] - (lowY[i] * point[i][1])

        The same method is used to compute yh, the ordinate of the i-th point of the high curve.

        Definition at line 147 of file PoErrorCurve.h.


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