SoBaseKit Class Reference
[NodeKits]

Base class for all node kits. More...

#include <Inventor/nodekits/SoBaseKit.h>

Inheritance diagram for SoBaseKit:
SoNode SoGetView SoFieldContainer SoBase SoRefCounter SoTypedObject PoBase PoBaseView SoAppearanceKit SoCameraKit SoInteractionKit SoLightKit SoSceneKit SoSeparatorKit

List of all members.

Public Member Functions

virtual SoType getTypeId () const
virtual const SoNodekitCataloggetNodekitCatalog () const
 SoBaseKit ()
virtual SoNodegetPart (const SbName &partName, SbBool makeIfNeeded)
SbString getPartString (const SoBase *part)
virtual SoNodeKitPathcreatePathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
virtual SbBool setPart (const SbName &partName, SoNode *newPart)
SoNONUNICODE SbBool set (char *nameValuePairListString)
SbBool set (const SbString &nameValuePairListString)
SoNONUNICODE SbBool set (const char *partNameString, const char *parameterString)
SbBool set (const SbString &partNameString, const SbString &parameterString)

Static Public Member Functions

static SoType getClassTypeId ()
static const SoNodekitCataloggetClassNodekitCatalog ()
static void setSearchingChildren (SbBool newVal)
static SbBool isSearchingChildren ()

Public Attributes

SoSFBool boundingBoxIgnoring

Friends

class SoNodekitCatalogEntry
class SoNodekitParts
class SoV1BaseKit

Detailed Description

Base class for all node kits.

This is the base class from which all nodekit nodes are derived. Nodekits provide a convenient mechanism for creating groups of scene graph nodes with some larger meaning. When you create a shape node such as an indexed face set, for example, you almost always precede it with a coordinate node. You may also want to add a transform node or specify properties with material, drawing style, material binding, etc. Instead of creating each of these nodes individually and then arranging them into a subgraph, you can use a nodekit of the appropriate type (in this case, SoShapeKit).

Each class of nodekit has a nodekit catalog (SoNodekitCatalog) that describes the nodes in the subgraph, referred to as parts . The catalog has an entry for each part, with information such as the partName , partType , and nullByDefault (if FALSE the constructor creates it). The catalog also describes the arrangement of parts in the subgraph. (Other information is described below; a complete description is in the SoNodekitCatalog reference page.)

If we regard the scene graph arrangement as a branching tree, then the top node (root) of the arrangement is always the nodekit itself. The leaf nodes are those at the bottom (containing no children). Some leaves of the tree are defined in the catalog to be public parts, while other leaves are private . All non-leaf parts are considered internal to the nodekit structure and are marked private. Public parts are accessible; they may be requested, changed, or set by the programmer with member functions such as getPart(). Private parts are not accessible, so methods such as getPart() will have no effect on them. For example, if you call getPart() to retrieve a private part, NULL will be returned even when the part exists.

Every nodekit reference page has a Parts section describing the function of each public part it adds to those inherited from its parent class. Also, a Catalog Parts section has tables of often-needed information from the catalog (part type, etc.). These tables include all public parts, both new and inherited. Only the public parts of a nodekit are described in the reference pages. Nodekits take care of the rest for you; they automatically arrange the subgraph, creating and deleting the private parts when necessary. (The SoNodekitCatalog reference page has methods for finding out the part names and arrangement of all parts, both public and private.)

The nodekit catalog is a template shared by all instances of a class. They use the shared catalog as a guide when creating parts (i.e., constructing actual nodes), but each instance stores its own parts separately. Moreover, nodekits are not SoGroup nodes, and parts are added as hidden children ; you can only access parts with the methods of SoBaseKit and its derived classes.

Any public part may be retrieved with getPart(), installed with setPart(), or removed by giving a NULL argument to setPart(). Paths from the nodekit down to a part can be created by createPathToPart().

By default, parts are not created until the user requests or sets them. This keeps the subgraph uncluttered and efficient for traversal. Additionally, removing a part (setting it to NULL) has the extra effect of removing any internal parts that are no longer needed.

Since nodekits hide their children, any SoPath containing nodekits will end at the topmost nodekit. However, since nodekits may be nested within other nodekits, you may wish to cast an (SoPath *) into an (SoNodeKitPath *). The methods of SoNodeKitPath allow you to view all nodekits that lie on the path (see the reference page for SoNodeKitPath).

Public parts in the nodekit catalog fall into three categories:

  1. regular nodes
  2. nodekits , or nested nodekits (which may nest recursively). Any node which is public in a nested nodekit is accessible to the higher level nodekit(s) that contains it. The description of getPart() below shows how to refer to nested parts by name (e.g., "appearance.material"). This works for any nodekit method that takes a part name for an argument.
  3. lists , or list parts. These parts group together children ( list elements ) of a particular type or types. As with nested nodekits, you can refer to individual elements using notation described in getPart() (e.g., "childList[0]", or if the list elements are in turn nodekits, "childList[2].transform").

When the catalog denotes that a part is a list, the part itself is always a node of type SoNodeKitListPart. The catalog specifies a set of permissible listItemTypes and a listContainerType for that part. It gives this information to the SoNodeKitListPart when it creates it. From then on, the list part will enforce type checking. So even if you retrieve the SoNodeKitListPart with getPart(), you will not be able to add illegal children. (See the SoNodeKitListPart reference page for more information). As an example, the callbackList part of SoBaseKit has an SoSeparator container and allows only SoCallback and SoEventCallback nodes in the list. Children may be added, retrieved, and removed from an SoNodeKitListPart node using methods that parallel those of SoGroup. However, type-checking is strictly enforced.

Note that, although all public parts are leaves in the nodekit catalog, you are free to add children to them (assuming that they are groups, nodekits, or list parts). A part's status as a leaf in the catalog just means that the nodekit will not manage the part's children. For example, SoWrapperKit has a part called contents with a part type of SoSeparator. You can put whatever you want underneath the separator, as long as contents itself is an SoSeparator.

Thus, a nodekit only controls a section of the scene graph. Above and below that section, anything goes.

However, when nodekits are nested, they effectively create a larger `known' section of the scene graph. For example, the appearance part of the SoSeparatorKit is a leaf node in the SoSeparatorKit catalog. But appearance is in turn an SoAppearanceKit, containing parts such as material and drawStyle. The two nodekits combine to make an even larger template, which the SoSeparatorKit can examine by looking at the catalogs for both classes. So an SoSeparatorKit can successfully return a part named "material"; first it finds (or creates) the appearance part, then it gets the material by calling getPart() on the appearance .

When the catalog defines the listItemTypes of a list part to be nodekits, the name-able space expands further. For example, SoSeparatorKit has a part childList which permits only SoSeparatorKits, so each list element can be further searched. Hence the name "childList[0].childList[1].childList[2].material" is perfectly legal.

PARTS

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

CATALOG PARTS

SEE ALSO

SoAppearanceKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit


Constructor & Destructor Documentation

SoBaseKit::SoBaseKit (  ) 

Constructor.


Member Function Documentation

virtual SoNodeKitPath* SoBaseKit::createPathToPart ( const SbName partName,
SbBool  makeIfNeeded,
const SoPath pathToExtend = NULL 
) [virtual]

Returns a path that begins at this nodekit and ends at partName.

Searching for the part is the same as in getPart(). NULL is returned if partName cannot be found, or if makeIfNeeded is FALSE and the part is not yet built. If the the part is retrieved and the argument pathToExtend is NULL, the path returned begins at this and ends at partName. If pathToExtend is not NULL, the path created is a copy of pathToExtend with entries appended all the way down to partName. It is okay for pathToExtend to go beyond the nodekit; extra nodes will be popped off the tail before continuing from this down to partName.

static const SoNodekitCatalog* SoBaseKit::getClassNodekitCatalog (  )  [static]

Returns the SoNodekitCatalog for the class SoBaseKit.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragger, SoDragPointDragger, SoEllipsoidDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger, PoBaseView, PoSceneView, PoView, SoAppearanceKit, SoCameraKit, SoInteractionKit, SoLightKit, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit, Po3DdataMaster, PoBaseStreamLine, PoCellEdges, PoCellFacets, PoCellIndices, PoCellShape, PoMesh, PoMesh2D, PoMesh2DVec, PoMesh3D, PoMesh3DVec, PoMesh3DVecCrossSection, PoMesh3DVecGridCrossSection, PoMeshContouring, PoMeshCrossContour, PoMeshCrossSection, PoMeshFilled, PoMeshLevelSurf, PoMeshLimit, PoMeshLines, PoMeshProbePoint, PoMeshSides, PoMeshSkeleton, PoMeshSkin, PoStreamLine, PoStreamLineMotion, PoStreamParticleMotion, PoStreamPointMotion, PoStreamSphereMotion, PoStreamSurface, PoStreamTadpoleMotion, PoAngularAxis, PoArrow, PoArrow3, PoAutoCubeAxis, PoAutoValueLegend, PoAxis, PoBar, PoBase, PoBaseAxis, PoBiErrorPointField, PoCartesianAxis, PoChart, PoCircle, PoCircle3, PoCircle3CenterRadius, PoCircle3ThreePoints, PoCircleArc, PoCircleArc3, PoCircleArc3CtrPtAngle, PoCircleArc3CtrTwoPts, PoCircleArc3ThreePts, PoCircleArcCtrPtAngle, PoCircleArcCtrRadTwoAngle, PoCircleArcCtrTwoPts, PoCircleArcThreePts, PoCircleCenterRadius, PoCircleThreePoints, PoConicBar, PoCoordinateSystemAxis, PoCurve, PoCurve3, PoCurveFilling, PoCurveLine, PoCylindricalBar, PoErrorCurve, PoErrorPointField, PoGenAxis, PoGeneralizedBar, PoGeneralizedScatter, PoGraphMaster, PoGroup2Axis, PoGroup3Axis3, PoGroup4Axis, PoGroup6Axis3, PoHighLowClose, PoHistogram, PoItemLegend, PoLabel, PoLabelField, PoLegend, PoLinearAxis, PoLinearBar, PoLinearValueLegend, PoLogAxis, PoMultipleHistogram, PoNonLinearValueLegend1, PoNonLinearValueLegend2, PoNonLinearValueLegend3, PoParallelogram, PoParallelogram3, PoPieChart, PoPieChart2D, PoPieChart3D, PoPieChartRep, PoPointsFieldBars, PoPolarAxis, PoPolarLinAxis, PoPolarLogAxis, PoProfileBar, PoRectangle, PoRibbon, PoScatter, PoSingleHistogram, PoTimeAxis, PoTube, PoValuedMarkerField, PoValueLegend, and SoOrthoSliceDragger.

static SoType SoBaseKit::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoNode.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragger, SoDragPointDragger, SoEllipsoidDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger, PoBaseView, PoSceneView, PoView, SoAppearanceKit, SoCameraKit, SoInteractionKit, SoLightKit, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit, Magnifier, Po3DdataMaster, PoBaseStreamLine, PoCellEdges, PoCellFacets, PoCellIndices, PoCellShape, PoMesh, PoMesh2D, PoMesh2DVec, PoMesh3D, PoMesh3DVec, PoMesh3DVecCrossSection, PoMesh3DVecGridCrossSection, PoMeshContouring, PoMeshCrossContour, PoMeshCrossSection, PoMeshFilled, PoMeshLevelSurf, PoMeshLimit, PoMeshLines, PoMeshProbePoint, PoMeshSides, PoMeshSkeleton, PoMeshSkin, PoStreamLine, PoStreamLineMotion, PoStreamParticleMotion, PoStreamPointMotion, PoStreamSphereMotion, PoStreamSurface, PoStreamTadpoleMotion, PoAngularAxis, PoArrow, PoArrow3, PoAutoCubeAxis, PoAutoValueLegend, PoAxis, PoBar, PoBase, PoBaseAxis, PoBiErrorPointField, PoCartesianAxis, PoChart, PoCircle, PoCircle3, PoCircle3CenterRadius, PoCircle3ThreePoints, PoCircleArc, PoCircleArc3, PoCircleArc3CtrPtAngle, PoCircleArc3CtrTwoPts, PoCircleArc3ThreePts, PoCircleArcCtrPtAngle, PoCircleArcCtrRadTwoAngle, PoCircleArcCtrTwoPts, PoCircleArcThreePts, PoCircleCenterRadius, PoCircleThreePoints, PoConicBar, PoCoordinateSystemAxis, PoCurve, PoCurve3, PoCurveFilling, PoCurveLine, PoCylindricalBar, PoErrorCurve, PoErrorPointField, PoGenAxis, PoGeneralizedBar, PoGeneralizedScatter, PoGraphMaster, PoGroup2Axis, PoGroup3Axis3, PoGroup4Axis, PoGroup6Axis3, PoHighLowClose, PoHistogram, PoItemLegend, PoLabel, PoLabelField, PoLegend, PoLinearAxis, PoLinearBar, PoLinearValueLegend, PoLogAxis, PoMultipleHistogram, PoNonLinearValueLegend1, PoNonLinearValueLegend2, PoNonLinearValueLegend3, PoParallelogram, PoParallelogram3, PoPieChart, PoPieChart2D, PoPieChart3D, PoPieChartRep, PoPointsFieldBars, PoPolarAxis, PoPolarLinAxis, PoPolarLogAxis, PoProfileBar, PoRectangle, PoRibbon, PoScatter, PoSingleHistogram, PoTimeAxis, PoTube, PoValuedMarkerField, PoValueLegend, and SoOrthoSliceDragger.

virtual const SoNodekitCatalog* SoBaseKit::getNodekitCatalog (  )  const [virtual]

Returns the SoNodekitCatalog for this instance of SoBaseKit.

While each instance of a given class creates its own distinct set of parts (which are actual nodes), all instances share the same catalog (which describes the parts but contains no actual nodes).

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragger, SoDragPointDragger, SoEllipsoidDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger, PoBaseView, PoSceneView, PoView, SoAppearanceKit, SoCameraKit, SoInteractionKit, SoLightKit, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit, Po3DdataMaster, PoBaseStreamLine, PoCellEdges, PoCellFacets, PoCellIndices, PoCellShape, PoMesh, PoMesh2D, PoMesh2DVec, PoMesh3D, PoMesh3DVec, PoMesh3DVecCrossSection, PoMesh3DVecGridCrossSection, PoMeshContouring, PoMeshCrossContour, PoMeshCrossSection, PoMeshFilled, PoMeshLevelSurf, PoMeshLimit, PoMeshLines, PoMeshProbePoint, PoMeshSides, PoMeshSkeleton, PoMeshSkin, PoStreamLine, PoStreamLineMotion, PoStreamParticleMotion, PoStreamPointMotion, PoStreamSphereMotion, PoStreamSurface, PoStreamTadpoleMotion, PoAngularAxis, PoArrow, PoArrow3, PoAutoCubeAxis, PoAutoValueLegend, PoAxis, PoBar, PoBase, PoBaseAxis, PoBiErrorPointField, PoCartesianAxis, PoChart, PoCircle, PoCircle3, PoCircle3CenterRadius, PoCircle3ThreePoints, PoCircleArc, PoCircleArc3, PoCircleArc3CtrPtAngle, PoCircleArc3CtrTwoPts, PoCircleArc3ThreePts, PoCircleArcCtrPtAngle, PoCircleArcCtrRadTwoAngle, PoCircleArcCtrTwoPts, PoCircleArcThreePts, PoCircleCenterRadius, PoCircleThreePoints, PoConicBar, PoCoordinateSystemAxis, PoCurve, PoCurve3, PoCurveFilling, PoCurveLine, PoCylindricalBar, PoErrorCurve, PoErrorPointField, PoGenAxis, PoGeneralizedBar, PoGeneralizedScatter, PoGraphMaster, PoGroup2Axis, PoGroup3Axis3, PoGroup4Axis, PoGroup6Axis3, PoHighLowClose, PoHistogram, PoItemLegend, PoLabel, PoLabelField, PoLegend, PoLinearAxis, PoLinearBar, PoLinearValueLegend, PoLogAxis, PoMultipleHistogram, PoNonLinearValueLegend1, PoNonLinearValueLegend2, PoNonLinearValueLegend3, PoParallelogram, PoParallelogram3, PoPieChart, PoPieChart2D, PoPieChart3D, PoPieChartRep, PoPointsFieldBars, PoPolarAxis, PoPolarLinAxis, PoPolarLogAxis, PoProfileBar, PoRectangle, PoRibbon, PoScatter, PoSingleHistogram, PoTimeAxis, PoTube, PoValuedMarkerField, PoValueLegend, and SoOrthoSliceDragger.

virtual SoNode* SoBaseKit::getPart ( const SbName partName,
SbBool  makeIfNeeded 
) [virtual]

Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

Returns the part if a match is found , the part is public , and the part has already been built . If no match is found, or if the part is private , NULL is returned. If partName is in the catalog (or that of one of its nested nodekit parts), but the part has not been built yet, the argument makeIfNeeded determines the course of action. When makeIfNeeded is FALSE, NULL is returned; when makeIfNeeded is TRUE, getPart() will create the part (as well as any necessary intermediary parts), put it in the correct place, and return the newly created part.

Elements of list parts and parts within nested nodekits can all be retrieved with getPart() The full syntax for legal partName arguments is given below.

Part name BNF notation :

partName = singleName | compoundName

compoundName = singleName | compoundName.singleName

singleName = singlePartName | singleListElementName

singlePartName = the name of any single part in the catalog (including those that are lists or nodekits), or in the recursively nested catalogs of any of its parts.

singleListElementName = singleListName[index]

singleListName = the name of any single list-type part in the catalog, or in the recursively nested catalogs of any of its parts.

index = integer

Examples of valid part names are:

"transform", "appearance.material", "childList[2].drawStyle", "foot", "bird.leftLeg.foot", "octopus.leg[4].suctionCup[2].material"

SbString SoBaseKit::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.

If so, returns a string describing the part name; otherwise, returns an empty string ("").

virtual SoType SoBaseKit::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragger, SoDragPointDragger, SoEllipsoidDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger, PoBaseView, PoSceneView, PoView, SoAppearanceKit, SoCameraKit, SoInteractionKit, SoLightKit, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit, Magnifier, Po3DdataMaster, PoBaseStreamLine, PoCellEdges, PoCellFacets, PoCellIndices, PoCellShape, PoMesh, PoMesh2D, PoMesh2DVec, PoMesh3D, PoMesh3DVec, PoMesh3DVecCrossSection, PoMesh3DVecGridCrossSection, PoMeshContouring, PoMeshCrossContour, PoMeshCrossSection, PoMeshFilled, PoMeshLevelSurf, PoMeshLimit, PoMeshLines, PoMeshProbePoint, PoMeshSides, PoMeshSkeleton, PoMeshSkin, PoStreamLine, PoStreamLineMotion, PoStreamParticleMotion, PoStreamPointMotion, PoStreamSphereMotion, PoStreamSurface, PoStreamTadpoleMotion, PoAngularAxis, PoArrow, PoArrow3, PoAutoCubeAxis, PoAutoValueLegend, PoAxis, PoBar, PoBase, PoBaseAxis, PoBiErrorPointField, PoCartesianAxis, PoChart, PoCircle, PoCircle3, PoCircle3CenterRadius, PoCircle3ThreePoints, PoCircleArc, PoCircleArc3, PoCircleArc3CtrPtAngle, PoCircleArc3CtrTwoPts, PoCircleArc3ThreePts, PoCircleArcCtrPtAngle, PoCircleArcCtrRadTwoAngle, PoCircleArcCtrTwoPts, PoCircleArcThreePts, PoCircleCenterRadius, PoCircleThreePoints, PoConicBar, PoCoordinateSystemAxis, PoCurve, PoCurve3, PoCurveFilling, PoCurveLine, PoCylindricalBar, PoErrorCurve, PoErrorPointField, PoGenAxis, PoGeneralizedBar, PoGeneralizedScatter, PoGraphMaster, PoGroup2Axis, PoGroup3Axis3, PoGroup4Axis, PoGroup6Axis3, PoHighLowClose, PoHistogram, PoItemLegend, PoLabel, PoLabelField, PoLegend, PoLinearAxis, PoLinearBar, PoLinearValueLegend, PoLogAxis, PoMultipleHistogram, PoNonLinearValueLegend1, PoNonLinearValueLegend2, PoNonLinearValueLegend3, PoParallelogram, PoParallelogram3, PoPieChart, PoPieChart2D, PoPieChart3D, PoPieChartRep, PoPointsFieldBars, PoPolarAxis, PoPolarLinAxis, PoPolarLogAxis, PoProfileBar, PoRectangle, PoRibbon, PoScatter, PoSingleHistogram, PoTimeAxis, PoTube, PoValuedMarkerField, PoValueLegend, and SoOrthoSliceDragger.

static SbBool SoBaseKit::isSearchingChildren (  )  [inline, static]

Returns TRUE if nodekit children are searched during SoSearchAction traversal.

By default, they are not.

SbBool SoBaseKit::set ( const SbString partNameString,
const SbString parameterString 
)

This function allows field values of parts (nodes) to be set.

A single part is specified by partNameString; the field values are specified in parameterString. The format of parameters is the Open Inventor File Format syntax.

For example,

  mySepKit->set("material", "diffuseColor 1 0 0 shininess 0.6");

sets the part material to the values "diffuseColor 1 0 0 shininess 0.6".

The values used in parameters must of course be appropriate for the node-type to which partName belongs. In this case, the nodekit SoSeparatorKit has a part named material which is of type SoMaterial.

SoNONUNICODE SbBool SoBaseKit::set ( const char *  partNameString,
const char *  parameterString 
)

This function allows field values of parts (nodes) to be set.

A single part is specified by partNameString; the field values are specified in parameterString. The format of parameters is the Open Inventor File Format syntax.

For example,

  mySepKit->set("material", "diffuseColor 1 0 0 shininess 0.6");

sets the part material to the values "diffuseColor 1 0 0 shininess 0.6".

The values used in parameters must of course be appropriate for the node-type to which partName belongs. In this case, the nodekit SoSeparatorKit has a part named material which is of type SoMaterial.

Non Unicode List:
This function should not be used in a Unicode application.
SbBool SoBaseKit::set ( const SbString nameValuePairListString  ) 

This function allows field values of parts (nodes) to be set in several different parts simultaneously.

The argument string, nameValuePairListString, contains name-value pairs: "partName1 parameters1 ... partNameN parametersN ".

For example,

  mySepKit->set("material {diffuseColor 1 1 1} 
  transform {translation 4 3 .6}");
  mySepKit->set("childList[0].material {ambientColor .5 .5 .5}");

Reimplemented from SoFieldContainer.

SoNONUNICODE SbBool SoBaseKit::set ( char *  nameValuePairListString  ) 

This function allows field values of parts (nodes) to be set in several different parts simultaneously.

The argument string, nameValuePairListString, contains name-value pairs: "partName1 parameters1 ... partNameN parametersN ".

For example,

  mySepKit->set("material {diffuseColor 1 1 1} 
  transform {translation 4 3 .6}");
  mySepKit->set("childList[0].material {ambientColor .5 .5 .5}");
Non Unicode List:
This function should not be used in a Unicode application.
virtual SbBool SoBaseKit::setPart ( const SbName partName,
SoNode newPart 
) [virtual]

Inserts the given node (not a copy) as the new part specified by partName.

See getPart() for the syntax of partName. This method adds any extra nodes needed to fit the part into the nodekit's catalog.

For example, if you call:

  mySepKit->setPart("childList[0]", myNewChild);

the kit may need to create the part childList before it can install myNewChild.

Run-time type checking verifies that the node type of newPart matches the type called for by partName. For example, if partName was a material for an SoSeparatorKit, but newPart was an SoTransform node, then the node would not be installed, and FALSE would be returned.

If newPart is NULL, then the node specified by partName is removed. If this renders any private parts useless (as occurs when you remove the last child of an SoGroup node), they will also be removed. Hence nodekits do not retain unnecessary nodes.

TRUE is returned on success, and FALSE upon error.

static void SoBaseKit::setSearchingChildren ( SbBool  newVal  )  [static]

Sets if nodekit children are searched during SoSearchAction traversal.

By default, they are not.


Friends And Related Function Documentation

friend class SoNodekitCatalogEntry [friend]
friend class SoNodekitParts [friend]
friend class SoV1BaseKit [friend]

Member Data Documentation

Whether to ignore this node during bounding box traversal.

Default is FALSE.


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

Open Inventor Toolkit reference manual, generated on 17 Dec 2019
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/