#include <Inventor/nodekits/SoBaseKit.h>
Inheritance diagram for SoBaseKit::
Public Methods | |
SoBaseKit (void) | |
virtual const SoNodekitCatalog * | getNodekitCatalog (void) const |
virtual SoNode * | getPart (const SbName &partname, SbBool makeifneeded) |
SbString | getPartString (const SoBase *part) |
virtual SoNodeKitPath * | createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL) |
virtual SbBool | setPart (const SbName &partname, SoNode *from) |
SbBool | set (const char *namevaluepairliststring) |
SbBool | set (const char *partnamestring, const char *parameterstring) |
virtual void | doAction (SoAction *action) |
virtual void | callback (SoCallbackAction *action) |
virtual void | GLRender (SoGLRenderAction *action) |
virtual void | getBoundingBox (SoGetBoundingBoxAction *action) |
virtual void | getMatrix (SoGetMatrixAction *action) |
virtual void | handleEvent (SoHandleEventAction *action) |
virtual void | rayPick (SoRayPickAction *action) |
virtual void | search (SoSearchAction *action) |
virtual void | write (SoWriteAction *action) |
virtual void | getPrimitiveCount (SoGetPrimitiveCountAction *action) |
virtual SoChildList * | getChildren (void) const |
void | printDiagram (void) |
void | printSubDiagram (const SbName &rootname, int level) |
void | printTable (void) |
virtual void | addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) |
SbBool | forceChildDrivenWriteRefs (SoOutput *out) |
Static Public Methods | |
void | initClass (void) |
const SoNodekitCatalog * | getClassNodekitCatalog (void) |
SbBool | isSearchingChildren (void) |
void | setSearchingChildren (const SbBool newval) |
SoNode * | typeCheck (const SbName &partname, const SoType &parttype, SoNode *node) |
Protected Methods | |
virtual | ~SoBaseKit () |
virtual SoNode * | addToCopyDict (void) const |
virtual void | copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) |
SoGroup * | getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) |
virtual SoNode * | getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) |
virtual SoNodeKitPath * | createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) |
virtual SbBool | setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) |
void | createNodekitPartsList (void) |
void | createFieldList (void) |
virtual void | createDefaultParts (void) |
const SoNodekitParts * | getNodekitPartsList (void) const |
const SbList< SoSFNode *> & | getCatalogInstances (void) const |
void | catalogError (void) |
virtual SbBool | setUpConnections (SbBool onoff, SbBool doitalways=FALSE) |
virtual SbBool | readInstance (SoInput *in, unsigned short flags) |
virtual void | setDefaultOnNonWritingFields (void) |
void | countMyFields (SoOutput *out) |
virtual SbBool | setPart (const int partNum, SoNode *node) |
Static Protected Methods | |
const SoNodekitCatalog ** | getClassNodekitCatalogPtr (void) |
Protected Attributes | |
SoChildList * | children |
SbBool | connectionsSetUp |
FIXME, write class doc:
|
Constructor. |
|
Destructor. |
|
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Reimplemented from SoNode. Reimplemented in SoInteractionKit, SoSeparatorKit, SoShapeKit, SoWrapperKit, SoAppearanceKit, SoCameraKit, SoLightKit, SoSceneKit, SoDragger, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and SoTranslate2Dragger. |
|
Returns the nodekit catalog which defines the layout of this class' kit. |
|
Returns the nodekit catalog which defines the layout of this class' kit. |
|
Returns a pointer to the node part with partname.
If the part is not in the nodekit's catalog, return
If the part is in the catalog, has not been made and makeifneeded is FIXME: describe syntax for specifiying "paths". 19991205 mortene. |
|
FIXME: write function documentation |
|
FIXME: write function documentation |
|
FIXME: write function documentation Reimplemented in SoInteractionKit. |
|
FIXME: write function documentation |
|
FIXME: write function documentation |
|
This function performs the typical operation of a node for any action. Reimplemented from SoNode. |
|
Action method for SoCallbackAction. Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. Reimplemented from SoNode. Reimplemented in SoDragger. |
|
Action method for the SoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. Reimplemented from SoNode. Reimplemented in SoDragger, and SoTabPlaneDragger. |
|
Action method for the SoGetBoundingBoxAction. Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables. Reimplemented from SoNode. Reimplemented in SoDragger, and SoCenterballDragger. |
|
Action method for SoGetMatrixAction. Updates action by accumulating with the transformation matrix of this node (if any). Reimplemented from SoNode. Reimplemented in SoDragger, and SoCenterballDragger. |
|
Action method for SoHandleEventAction. Inspects the event data from action, and processes it if it is something which this node should react to. Nodes influencing relevant state variables for how event handling is done also overrides this method. Reimplemented from SoNode. Reimplemented in SoDragger. |
|
Action method for SoRayPickAction. Checks the ray specification of the action and tests for intersection with the data of the node. Nodes influencing relevant state variables for how picking is done also overrides this method. Reimplemented from SoNode. Reimplemented in SoDragger. |
|
Action method for SoSearchAction. Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction -- if any of the requested criteria is a miss, the search is not deemed successful for the node.
Reimplemented from SoNode. Reimplemented in SoDragger. |
|
Action method for SoWriteAction. Writes out a node object, and any connected nodes, engines etc, if necessary. Reimplemented from SoNode. Reimplemented in SoDragger. |
|
Action method for the SoGetPrimitiveCountAction. Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables. Reimplemented from SoNode. Reimplemented in SoDragger. |
|
Returns list of children for this node. Reimplemented from SoNode. |
|
Print out the full nodekit catalog structure. Useful for debugging. |
|
Print out the nodekit catalog structure from rootname and downwards in the catalog tree, with indentation starting at level. |
|
Write the complete nodekit catalog in table form. |
|
Overloaded from SoBase to make sure field connections into other field containers are also accounted for. Reimplemented from SoFieldContainer. |
|
Returns |
|
FIXME: write function documentation |
|
FIXME: write function documentation |
|
FIXME: write function documentation |
|
Returns the pointer to the pointer of the nodekit catalog for this class. |
|
Overloaded to also recurse on non-null part nodes. Reimplemented from SoNode. |
|
Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is This is the method that should be overridden by subclasses which needs to account for internal data that are not handled automatically. Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:
void MyCoinExtensionNode::copyContents(const SoFieldContainer * from, SbBool copyconnections) { // let parent superclasses do their thing (copy fields, copy // instance name, etc etc) SoNode::copyContents(from, copyconnections); // [..then copy internal data..] } Reimplemented from SoNode. Reimplemented in SoInteractionKit, SoRotateCylindricalDragger, and SoRotateSphericalDragger. |
|
FIXME: write function documentation |
|
FIXME: write function documentation |
|
Return path with nested SoNodeKit instances down in the catalog hierarchy given by partname.
If the trailing part has not been made and makeifneeded is
If leafcheck is
pathtoextend is a path through the nodekit instance catalog hierarchy, where we should pick up and continue to create the path from where pathtoextend terminates. If pathtoextend is
Returns |
|
FIXME: write function documentation |
|
Not part of the Coin API. It is supposed to create the SoNodekitParts class instance. Since this class can only be used by SoBaseKit (all members are private, with SoBaseKit as friend), we decided to not support this class, and solve the problem of recording which parts are created in an alternative way. |
|
Replaces the createNodekitPartsList() method. Sets up the list of SoSFNode fields with node pointers to the instances in our catalog. |
|
FIXME: write function documentation |
|
In Open Inventor, this method returns a pointer to a private class. It will always return
|
|
For internal use only. |
|
Obsoleted from the API in Coin. |
|
Sets up all internal connections for instances of this class. (This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.) Reimplemented in SoInteractionKit, SoSeparatorKit, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and SoTranslate2Dragger. |
|
This method is mainly intended for internal use during file import operations. It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.
flags is used internally during binary import when reading user extension nodes, group nodes or engines. Reimplemented from SoNode. Reimplemented in SoInteractionKit. |
|
(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.)
A virtual method that should call SoField::setDefault() with argument This is typically done when:
Reimplemented in SoInteractionKit, SoSeparatorKit, SoShapeKit, SoDragger, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, and SoTransformerDragger. |
|
Reference count connections to nodes in the catalog. |
|
Sets parts, updates nodekit scene graph, and makes sure graph is valid with respect to right siblings and parent. This method is virtual to enable subclasses to detect when a part changes value. This method is not part of the original SGI Open Inventor API, but is an extension specific to Coin. Reimplemented in SoInteractionKit. |
|
For internal use only. |
|
For internal use only. |