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

MeshViz Builds a 2D curve. More...

#include <MeshViz/graph/PoCurve.h>

+ Inheritance diagram for PoCurve:

Public Types

enum  FilterType {
  INACTIVE ,
  ALL_POINTS ,
  INDEX_PERIOD ,
  INDEX_LIST ,
  X_PERIOD ,
  X_LIST
}
 Filter type. More...
 
enum  CurveRep {
  CURVE_NONE ,
  CURVE_POLYLINE ,
  CURVE_SMOOTH ,
  CURVE_STAIRS_X ,
  CURVE_STAIRS_Y ,
  CURVE_HISTO_X ,
  CURVE_HISTO_Y ,
  CURVE_STAIRS_2X ,
  CURVE_STAIRS_2Y
}
 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.
 
 PoCurve ()
 Default constructor.
 
 PoCurve (int numPoints, const SbVec2f *_point, CurveRep _curveRep=CURVE_POLYLINE)
 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
 Point list of the curve.
 
SoSFEnum curveRep
 Defines the curve representation (polyline, smooth, stair, ...)
 
SoSFBool isCurveFilled
 Indicates if the curve is filled or not.
 
SoSFFloat fillingThreshold
 Defines the threshold to fill the curve.
 
SoSFEnum markerFilterType
 Defines the type of marker filter.
 
SoSFInt32 markerIndexPeriod
 One point (of point) in every consecutive markerIndexPeriod is selected.
 
SoMFInt32 markerIndexList
 A list of points (of point) is selected by their indices.
 
SoSFFloat markerXPeriod
 One point (of the computed curve points) in every markerXPeriod is selected.
 
SoMFFloat markerXList
 A list of points (of the computed curve points) is selected by their abscises.
 
SoSFString markerString
 The markers are defined by a string.
 
SoSFEnum raiseFilterType
 Defines the type of raise filter.
 
SoSFInt32 raiseIndexPeriod
 One point (of point) in every consecutive raiseIndexPeriod is selected.
 
SoMFInt32 raiseIndexList
 A list of points (of point) is selected by their indices.
 
SoSFFloat raiseXPeriod
 One point (of the computed curve points) in every raiseXPeriod is selected.
 
SoMFFloat raiseXList
 A list of points (of the computed curve points) is selected by their abscises.
 
SoSFFloat raiseThreshold
 Raise points are vertical lines joining the curve points and the specified threshold.
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

MeshViz Builds a 2D curve.

Class to build a curve in the plane XY. The curve is defined by a set of points. Different representations of the curve can be obtained, such as polyline curve, smooth curve, stair curve or double stair curve. The curve can be filled. Furthermore, some filters control the appearance of markers (on the curve) and raise points (vertical lines from the curve to a threshold).

FILE FORMAT/DEFAULT

    PoCurve {
    point 0 0
    curveRep CURVE_POLYLINE
    fillingThreshold 0.0
    isCurveFilled FALSE
    markerFilterType INACTIVE
    markerIndexPeriod 0
    markerIndexList 0
    markerXPeriod 0
    markerXList 0
    markerString "."
    raiseFilterType INACTIVE
    raiseIndexPeriod 0
    raiseIndexList 0
    raiseXPeriod 0
    raiseXList 0
    raiseThreshold 0
    }

    CATALOG PARTS

      PoCurve {
        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 curveFillingSep {
            Contains properties and shapes to fill the curve.
              AppearanceKit curveFillingApp
              Specifies the appearance of filling curve.
              Group curveFilling
              Contains a SoFaceSet shape to fill the curve.
            }

            Separator curvePointSep {
            Contains properties and shapes to draw the curve.
              AppearanceKit curvePointApp
              Specifies the appearance of the curve.
              Group curvePoint
              Contains a SoLineSet shape to draw the curve.
            }

            Separator markerSep {
            Contains properties and shapes to draw the markers on the curve.
              AppearanceKit markerApp
              Specifies the appearance of markers. If markerString != ".", the font used for markers is the font set in font.name.
              Group marker
              Contains a list of SoText2 (markerString != ".") or SoPointSet (markerString = ".") shapes to draw the markers.
            }

            Separator raisePointSep {
            Contains properties and shapes to draw the raise points on the curve.
              AppearanceKit raisePointApp
              Specifies the appearance of raise points.
              Group raisePoint
              Contains a SoLineSet shape to draw the raise points.
            }
          }
        }

      Definition at line 77 of file PoCurve.h.

    Member Enumeration Documentation

    ◆ CurveRep

    Curve representation.

    Enumerator
    CURVE_NONE 

    No curve is built.

    CURVE_POLYLINE 

    The curve is a sequence of straight lines linking all points.

    CURVE_SMOOTH 

    The curve is a smoothing passing through all points.

    CURVE_STAIRS_X 

    Stair curve passing through all points.

    CURVE_STAIRS_Y 

    Stair curve passing through all points.

    CURVE_HISTO_X 

    Stair curve no necessarily passing through all points.

    CURVE_HISTO_Y 

    Stair curve no necessarily passing through all points.

    CURVE_STAIRS_2X 

    Double stair curve.

    CURVE_STAIRS_2Y 

    Double stair curve.

    Definition at line 136 of file PoCurve.h.

    ◆ FilterType

    Filter type.

    Enumerator
    INACTIVE 

    Filter is inactive.

    ALL_POINTS 

    All points of point are selected.

    INDEX_PERIOD 

    One point of point in every indexPeriod is selected.

    INDEX_LIST 

    A list of points of point is selected by their indices.

    X_PERIOD 

    One point of computed curve points is selected in every xPeriod.

    X_LIST 

    A list of points of computed curve points are selected by a list of abscises.

    Definition at line 104 of file PoCurve.h.

    Constructor & Destructor Documentation

    ◆ PoCurve() [1/2]

    PoCurve::PoCurve ( )
    inline

    Default constructor.

    Definition at line 287 of file PoCurve.h.

    ◆ PoCurve() [2/2]

    PoCurve::PoCurve ( int  numPoints,
    const SbVec2f _point,
    CurveRep  _curveRep = CURVE_POLYLINE 
    )
    inline

    Constructor.

    Definition at line 294 of file PoCurve.h.

    Member Function Documentation

    ◆ getClassNodekitCatalog()

    static const SoNodekitCatalog * PoCurve::getClassNodekitCatalog ( )
    static

    Returns the SoNodekitCatalog for this class.

    ◆ getClassTypeId()

    static SoType PoCurve::getClassTypeId ( )
    static

    Returns the type identifier for this class.


    ◆ getNodekitCatalog()

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

    Returns the SoNodekitCatalog for this instance.

    Reimplemented from PoGraphMaster.

    ◆ getTypeId()

    virtual SoType PoCurve::getTypeId ( ) const
    virtual

    Returns the type identifier for this specific instance.

    Reimplemented from PoGraphMaster.

    ◆ rebuild()

    virtual void PoCurve::rebuild ( )
    virtual

    Forces node-kit rebuilding.

    See PoBase.

    Reimplemented from PoBase.

    Member Data Documentation

    ◆ curveRep

    SoSFEnum PoCurve::curveRep

    Defines the curve representation (polyline, smooth, stair, ...)

    Definition at line 189 of file PoCurve.h.

    ◆ fillingThreshold

    SoSFFloat PoCurve::fillingThreshold

    Defines the threshold to fill the curve.

    Definition at line 199 of file PoCurve.h.

    ◆ isCurveFilled

    SoSFBool PoCurve::isCurveFilled

    Indicates if the curve is filled or not.

    Definition at line 194 of file PoCurve.h.

    ◆ markerFilterType

    SoSFEnum PoCurve::markerFilterType

    Defines the type of marker filter.

    This value determines which filter is active (markerIndexPeriod or markerIndexList,...)

    Definition at line 206 of file PoCurve.h.

    ◆ markerIndexList

    SoMFInt32 PoCurve::markerIndexList

    A list of points (of point) is selected by their indices.

    Definition at line 218 of file PoCurve.h.

    ◆ markerIndexPeriod

    SoSFInt32 PoCurve::markerIndexPeriod

    One point (of point) in every consecutive markerIndexPeriod is selected.

    Definition at line 212 of file PoCurve.h.

    ◆ markerString

    SoSFString PoCurve::markerString

    The markers are defined by a string.

    If this field is equal to ".", the markers are SoPointSet shapes, otherwise SoText2 shapes. To change the font of text markers, set the catalog part markerApp.font.name. Be careful, in this version, text markers are not vertically aligned.

    Definition at line 241 of file PoCurve.h.

    ◆ markerXList

    SoMFFloat PoCurve::markerXList

    A list of points (of the computed curve points) is selected by their abscises.

    Definition at line 230 of file PoCurve.h.

    ◆ markerXPeriod

    SoSFFloat PoCurve::markerXPeriod

    One point (of the computed curve points) in every markerXPeriod is selected.

    Definition at line 224 of file PoCurve.h.

    ◆ point

    SoMFVec2f PoCurve::point

    Point list of the curve.

    Definition at line 184 of file PoCurve.h.

    ◆ raiseFilterType

    SoSFEnum PoCurve::raiseFilterType

    Defines the type of raise filter.

    This value determines which filter is active (raiseIndexPeriod or raiseIndexList,...)

    Definition at line 248 of file PoCurve.h.

    ◆ raiseIndexList

    SoMFInt32 PoCurve::raiseIndexList

    A list of points (of point) is selected by their indices.

    Definition at line 260 of file PoCurve.h.

    ◆ raiseIndexPeriod

    SoSFInt32 PoCurve::raiseIndexPeriod

    One point (of point) in every consecutive raiseIndexPeriod is selected.

    Definition at line 254 of file PoCurve.h.

    ◆ raiseThreshold

    SoSFFloat PoCurve::raiseThreshold

    Raise points are vertical lines joining the curve points and the specified threshold.

    Definition at line 278 of file PoCurve.h.

    ◆ raiseXList

    SoMFFloat PoCurve::raiseXList

    A list of points (of the computed curve points) is selected by their abscises.

    Definition at line 272 of file PoCurve.h.

    ◆ raiseXPeriod

    SoSFFloat PoCurve::raiseXPeriod

    One point (of the computed curve points) in every raiseXPeriod is selected.

    Definition at line 266 of file PoCurve.h.


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