Abstract class for axis representations. More...
#include <MeshViz/graph/PoAxis.h>
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. | |
void | setMiscTextAttr (PbMiscTextAttr *textAttr) |
Sets a reference to PbMiscTextAttr object for miscellaneous text attributes. | |
const PbMiscTextAttr * | getMiscTextAttr () const |
Gets a reference to PbMiscTextAttr object for miscellaneous text attributes. | |
void | getGrad (Visibility &visibility, GradPosition &position, TextPath &path, SbString &fontName, float &fontSize, float &distAxis, SbBool &addStringVisibility, SbString &addString) const |
Gets the graduations axis attributes computed by the last axis rebuilding. | |
void | getMargin (MarginType &type, float &start, float &end) const |
Gets the margin axis attributes computed by the last axis rebuilding. | |
void | getTitle (Visibility &visibility, TitlePosition &position, TextPath &path, SbString &fontName, float &fontSize, float &distAxis, SbString &string) const |
Gets the title axis attributes computed by the last axis rebuilding. | |
void | getGrid (Visibility &visibility, float &lengthGradSide, float &lengthGradOtherSide) const |
Gets the grid axis attributes computed by the last axis rebuilding. | |
void | getArrow (Visibility &visibility, float &height, float &length) const |
Gets the arrow axis attributes computed by the last axis rebuilding. | |
void | getTick (Visibility &visibility, TickPosition &position, float &mainLength, float &subLength, TickSubDef &def, unsigned short &numOrPeriod, unsigned short &firstGrad, unsigned short &lastGrad) const |
Gets the tick axis attributes computed by the last axis rebuilding. | |
AxisReverse | getReverseFlag () const |
Gets the reverse flag axis attributes computed by the last axis 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 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 PoBaseAxis | |
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 | |
SoSFEnum | gradVisibility |
Graduations visibility. | |
SoSFEnum | gradPosition |
Graduations position. | |
SoSFEnum | gradPath |
Graduations path. | |
SoSFString | gradFontName |
Graduations font name. | |
SoSFFloat | gradFontSize |
Font size of the graduations. | |
SoSFFloat | gradDistAxis |
Distance from the graduations to the axis. | |
SoSFBool | gradAddStringVisibility |
Specify the visibility of a string concatenated with the graduations. | |
SoSFString | gradAddString |
String to be concatenated. | |
SoSFEnum | marginType |
Relative or absolute margin. | |
SoSFFloat | marginStart |
Margin at the start of the axis. | |
SoSFFloat | marginEnd |
Margin at the end of the axis. | |
SoSFEnum | titleVisibility |
Visibility of the title. | |
SoSFEnum | titlePosition |
Position of the title. | |
SoSFEnum | titlePath |
Path of the title. | |
SoSFString | titleFontName |
Title font name. | |
SoSFFloat | titleFontSize |
Font size of the title. | |
SoSFFloat | titleDistAxis |
Distance from the title to the axis. | |
SoSFString | titleString |
Title string. | |
SoSFEnum | gridVisibility |
Grid lines visibility. | |
SoSFFloat | gridLengthGradSide |
Grid lines length side graduation texts. | |
SoSFFloat | gridLengthGradOtherSide |
Grid lines length other side graduation texts. | |
SoSFEnum | arrowVisibility |
Arrow visibility. | |
SoSFFloat | arrowHeight |
Arrow height. | |
SoSFFloat | arrowLength |
Arrow length. | |
SoSFEnum | tickVisibility |
Tick marks visibility. | |
SoSFEnum | tickPosition |
Position of the tick marks. | |
SoSFFloat | tickMainLength |
Main graduations ticks length. | |
SoSFFloat | tickSubLength |
Secondary graduations ticks length. | |
SoSFEnum | tickSubDef |
Secondary graduations tick definition. | |
SoSFUShort | tickNumOrPeriod |
Number of secondary graduations (tickSubDef = NUM_SUB_TICK), or period of texts of graduations (tickSubDef = PERIOD_MAIN_TICK). | |
SoSFUShort | tickFirstGrad |
First graduation to display. | |
SoSFUShort | tickLastGrad |
Last graduation to display (number starting with the ending one). | |
SoSFEnum | reverseFlag |
Allow to reverse the writing path of all axis texts. | |
Public Attributes inherited from SoBaseKit | |
SoSFBool | boundingBoxIgnoring |
Whether to ignore this node during bounding box traversal. | |
Abstract class for axis representations.
This class groups all common methods and all common fields of all axes. Some enumerations are named DEPEND, in such a case, the choice of these values is done when building the axis.
All axis 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).
enum PoAxis::AxisReverse |
enum PoAxis::GradPosition |
enum PoAxis::MarginType |
enum PoAxis::TextPath |
enum PoAxis::TickPosition |
enum PoAxis::TickSubDef |
enum PoAxis::Visibility |
void PoAxis::getArrow | ( | Visibility & | visibility, |
float & | height, | ||
float & | length | ||
) | const |
Gets the arrow axis attributes computed by the last axis rebuilding.
If the axis have never been built, the method return the value of the equivalent field.
|
static |
Returns the SoNodekitCatalog for this class.
|
static |
Returns the type identifier for this class.
void PoAxis::getGrad | ( | Visibility & | visibility, |
GradPosition & | position, | ||
TextPath & | path, | ||
SbString & | fontName, | ||
float & | fontSize, | ||
float & | distAxis, | ||
SbBool & | addStringVisibility, | ||
SbString & | addString | ||
) | const |
Gets the graduations axis attributes computed by the last axis rebuilding.
If the axis have never been built, the method return the value of the equivalent field.
void PoAxis::getGrid | ( | Visibility & | visibility, |
float & | lengthGradSide, | ||
float & | lengthGradOtherSide | ||
) | const |
Gets the grid axis attributes computed by the last axis rebuilding.
If the axis have never been built, the method return the value of the equivalent field.
void PoAxis::getMargin | ( | MarginType & | type, |
float & | start, | ||
float & | end | ||
) | const |
Gets the margin axis attributes computed by the last axis rebuilding.
If the axis have never been built, the method return the value of the equivalent field.
const PbMiscTextAttr * PoAxis::getMiscTextAttr | ( | ) | const |
Gets a reference to PbMiscTextAttr object for miscellaneous text attributes.
|
virtual |
Returns the SoNodekitCatalog for this instance.
Reimplemented from PoBaseAxis.
Reimplemented in PoAngularAxis, PoCartesianAxis, PoGenAxis, PoLinearAxis, PoLogAxis, PoPolarAxis, PoPolarLinAxis, PoPolarLogAxis, and PoTimeAxis.
AxisReverse PoAxis::getReverseFlag | ( | ) | const |
Gets the reverse flag axis attributes computed by the last axis rebuilding.
If the axis have never been built, the method return the value of the equivalent field.
void PoAxis::getTick | ( | Visibility & | visibility, |
TickPosition & | position, | ||
float & | mainLength, | ||
float & | subLength, | ||
TickSubDef & | def, | ||
unsigned short & | numOrPeriod, | ||
unsigned short & | firstGrad, | ||
unsigned short & | lastGrad | ||
) | const |
Gets the tick axis attributes computed by the last axis rebuilding.
If the axis have never been built, the method return the value of the equivalent field.
void PoAxis::getTitle | ( | Visibility & | visibility, |
TitlePosition & | position, | ||
TextPath & | path, | ||
SbString & | fontName, | ||
float & | fontSize, | ||
float & | distAxis, | ||
SbString & | string | ||
) | const |
Gets the title axis attributes computed by the last axis rebuilding.
If the axis have never been built, the method return the value of the equivalent field.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from PoBaseAxis.
Reimplemented in PoAngularAxis, PoCartesianAxis, PoGenAxis, PoLinearAxis, PoLogAxis, PoPolarAxis, PoPolarLinAxis, PoPolarLogAxis, and PoTimeAxis.
void PoAxis::setMiscTextAttr | ( | PbMiscTextAttr * | textAttr | ) |
Sets a reference to PbMiscTextAttr object 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.
SoSFFloat PoAxis::arrowHeight |
SoSFFloat PoAxis::arrowLength |
SoSFEnum PoAxis::arrowVisibility |
Arrow visibility.
Use enum Visibility. Default is VISIBILITY_DEPEND.
SoSFString PoAxis::gradAddString |
SoSFBool PoAxis::gradAddStringVisibility |
SoSFFloat PoAxis::gradDistAxis |
SoSFString PoAxis::gradFontName |
SoSFFloat PoAxis::gradFontSize |
Font size of the graduations.
If this value is <= 0, the graduations font size is fixed at 0.04 if the graduations do not cross each other. This value is a percentage of the current domain (see PoBase description). As a result, the size of graduations text on the screen is the same regardless of text orientation. Default is 0.
SoSFEnum PoAxis::gradPath |
SoSFEnum PoAxis::gradPosition |
Graduations position.
Use enum GradPosition. Default is GRAD_DEPEND.
SoSFEnum PoAxis::gradVisibility |
Graduations visibility.
Use enum Visibility. Default is VISIBILITY_DEPEND.
SoSFFloat PoAxis::gridLengthGradOtherSide |
SoSFFloat PoAxis::gridLengthGradSide |
SoSFEnum PoAxis::gridVisibility |
Grid lines visibility.
Use enum Visibility. Default is VISIBILITY_DEPEND.
SoSFFloat PoAxis::marginEnd |
SoSFFloat PoAxis::marginStart |
SoSFEnum PoAxis::marginType |
Relative or absolute margin.
Use enum MarginType. Default is REL_MARGIN.
SoSFEnum PoAxis::reverseFlag |
Allow to reverse the writing path of all axis texts.
Use enum AxisReverse. Default is AXIS_REVERSE_DEPEND.
SoSFUShort PoAxis::tickFirstGrad |
SoSFUShort PoAxis::tickLastGrad |
SoSFFloat PoAxis::tickMainLength |
SoSFUShort PoAxis::tickNumOrPeriod |
SoSFEnum PoAxis::tickPosition |
Position of the tick marks.
Use enum TickPosition. Default is TICK_GRAD_SIDE.
SoSFEnum PoAxis::tickSubDef |
Secondary graduations tick definition.
The secondary graduations can be given either by a number or by a period. Use enum TickSubDef. Default is PERIOD_MAIN_TICK.
SoSFFloat PoAxis::tickSubLength |
SoSFEnum PoAxis::tickVisibility |
Tick marks visibility.
Use enum Visibility. Default is VISIBILITY_DEPEND.
SoSFFloat PoAxis::titleDistAxis |
SoSFString PoAxis::titleFontName |
SoSFFloat PoAxis::titleFontSize |
Font size of the title.
If this value is <= 0, the graduations font size is fixed at 0.055. This value is a percentage of the current domain (see PoBase description). As a result, the size of text on the screen is the same regardless of text orientation. Default is 0.
SoSFEnum PoAxis::titlePath |
SoSFEnum PoAxis::titlePosition |
Position of the title.
Use enum TitlePosition. Default is TITLE_DEPEND.
SoSFString PoAxis::titleString |
SoSFEnum PoAxis::titleVisibility |
Visibility of the title.
Use enum Visibility. Default is VISIBILITY_DEPEND.