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

MeshViz Class to build an angular axis. More...

#include <MeshViz/graph/PoAngularAxis.h>

+ Inheritance diagram for PoAngularAxis:

Public Types

enum  GradFit {
  GRAD_FIT ,
  GRAD_UNFIT
}
 Enumerations. More...
 
- Public Types inherited from PoAxis
enum  Visibility {
  VISIBILITY_OFF ,
  VISIBILITY_ON ,
  VISIBILITY_DEPEND
}
 Enumerations. More...
 
enum  TextPath {
  PATH_RIGHT ,
  PATH_LEFT ,
  PATH_UP ,
  PATH_DOWN ,
  PATH_DEPEND
}
 Text path type. More...
 
enum  GradPosition {
  GRAD_ABOVE ,
  GRAD_BELOW ,
  GRAD_DEPEND
}
 Graduation position type. More...
 
enum  MarginType {
  REL_MARGIN ,
  FIXED_MARGIN
}
 Margin type. More...
 
enum  TickPosition {
  TICK_GRAD_SIDE ,
  TICK_GRAD_OTHER_SIDE ,
  TICK_ACROSS_AXIS
}
 Tick position type. More...
 
enum  TitlePosition {
  TITLE_MIDDLE ,
  TITLE_END ,
  TITLE_DEPEND
}
 Title position type. More...
 
enum  TickSubDef {
  NUM_SUB_TICK ,
  PERIOD_MAIN_TICK
}
 Sub-tick type. More...
 
enum  AxisReverse {
  AXIS_NO_REVERSE ,
  AXIS_REVERSE ,
  AXIS_REVERSE_DEPEND
}
 Axis reverse type. 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.
 
 PoAngularAxis ()
 Default constructor.
 
 PoAngularAxis (float _offset, float _startAngle, float _endAngle, float _radius, float _angleStep)
 Constructor.
 
virtual void rebuild ()
 Forces node-kit rebuilding.
 
float getAngleStep () const
 Returns the current angle step (the step computed can be different from the associated field).
 
- Public Member Functions inherited from PoAxis
void setMiscTextAttr (PbMiscTextAttr *textAttr)
 Sets a reference to PbMiscTextAttr object for miscellaneous text attributes.
 
const PbMiscTextAttrgetMiscTextAttr () 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 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 PoAxis
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 PoBaseAxis
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

SoSFFloat offset
 Offset for the axis in radians.
 
SoSFFloat startAngle
 Angle in radians of the origin of the axis.
 
SoSFFloat endAngle
 Angle in radians of the end of the axis.
 
SoSFFloat radius
 Radius of the axis.
 
SoSFFloat angleStep
 Angular distance in radians between two graduations.
 
SoSFEnum gradFit
 This flag indicates if the first graduation is rounded or not.
 
- Public Attributes inherited from PoAxis
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.
 

Detailed Description

MeshViz Class to build an angular axis.

This class builds an angular axis in the plane XY. The axis is generated between (startAngle + offset) and (endEngle + offset) in counter-clockwise. It is centered at (0,0). An angle step defines the angular distance between two graduations. Graduations are displayed in degrees. The inherited field reverseFlag is not used.

CATALOG PARTS

    PoAngularAxis {
      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.
        MatrixTransform transform (from PoAxis)
        Not used.
          Separator bodySep (from PoAxis) {
          Contains properties and shapes to draw the body of the axis.
            AppearanceKit bodyApp (from PoAxis)
            Specifies the appearance of the body of the axis.
            Group body (from PoAxis)
            Contains a SoLineSet shape to draw the body of the axis.
          }

          Separator arrowSep (from PoAxis) {
          Contains properties and shapes to draw the arrow.
            AppearanceKit arrowApp (from PoAxis)
            Specifies the appearance of the arrow.
            Group arrow (from PoAxis)
            Contains a SoFaceSet shape to draw the arrow.
          }
          Separator subGradTickSep (from PoAxis) {
          Contains properties and shapes to draw sub-graduation tick.
            AppearanceKit subGradTickApp (from PoAxis)
            Specifies the appearance of sub-graduation tick.
            Group subGradTick (from PoAxis)
            Contains a SoLineSet shape to draw sub-graduation tick.
          }

          Separator subGradGridSep (from PoAxis){
          Contains properties and shapes to draw sub-graduation grid.
            AppearanceKit subGradGridApp (from PoAxis)
            Specifies the appearance of sub-graduation grid.
            Group subGradGrid (from PoAxis)
            Contains a SoLineSet shape to draw sub-graduation grid.
          }

          Separator mainGradTickSep (from PoAxis){
          Contains properties and shapes to draw main-graduation tick.
            AppearanceKit mainGradTickApp (from PoAxis)
            Specifies the appearance of main-graduation tick.
            Group mainGradTick (from PoAxis)
            Contains a SoLineSet shape to draw main-graduation tick.
          }

          Separator mainGradGridSep (from PoAxis){
          Contains properties and shapes to draw main-graduation grid.
            AppearanceKit mainGradGridApp (from PoAxis)
            Specifies the appearance of main-graduation grid.
            Group mainGradGrid (from PoAxis)
            Contains a SoLineSet shape to draw main-graduation grid.
          }

          Separator mainGradTextSep (from PoAxis) {
          Contains properties and shapes to draw main-graduation text.
            AppearanceKit mainGradTextApp (from PoAxis)
            Specifies the appearance of main-graduation text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.
            Group mainGradText (from PoAxis)
            Contains a list of SoAnnoText3 shapes to draw main-graduation text.
          }
          Separator titleSep (from PoAxis) {
          Contains properties and shapes to draw title text.
            AppearanceKit titleApp (from PoAxis)
            Specifies the appearance of title text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.
            Group title (from PoAxis)
            Contains a SoAnnoText3 shape to draw title.
          }
        }
      }

    Definition at line 54 of file PoAngularAxis.h.

    Member Enumeration Documentation

    ◆ GradFit

    Enumerations.

    First graduation rounded or not.

    Enumerator
    GRAD_FIT 

    The first graduation is rounded.

    GRAD_UNFIT 

    The first graduation is not rounded.

    Definition at line 68 of file PoAngularAxis.h.

    Constructor & Destructor Documentation

    ◆ PoAngularAxis() [1/2]

    PoAngularAxis::PoAngularAxis ( )

    Default constructor.

    ◆ PoAngularAxis() [2/2]

    PoAngularAxis::PoAngularAxis ( float  _offset,
    float  _startAngle,
    float  _endAngle,
    float  _radius,
    float  _angleStep 
    )
    inline

    Constructor.

    Definition at line 129 of file PoAngularAxis.h.

    Member Function Documentation

    ◆ getAngleStep()

    float PoAngularAxis::getAngleStep ( ) const

    Returns the current angle step (the step computed can be different from the associated field).

    ◆ getClassNodekitCatalog()

    static const SoNodekitCatalog * PoAngularAxis::getClassNodekitCatalog ( )
    static

    Returns the SoNodekitCatalog for this class.

    ◆ getClassTypeId()

    static SoType PoAngularAxis::getClassTypeId ( )
    static

    Returns the type identifier for this class.


    ◆ getNodekitCatalog()

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

    Returns the SoNodekitCatalog for this instance.

    Reimplemented from PoAxis.

    ◆ getTypeId()

    virtual SoType PoAngularAxis::getTypeId ( ) const
    virtual

    Returns the type identifier for this specific instance.

    Reimplemented from PoAxis.

    ◆ rebuild()

    virtual void PoAngularAxis::rebuild ( )
    virtual

    Forces node-kit rebuilding.

    See PoBase.

    Reimplemented from PoBase.

    Member Data Documentation

    ◆ angleStep

    SoSFFloat PoAngularAxis::angleStep

    Angular distance in radians between two graduations.

    If this value is <= 0, the angle step is automatically calculated according to the ratio radius and the current domain (see PoBase description).

    Definition at line 109 of file PoAngularAxis.h.

    ◆ endAngle

    SoSFFloat PoAngularAxis::endAngle

    Angle in radians of the end of the axis.

    Definition at line 97 of file PoAngularAxis.h.

    ◆ gradFit

    SoSFEnum PoAngularAxis::gradFit

    This flag indicates if the first graduation is rounded or not.

    (GRAD_UNFIT by default).

    Definition at line 115 of file PoAngularAxis.h.

    ◆ offset

    SoSFFloat PoAngularAxis::offset

    Offset for the axis in radians.

    (However the graduations begin at startAngle to endAngle).

    Definition at line 87 of file PoAngularAxis.h.

    ◆ radius

    SoSFFloat PoAngularAxis::radius

    Radius of the axis.

    Definition at line 102 of file PoAngularAxis.h.

    ◆ startAngle

    SoSFFloat PoAngularAxis::startAngle

    Angle in radians of the origin of the axis.

    Definition at line 92 of file PoAngularAxis.h.


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