Open Inventor Release 2024.2.1
 
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
PoCircleArc3CtrPtAngle Class Reference
MeshViz » Graph » Misc

MeshViz Class to build a 3D circle arc. More...

#include <MeshViz/graph/PoCircleArc3CtrPtAngle.h>

+ Inheritance diagram for PoCircleArc3CtrPtAngle:

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.
 
 PoCircleArc3CtrPtAngle ()
 Default constructor.
 
 PoCircleArc3CtrPtAngle (const SbVec3f &_center, const SbVec3f &_startPoint, float _angle, const SbVec3f &_normal)
 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 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.
 
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 &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 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 PoCircleArc3
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

SoSFVec3f center
 Circle center.
 
SoSFVec3f startPoint
 Start point of the arc.
 
SoSFFloat angle
 Arc angle.
 
SoSFVec3f normal
 Normal to the plane of circle.
 
- Public Attributes inherited from PoCircleArc3
SoSFEnum arcType
 Indicates if the arc is opened, closed by its extremities or closed by its center.
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Additional Inherited Members

- Public Types inherited from PoCircleArc3
enum  ArcType {
  OPENED ,
  END_CLOSE ,
  CENTER_CLOSE
}
 Type of the circle arc. 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)
 

Detailed Description

MeshViz Class to build a 3D circle arc.

The circle arc is defined by its center, a start point , an angle and a normal vector to the circle plane.

FILE FORMAT/DEFAULT

    PoCircleArc3CtrPtAngle {
    arcType OPENED
    center 0 0 0
    startPoint 1 0 0
    angle 2PI
    normal 0 0 1
    }

    CATALOG PARTS

      PoCircleArc3CtrPtAngle {
        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.
            Group circleArc3 (from PoCircleArc3)
            Contains a SoFaceSet shape (arcType = END_CLOSE or arcType = CENTER_CLOSE) or SoLineSet shape (arcType = OPENED) to draw the circle arc.
          }
        }

      Definition at line 55 of file PoCircleArc3CtrPtAngle.h.

    Constructor & Destructor Documentation

    ◆ PoCircleArc3CtrPtAngle() [1/2]

    PoCircleArc3CtrPtAngle::PoCircleArc3CtrPtAngle ( )
    		inline

    Default constructor.

    Definition at line 91 of file PoCircleArc3CtrPtAngle.h.

    ◆ PoCircleArc3CtrPtAngle() [2/2]

    PoCircleArc3CtrPtAngle::PoCircleArc3CtrPtAngle ( const SbVec3f &  _center,
    const SbVec3f &  _startPoint,
    float  _angle,
    const SbVec3f &  _normal 
    )
    		inline

    Constructor.

    Definition at line 97 of file PoCircleArc3CtrPtAngle.h.

    Member Function Documentation

    ◆ getClassNodekitCatalog()

    static const SoNodekitCatalog * PoCircleArc3CtrPtAngle::getClassNodekitCatalog ( )
    		static

    Returns the SoNodekitCatalog for this class.

    ◆ getClassTypeId()

    static SoType PoCircleArc3CtrPtAngle::getClassTypeId ( )
    		static

    Returns the type identifier for this class.


    ◆ getNodekitCatalog()

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

    Returns the SoNodekitCatalog for this instance.

    Reimplemented from PoCircleArc3.

    ◆ getTypeId()

    virtual SoType PoCircleArc3CtrPtAngle::getTypeId ( ) const
    		virtual

    Returns the type identifier for this specific instance.

    Reimplemented from PoCircleArc3.

    ◆ rebuild()

    virtual void PoCircleArc3CtrPtAngle::rebuild ( )
    		virtual

    Forces node-kit rebuilding.

    See PoBase.

    Reimplemented from PoBase.

    Member Data Documentation

    ◆ angle

    SoSFFloat PoCircleArc3CtrPtAngle::angle

    Arc angle.

    2PI by default.

    Definition at line 77 of file PoCircleArc3CtrPtAngle.h.

    ◆ center

    SoSFVec3f PoCircleArc3CtrPtAngle::center

    Circle center.

    (0,0,0) by default.

    Definition at line 67 of file PoCircleArc3CtrPtAngle.h.

    ◆ normal

    SoSFVec3f PoCircleArc3CtrPtAngle::normal

    Normal to the plane of circle.

    (0,0,1) by default.

    Definition at line 82 of file PoCircleArc3CtrPtAngle.h.

    ◆ startPoint

    SoSFVec3f PoCircleArc3CtrPtAngle::startPoint

    Start point of the arc.

    (1,0,0) by default.

    Definition at line 72 of file PoCircleArc3CtrPtAngle.h.

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