Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
PoHistogram Class Reference

MeshViz Abstract class for histogram representations. More...

#include <MeshViz/graph/PoHistogram.h>

+ Inheritance diagram for PoHistogram:

Public Types

enum  Type {
  X ,
  Y
}
 Type of orientation of the histogram's bars. More...
 
enum  Position {
  POS_TOP_OUT ,
  POS_TOP_IN ,
  POS_BOTTOM_OUT ,
  POS_BOTTOM_IN ,
  POS_RIGHT_OUT ,
  POS_RIGHT_IN ,
  POS_LEFT_OUT ,
  POS_LEFT_IN ,
  POS_CENTER ,
  POS_DEPEND
}
 Type of positions relative to a histogram bar. More...
 
enum  Visibility {
  VISIBILITY_OFF ,
  VISIBILITY_ON
}
 Type of visibility. More...
 
enum  TextPath {
  PATH_RIGHT ,
  PATH_LEFT ,
  PATH_UP ,
  PATH_DOWN ,
  PATH_DEPEND
}
 Type of text path. More...
 
enum  BarSpaceType {
  REL_SPACE ,
  FIXED_SPACE
}
 Type of spacing between bars. More...
 
enum  Coloring {
  COLOR_LIST ,
  DATA_MAPPING
}
 Type of coloration of the bars. 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.
 
void setMiscTextAttr (PbMiscTextAttr *textAttr)
 Sets a reference to a PbMiscTextAttr for miscellaneous text attributes.
 
const PbMiscTextAttrgetMiscTextAttr () const
 Gets a reference to a PbMiscTextAttr for miscellaneous text attributes.
 
void setDataMapping (PbDataMapping *dataMapping)
 Sets a reference to a PbDataMapping object to the association color-value for coloring the bars.
 
const PbDataMappinggetDataMapping () const
 Gets a reference to a PbDataMapping object to the association color-value for coloring the bars.
 
void setFormat (PbNumericDisplayFormat *format)
 Sets a reference to a PbNumericDisplayFormat object for the numerical display format of values of the histograms.
 
const PbNumericDisplayFormatgetFormat () const
 Gets a reference to a PbNumericDisplayFormat object for the numerical display format of values of the histograms.
 
- 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.
 
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 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

SoSFVec2f start
 Define the start point of the histogram.
 
SoSFFloat end
 Define the end point of the histogram.
 
SoSFEnum type
 Defines if the histogram is an X histogram (bars are perpendicular to the X- axis) or a Y histogram (bars are perpendicular to the Y-axis).
 
SoMFColor color
 Color list for the histogram bars.
 
SoSFEnum coloring
 Specifies how the histogram bars are colored.
 
SoSFEnum valueVisibility
 Values visibility.
 
SoSFEnum valuePosition
 Values position in relation to histogram bars.
 
SoSFEnum valuePath
 Values path.
 
SoSFFloat valueFontSize
 Font size of values.
 
SoSFString valueFontName
 Font name of values.
 
SoSFBool valueAddStringVisibility
 Visibility of the string concatenated to the values.
 
SoSFString valueAddString
 String to be concatenated.
 
SoSFEnum nameVisibility
 Bars names visibility.
 
SoSFEnum namePosition
 Bars names position in relation to histograms bars.
 
SoSFEnum namePath
 Bars names path.
 
SoSFFloat nameFontSize
 Font size of bars names.
 
SoSFString nameFontName
 Font name of bars names.
 
SoSFEnum barSpaceType
 Type of bar spacing.
 
SoSFFloat barSpaceValue
 Spacing value.
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

MeshViz Abstract class for histogram representations.

This class handles the start, the end, the values of the bars, the names of the bars and the bars spacing of a histogram.

All histogram texts depend on the current miscellaneous text attributes which define the font name, line length and so on. If the method setMiscTextAttr(textAttr) is called, the current miscellaneous text attributes are defined by "textAttr". Otherwise the current miscellaneous text attributes are specified in the current inherited state (cf property node PoMiscTextAttr).

All histogram numerical values depend on the current numerical display format. If the method setFormat(format) is called, the current numerical display format is "format". Otherwise the current numerical display format is specified in the current inherited state (cf property node PoNumericDisplayFormat).

If coloring = DATA_MAPPING, colors of histogram bars depend on the current data mapping. If the method setDataMapping(dataMapping) is called, the current data mapping is "dataMapping". Otherwise the current data mapping is specified in the current inherited state (cf property node PoDataMapping and its derived classes). If there is no current data-mapping (i.e setDataMapping() not called and no PoDataMapping node traversed before in the scene graph), all bars get the same color which is the inherited color.

Definition at line 72 of file PoHistogram.h.

Member Enumeration Documentation

◆ BarSpaceType

Type of spacing between bars.

Enumerator
REL_SPACE 

Relative histogram bar spacing.

FIXED_SPACE 

Fixed histogram bar spacing.

Definition at line 197 of file PoHistogram.h.

◆ Coloring

Type of coloration of the bars.

Enumerator
COLOR_LIST 

Histogram bars are colored by a list of colors.

DATA_MAPPING 

Histogram bars are colored by data mapping.

Definition at line 211 of file PoHistogram.h.

◆ Position

Type of positions relative to a histogram bar.

Enumerator
POS_TOP_OUT 

At the top outside the bar.

POS_TOP_IN 

At the top inside the bar.

POS_BOTTOM_OUT 

At the bottom outside the bar.

POS_BOTTOM_IN 

At the bottom inside the bar.

POS_RIGHT_OUT 

At the right outside the bar.

POS_RIGHT_IN 

At the right inside the bar.

POS_LEFT_OUT 

At the left outside the bar.

POS_LEFT_IN 

At the left inside the bar.

POS_CENTER 

Centered in the bar.

POS_DEPEND 

Depends on the type of histogram.

Definition at line 111 of file PoHistogram.h.

◆ TextPath

Type of text path.

Enumerator
PATH_RIGHT 

Writing from left to right.

PATH_LEFT 

Writing from right to left.

PATH_UP 

Writing from bottom to top.

PATH_DOWN 

Writing from top to bottom.

PATH_DEPEND 

Depends on the type of histogram.

Definition at line 171 of file PoHistogram.h.

◆ Type

Type of orientation of the histogram's bars.

Enumerator

Histogram bars are perpendicular to X-Axis.

Histogram bars are perpendicular to Y-Axis.

Definition at line 97 of file PoHistogram.h.

◆ Visibility

Type of visibility.

Enumerator
VISIBILITY_OFF 

Invisible.

VISIBILITY_ON 

Visible.

Definition at line 157 of file PoHistogram.h.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoHistogram::getClassNodekitCatalog ( )
static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoHistogram::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getDataMapping()

const PbDataMapping * PoHistogram::getDataMapping ( ) const

Gets a reference to a PbDataMapping object to the association color-value for coloring the bars.

◆ getFormat()

const PbNumericDisplayFormat * PoHistogram::getFormat ( ) const

Gets a reference to a PbNumericDisplayFormat object for the numerical display format of values of the histograms.

◆ getMiscTextAttr()

const PbMiscTextAttr * PoHistogram::getMiscTextAttr ( ) const

Gets a reference to a PbMiscTextAttr for miscellaneous text attributes.

◆ getNodekitCatalog()

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

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoGraphMaster.

Reimplemented in PoMultipleHistogram, and PoSingleHistogram.

◆ getTypeId()

virtual SoType PoHistogram::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from PoGraphMaster.

Reimplemented in PoMultipleHistogram, and PoSingleHistogram.

◆ setDataMapping()

void PoHistogram::setDataMapping ( PbDataMapping dataMapping)

Sets a reference to a PbDataMapping object to the association color-value for coloring the bars.

If this method is not called (or called passing NULL as argument), this is the data mapping defined in the current inherited state (defined with the property node PoDataMapping and its derived classes) which is used. This method is ignored if coloring = COLOR_LIST.

◆ setFormat()

void PoHistogram::setFormat ( PbNumericDisplayFormat format)

Sets a reference to a PbNumericDisplayFormat object for the numerical display format of values of the histograms.

If this method is not called (or called passing NULL as argument), this is the numerical display format defined in the current inherited state (defined with the property node PoNumericDisplayFormat) which is used.

◆ setMiscTextAttr()

void PoHistogram::setMiscTextAttr ( PbMiscTextAttr textAttr)

Sets a reference to a PbMiscTextAttr for miscellaneous text attributes.

If this method is not called (or called passing NULL as argument), this is the miscellaneous text attributes defined in the current inherited state (defined with the property node PoMiscTextAttr) which are used.

Member Data Documentation

◆ barSpaceType

SoSFEnum PoHistogram::barSpaceType

Type of bar spacing.

The spacing between bars modifies the thickness of the histogram bars.

Definition at line 338 of file PoHistogram.h.

◆ barSpaceValue

SoSFFloat PoHistogram::barSpaceValue

Spacing value.

If barSpaceType = REL_SPACE, real_spacing = barSpaceValue * width_bar, where width_bar is the distance between the histogram origin and the end point divided by the number of main bars. If barSpaceType = FIXED_SPACE, the real spacing is equal to barSpaceValue.

Definition at line 348 of file PoHistogram.h.

◆ color

SoMFColor PoHistogram::color

Color list for the histogram bars.

This field is used only if coloring = COLOR_LIST. If the number of colors is less than the number of bars, all the bars get the same color which is the inherited color.

Definition at line 249 of file PoHistogram.h.

◆ coloring

SoSFEnum PoHistogram::coloring

Specifies how the histogram bars are colored.

if coloring = COLOR_LIST, the bars are colored using the color list field color, otherwise the bars are colored according to their values (see the current data mapping for the association color-value at the header description).

Definition at line 257 of file PoHistogram.h.

◆ end

SoSFFloat PoHistogram::end

Define the end point of the histogram.

Definition at line 236 of file PoHistogram.h.

◆ nameFontName

SoSFString PoHistogram::nameFontName

Font name of bars names.

If the font is equal to its default value, the font used is the font of the current miscellaneous text attributes.

Definition at line 332 of file PoHistogram.h.

◆ nameFontSize

SoSFFloat PoHistogram::nameFontSize

Font size of bars names.

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 325 of file PoHistogram.h.

◆ namePath

SoSFEnum PoHistogram::namePath

Bars names path.

Use enum TextPath.

Definition at line 318 of file PoHistogram.h.

◆ namePosition

SoSFEnum PoHistogram::namePosition

Bars names position in relation to histograms bars.

Definition at line 312 of file PoHistogram.h.

◆ nameVisibility

SoSFEnum PoHistogram::nameVisibility

Bars names visibility.

Definition at line 307 of file PoHistogram.h.

◆ start

SoSFVec2f PoHistogram::start

Define the start point of the histogram.

Definition at line 231 of file PoHistogram.h.

◆ type

SoSFEnum PoHistogram::type

Defines if the histogram is an X histogram (bars are perpendicular to the X- axis) or a Y histogram (bars are perpendicular to the Y-axis).

Definition at line 242 of file PoHistogram.h.

◆ valueAddString

SoSFString PoHistogram::valueAddString

String to be concatenated.

Definition at line 300 of file PoHistogram.h.

◆ valueAddStringVisibility

SoSFBool PoHistogram::valueAddStringVisibility

Visibility of the string concatenated to the values.

Definition at line 295 of file PoHistogram.h.

◆ valueFontName

SoSFString PoHistogram::valueFontName

Font name of values.

If the font is equal to its default value, the font used is the font of the current miscellaneous text attributes.

Definition at line 290 of file PoHistogram.h.

◆ valueFontSize

SoSFFloat PoHistogram::valueFontSize

Font size of values.

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 283 of file PoHistogram.h.

◆ valuePath

SoSFEnum PoHistogram::valuePath

Values path.

Use enum TextPath.

Definition at line 275 of file PoHistogram.h.

◆ valuePosition

SoSFEnum PoHistogram::valuePosition

Values position in relation to histogram bars.

Definition at line 269 of file PoHistogram.h.

◆ valueVisibility

SoSFEnum PoHistogram::valueVisibility

Values visibility.

Definition at line 264 of file PoHistogram.h.


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