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

MeshViz Class to build a 2D generalized scatter. More...

#include <MeshViz/graph/PoGeneralizedScatter.h>

+ Inheritance diagram for PoGeneralizedScatter:

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.
 
 PoGeneralizedScatter ()
 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

SoMFNode markers
 Defines the sub-scene graphs used for each marker.
 
SoSFInt32 sizeValuesIndex
 Defines the index of the set of values used to specify the size of markers.
 
SoSFInt32 zValuesIndex
 Defines the index of the set of values used to specify a z-coordinate for markers.
 
SoMFVec3f scaleFactor
 Defines a possibly non uniform scale applied to each marker.
 
- 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.
 

Additional Inherited Members

- 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)
 

Detailed Description

MeshViz Class to build a 2D generalized scatter.

Builds a 2D generalized scatter on 1D mesh (PoIrregularMesh1D or PoRegularMesh1D). A generalized scatter representation is a marker field representation where each marker is defined by a sub-scene graph. The field markers is used to define the sub-scene graph of each marker. If the number of sub-scene graphs is inferior to the number of markers to draw, they are cyclically used. The field scaleFactor defines a possibly non uniform scale applied to each marker. If the number of scales is inferior to the number of markers to draw, they are cyclically used. This scaleFactor can combined with a set of values (sizeValuesIndex), to fix the final size of markers. The abscissas of the markers 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. Furthemore a value-set of the current mesh 1D, though the field zValuesIndex, can be used to define a depth for each marker. 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 interpretation of colorBinding is the following :

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

FILE FORMAT/DEFAULT

    PoGeneralizedScatter {
    colorBinding INHERITED
    yValuesIndex 0
    colorValuesIndex 1
    material NULL
    markers NULL
    sizeValuesIndex -1
    zValuesIndex -1
    scaleFactor 1 1 1
    }

    CATALOG PARTS

    PoGeneralizedScatter {

    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 scatter

    Contains a list of couple SoMaterial and sub-scene graph containing  the markers if the field colorBinding is different from INHERITED, a list of sub-scene graphs otherwise.

    }

    }

    Definition at line 83 of file PoGeneralizedScatter.h.

Constructor & Destructor Documentation

◆ PoGeneralizedScatter()

PoGeneralizedScatter::PoGeneralizedScatter ( )

Constructor.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoGeneralizedScatter::getClassNodekitCatalog ( )
static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoGeneralizedScatter::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getNodekitCatalog()

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

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoChart.

◆ getTypeId()

virtual SoType PoGeneralizedScatter::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from PoChart.

Member Data Documentation

◆ markers

SoMFNode PoGeneralizedScatter::markers

Defines the sub-scene graphs used for each marker.

If the number of sub-scene graphs is inferior to the number of markers to draw, they are cyclically used.

Definition at line 100 of file PoGeneralizedScatter.h.

◆ scaleFactor

SoMFVec3f PoGeneralizedScatter::scaleFactor

Defines a possibly non uniform scale applied to each marker.

If the number of scales is inferior to the number of markers to draw, they are cyclically used. Each scale values are combined to values of the set defined by the field sizeValuesIndex. For instance, if a value from the selected values-set (with sizeValuesIndex) is equals to 0.5, and the scaleFactor is (2, 1, 2), the size of the marker will be (1, 0.5, 1). If no size is specified (sizeValuesIndex = -1), only a non uniform scale (2, 1, 2) is applied to the original marker.

Definition at line 126 of file PoGeneralizedScatter.h.

◆ sizeValuesIndex

SoSFInt32 PoGeneralizedScatter::sizeValuesIndex

Defines the index of the set of values used to specify the size of markers.

If sizeValuesIndex = -1, only the scaleFactor is applied to each marker.

Definition at line 107 of file PoGeneralizedScatter.h.

◆ zValuesIndex

SoSFInt32 PoGeneralizedScatter::zValuesIndex

Defines the index of the set of values used to specify a z-coordinate for markers.

If zValuesIndex = -1, the z-coordinate used is 0.

Definition at line 113 of file PoGeneralizedScatter.h.


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