Open Inventor Release 2023.2.2
 
Loading...
Searching...
No Matches
PoGroup6Axis3 Class Reference

MeshViz Class to build a group of six axes. More...

#include <MeshViz/graph/PoGroup6Axis3.h>

+ Inheritance diagram for PoGroup6Axis3:

Public Types

enum  AxisType {
  LINEAR ,
  LOGARITHMIC
}
 Type of axis. 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.
 
 PoGroup6Axis3 ()
 Default constructor.
 
 PoGroup6Axis3 (const SbVec3f &_start, const SbVec3f &_end, AxisType _xAxisType, AxisType _yAxisType, AxisType _zAxisType, const char *xTtle=NULL, const char *yTtle=NULL, const char *zTtle=NULL)
 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 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

SoSFVec3f start
 Start point of the cube.
 
SoSFVec3f end
 End point of the cube.
 
SoSFVec3f gradStart
 Defines the value of the graduation (tick label) corresponding to the starting point of this group of axes.
 
SoSFVec3f gradEnd
 Defines the value of the graduation (tick label) corresponding to the end point of this group of axes.
 
SoSFString xTitle
 Title of the X axis.
 
SoSFString yTitle
 Title of the Y axis.
 
SoSFString zTitle
 Title of the Z axis.
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

MeshViz Class to build a group of six axes.

This class builds a group of six axes. This group contains two parallel X-axes, two parallel Y-axes and two parallel Z-axes.

The graduations of these axes are defined by the fields gradStart and gradEnd. However if these fields are equal, the fields start and end are used to define the graduation values.

FILE FORMAT/DEFAULT

    PoGroup6Axis3 {
    start 0 0 0
    end 1 1 1
    gradStart 0 0 0
    gradEnd 0 0 0
    xTitle ""
    yTitle ""
    zTitle ""
    }

    CATALOG PARTS

      PoGroup6Axis3 {
        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.
          PoLinearAxis/PoLogAxis xUpAxis
          Corresponds to the up x-axis.
          PoLinearAxis/PoLogAxis xDownAxis
          Corresponds to the down x-axis.
          PoLinearAxis/PoLogAxis yLeftAxis
          Corresponds to the left y-axis.
          PoLinearAxis/PoLogAxis yRightAxis
          Corresponds to the right y-axis.
          PoLinearAxis/PoLogAxis zUpAxis
          Corresponds to the up z-axis.
          PoLinearAxis/PoLogAxis zDownAxis
          Corresponds to the down z-axis.
        }
      }

    Definition at line 65 of file PoGroup6Axis3.h.

Member Enumeration Documentation

◆ AxisType

Type of axis.

Enumerator
LINEAR 

Linear axis.

LOGARITHMIC 

Logarithmic axis.

Definition at line 83 of file PoGroup6Axis3.h.

Constructor & Destructor Documentation

◆ PoGroup6Axis3() [1/2]

PoGroup6Axis3::PoGroup6Axis3 ( )
inline

Default constructor.

Definition at line 150 of file PoGroup6Axis3.h.

◆ PoGroup6Axis3() [2/2]

PoGroup6Axis3::PoGroup6Axis3 ( const SbVec3f _start,
const SbVec3f _end,
AxisType  _xAxisType,
AxisType  _yAxisType,
AxisType  _zAxisType,
const char *  xTtle = NULL,
const char *  yTtle = NULL,
const char *  zTtle = NULL 
)
inline

Constructor.

(By default the 6 axes are linear).

Definition at line 157 of file PoGroup6Axis3.h.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoGroup6Axis3::getClassNodekitCatalog ( )
static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoGroup6Axis3::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getNodekitCatalog()

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

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoBaseAxis.

◆ getTypeId()

virtual SoType PoGroup6Axis3::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from PoBaseAxis.

◆ rebuild()

virtual void PoGroup6Axis3::rebuild ( )
virtual

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

Member Data Documentation

◆ end

SoSFVec3f PoGroup6Axis3::end

End point of the cube.

Definition at line 106 of file PoGroup6Axis3.h.

◆ gradEnd

SoSFVec3f PoGroup6Axis3::gradEnd

Defines the value of the graduation (tick label) corresponding to the end point of this group of axes.

See PoCartesianAxis::gradEnd for details.

Since Open Inventor 9.5.1

Definition at line 126 of file PoGroup6Axis3.h.

◆ gradStart

SoSFVec3f PoGroup6Axis3::gradStart

Defines the value of the graduation (tick label) corresponding to the starting point of this group of axes.

See PoCartesianAxis::gradStart for details.

Since Open Inventor 9.5.1

Definition at line 116 of file PoGroup6Axis3.h.

◆ start

SoSFVec3f PoGroup6Axis3::start

Start point of the cube.

Definition at line 101 of file PoGroup6Axis3.h.

◆ xTitle

SoSFString PoGroup6Axis3::xTitle

Title of the X axis.

Empty by default.

Definition at line 131 of file PoGroup6Axis3.h.

◆ yTitle

SoSFString PoGroup6Axis3::yTitle

Title of the Y axis.

Empty by default.

Definition at line 136 of file PoGroup6Axis3.h.

◆ zTitle

SoSFString PoGroup6Axis3::zTitle

Title of the Z axis.

Empty by default.

Definition at line 141 of file PoGroup6Axis3.h.


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