Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
PoCoordinateSystemAxis Class Reference

MeshViz Class for a 3D axes system. More...

#include <MeshViz/graph/PoCoordinateSystemAxis.h>

+ Inheritance diagram for PoCoordinateSystemAxis:

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.
 
 PoCoordinateSystemAxis ()
 Default constructor.
 
 PoCoordinateSystemAxis (const SbVec3f &_start, const SbVec3f &_end, const char *_xTitle, const char *_yTitle, const char *_zTitle, float _arrowLengthFactor, float _titleTranslationFactor)
 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 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 of the coordinate system.
 
SoSFVec3f end
 End of the coordinate system.
 
SoSFString xTitle
 String to be displayed at the end of the X coordinate vector.
 
SoSFString yTitle
 String to be displayed at the end of the Y coordinate vector.
 
SoSFString zTitle
 String to be displayed at the end of the Z coordinate vector.
 
SoSFFloat arrowLengthFactor
 Arrow length scale factor.
 
SoSFFloat titleTranslationFactor
 Translation factor of the titles (as function of the length of each vector).
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Additional Inherited Members

- 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 for a 3D axes system.

Class to build an axes system. It is composed of three vectors, each having a title string at its extremity. A multiplicative factor translates each title string according to each vector length and another one defines the arrow length of vectors relative to the vector length.

FILE FORMAT/DEFAULT

    PoCoordinateSystemAxis {
    start 0 0 0
    end 1 1 1
    xTitle "X"
    yTitle "Y"
    zTitle "Z"
    arrowLengthFactor 0.05
    titleTranslationFactor 0
    }

    CATALOG PARTS

      PoCoordinateSystemAxis {
        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.
          PoArrow xArrow
          Corresponds to the arrow of the x-axis.
          PoArrow yArrow
          Corresponds to the arrow of the y-axis.
          PoArrow zArrow
          Corresponds to the arrow of the z-axis.

          Separator xTitleTextSep {
          Contains properties and shapes to draw text of the x-axis.
            AppearanceKit xTitleTextApp
            Specifies the appearance of text of the x-axis.
            Group xTitleText
            Contains a SoText2 shape to draw text of the x-axis.
          }

          Separator yTitleTextSep {
          Contains properties and shapes to draw text of the y-axis.
            AppearanceKit yTitleTextApp
            Specifies the appearance of text of the y-axis.
            Group yTitleText
            Contains a SoText2 shape to draw text of the y-axis.
          }

          Separator zTitleTextSep {
          Contains properties and shapes to draw text of the z-axis.
            AppearanceKit zTitleTextApp
            Specifies the appearance of text of the z-axis.
            Group zTitleText
            Contains a SoText2 shape to draw the text of the z-axis.
          }
        }
      }


    Definition at line 61 of file PoCoordinateSystemAxis.h.

Constructor & Destructor Documentation

◆ PoCoordinateSystemAxis() [1/2]

PoCoordinateSystemAxis::PoCoordinateSystemAxis ( )
inline

Default constructor.

Definition at line 130 of file PoCoordinateSystemAxis.h.

◆ PoCoordinateSystemAxis() [2/2]

PoCoordinateSystemAxis::PoCoordinateSystemAxis ( const SbVec3f _start,
const SbVec3f _end,
const char *  _xTitle,
const char *  _yTitle,
const char *  _zTitle,
float  _arrowLengthFactor,
float  _titleTranslationFactor 
)
inline

Constructor.

Definition at line 137 of file PoCoordinateSystemAxis.h.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoCoordinateSystemAxis::getClassNodekitCatalog ( )
static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoCoordinateSystemAxis::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getNodekitCatalog()

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

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoGraphMaster.

◆ getTypeId()

virtual SoType PoCoordinateSystemAxis::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from PoGraphMaster.

◆ rebuild()

virtual void PoCoordinateSystemAxis::rebuild ( )
virtual

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

Member Data Documentation

◆ arrowLengthFactor

SoSFFloat PoCoordinateSystemAxis::arrowLengthFactor

Arrow length scale factor.

This is the ratio between the length of the arrow and the length of one of the vectors. This value is normally less than 1. 0.05 by default.

Definition at line 116 of file PoCoordinateSystemAxis.h.

◆ end

SoSFVec3f PoCoordinateSystemAxis::end

End of the coordinate system.

(1,1,1) by default.

Definition at line 95 of file PoCoordinateSystemAxis.h.

◆ start

SoSFVec3f PoCoordinateSystemAxis::start

Start of the coordinate system.

(0,0,0) by default.

Definition at line 90 of file PoCoordinateSystemAxis.h.

◆ titleTranslationFactor

SoSFFloat PoCoordinateSystemAxis::titleTranslationFactor

Translation factor of the titles (as function of the length of each vector).

0 by default.

Definition at line 121 of file PoCoordinateSystemAxis.h.

◆ xTitle

SoSFString PoCoordinateSystemAxis::xTitle

String to be displayed at the end of the X coordinate vector.

"X" by default.

Definition at line 100 of file PoCoordinateSystemAxis.h.

◆ yTitle

SoSFString PoCoordinateSystemAxis::yTitle

String to be displayed at the end of the Y coordinate vector.

"Y" by default.

Definition at line 105 of file PoCoordinateSystemAxis.h.

◆ zTitle

SoSFString PoCoordinateSystemAxis::zTitle

String to be displayed at the end of the Z coordinate vector.

"Z" by default.

Definition at line 110 of file PoCoordinateSystemAxis.h.


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