SoBase Class Reference
[General]
Base class for all nodes, paths, and engines. More...
#include <Inventor/misc/SoBase.h>
Classes | |
| struct | MTstruct |
| struct | WriteStuff |
Public Member Functions | |
| virtual void | touch () |
| virtual SbName | getName () const |
| virtual void | setName (const SbName &name) |
| void | setSynchronizable (const bool b) |
| bool | isSynchronizable () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| static SoVRMLPROTODef * | getPROTO (const SbName &name) |
| static SoVRMLEXTERNPROTODef * | getEXTERNPROTO (const SbName &name) |
Detailed Description
Base class for all nodes, paths, and engines.
Abstract base class for Open Inventor node, path, and engine classes. This class handles reference counting, notification, and naming.
Instances should be referenced when they will be used outside of the routine in which they were initialized. (A typical example of this is maintaining a reference to the root of a graph.)
SEE ALSO
SoFieldContainer, SoNode, SoPath, SoEngine, SoDB
Member Function Documentation
| static SoType SoBase::getClassTypeId | ( | ) | [static] |
Returns type identifier for this class.
Reimplemented from SoTypedObject.
Reimplemented in SoDirectVizManager, SoBumpMappingProperty, SoParticleAnimation, SoImageVizEngine, SoAnalysisResult, SoImageAnalysisResult, SoLabelAnalysisResult, SoSegmentChain, SoFileDataAdapter, SoImageDataAdapter, SoMemoryDataAdapter, SoProxyDataAdapter, SoVolumeReaderAdapter, SoVRImageDataReader, SoMorphoLut2D, SoMorphoLut3D, SoDataMeasure, SoDataMeasureAttributes, SoDataMeasureCustom, SoDataMeasurePredefined, SoRegistrationResult, SoDirectVizCameraShader, SoDirectVizEnvironmentShader, SoDirectVizGeneralShader, SoDirectVizShader, SoCenterballDragger, SoDirectionalLightDragger, SoDragger, SoDragPointDragger, SoEllipsoidDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger, SoEllipseScreenDrawer, SoLassoScreenDrawer, SoPolygonScreenDrawer, SoPolyLineScreenDrawer, SoRectangleScreenDrawer, SoScreenDrawer, SoBoolOperation, SoCalculator, SoComposeVec2f, SoComposeVec2i32, SoComposeVec2s, SoComposeVec3f, SoComposeVec4f, SoDecomposeVec2f, SoDecomposeVec2i32, SoDecomposeVec2s, SoDecomposeVec3f, SoDecomposeVec4f, SoComposeRotation, SoComposeRotationFromTo, SoDecomposeRotation, SoComposeMatrix, SoDecomposeMatrix, SoComputeBoundingBox, SoConcatenate, SoCounter, SoElapsedTime, SoEngine, SoGate, SoInterpolate, SoInterpolateFloat, SoInterpolateRotation, SoInterpolateVec2f, SoInterpolateVec3f, SoInterpolateVec4f, SoOneShot, SoOnOff, SoSelectOne, SoTimeCounter, SoTrackFollower, SoTransformVec3f, SoTriggerAny, SoFieldContainer, SoGeoCoordinate, SoGeoElevationGrid, SoGeoLocation, SoGeoLOD, SoGeoOrigin, SoGeoRender, SoVRMLGeoCoordinate, SoVRMLGeoElevationGrid, SoVRMLGeoLocation, SoVRMLGeoLOD, SoVRMLGeoOrigin, SoVRMLGeoTouchSensor, SoVRMLGeoViewpoint, PoBaseView, PoSceneView, PoView, SoCenterballManip, SoClipPlaneManip, SoDirectionalLightManip, SoHandleBoxManip, SoJackManip, SoPointLightManip, SoSpotLightManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, SoTransformerManip, SoTransformManip, SoMPConfig, SoAppearanceKit, SoBaseKit, SoCameraKit, SoInteractionKit, SoLightKit, SoNodeKitListPart, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit, SoAlgebraicCone, SoAlgebraicCylinder, SoAlgebraicShape, SoAlgebraicSphere, SoAnnotation, SoAnnoText3, SoAnnoText3Property, SoAntiSquish, SoArray, SoAsciiText, SoBackground, SoBaseColor, SoBaseExtrusion, SoBBox, SoBevelProperty, SoBillboard, SoBlinker, SoBufferedShape, SoCallback, SoCamera, SoCircularExtrusion, SoClipPlane, SoColorIndex, SoColorMap, SoComplexity, SoCone, SoCoordinate3, SoCoordinate4, SoCSGShape, SoCube, SoCylinder, SoDepthBuffer, SoDepthOffset, SoDirectionalLight, SoDrawStyle, SoEdgeFlag, SoEnvironment, SoEventCallback, SoExtrusion, SoExtSelection, SoExtTexture2, SoFaceSet, SoFile, SoFont, SoFontStyle, SoFragmentShader, SoFrontBufferGroup, SoFullSceneAntialiasing, SoGeometryShader, SoGeoProjection, SoGradientBackground, SoGroup, SoImage, SoImageBackground, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedMarkerSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedPointSet, SoIndexedQuadMesh, SoIndexedShape, SoIndexedTexture2, SoIndexedTriangleFanSet, SoIndexedTriangleSet, SoIndexedTriangleStripSet, SoInfo, SoInstanceParameter, SoInteractiveComplexity, SoInteractiveSwitch, SoLabel, SoLevelOfDetail, SoLevelOfSimplification, SoLight, SoLightModel, SoLinearProfile, SoLineSet, SoLocateHighlight, SoLOD, SoMarker, SoMarkerSet, SoMaterial, SoMaterialBinding, SoMatrixTransform, SoMultiPathSwitch, SoMultipleCopy, SoMultipleInstance, SoMultipleInstanceBase, SoMultiSwitch, SoNode, SoNonIndexedShape, SoNormal, SoNormalBinding, SoNurbsBoundary, SoNurbsCurve, SoNurbsGroup, SoNurbsProfile, SoNurbsProperty, SoNurbsSurface, SoOcclusionCulling, SoOctreeOrdering, SoOrthographicCamera, SoPackedColor, SoPathSwitch, SoPattern, SoPendulum, SoPerspectiveCamera, SoPickStyle, SoPointLight, SoPointSet, SoPolygonOffset, SoProfile, SoProfileCoordinate2, SoProfileCoordinate3, SoProjection, SoQuadMesh, SoRenderList, SoRenderToTarget, SoRenderToTextureProperty, SoResetTransform, SoRotation, SoRotationXYZ, SoRotor, SoScale, SoSelection, SoSeparator, SoShaderObject, SoShaderParameter, SoUniformShaderParameter, SoShaderParameter1f, SoShaderParameter1i, SoShaderParameter2f, SoShaderParameter2i, SoShaderParameter3f, SoShaderParameter3i, SoShaderParameter4f, SoShaderParameter4i, SoShaderParameterArray1f, SoShaderParameterArray1i, SoShaderParameterArray2f, SoShaderParameterArray2i, SoShaderParameterArray3f, SoShaderParameterArray3i, SoShaderParameterArray4f, SoShaderParameterArray4i, SoShaderParameterMatrix, SoShaderParameterMatrixArray, SoShaderStateMatrixParameter, SoShaderParameterStruct, SoVertexShaderParameter, SoVertexShaderParameter1f, SoVertexShaderParameter1s, SoVertexShaderParameter2f, SoVertexShaderParameter2s, SoVertexShaderParameter3f, SoVertexShaderParameter3s, SoVertexShaderParameter4f, SoVertexShaderParameter4i, SoVertexShaderParameter4s, SoVertexShaderParameter4b, SoVertexShaderParameter4ui, SoVertexShaderParameter4us, SoVertexShaderParameter4ub, SoVertexShaderParameterMatrix, SoVertexShaderParameterBufferObject, SoShaderParameterBufferObject, SoShaderProgram, SoShadowGroup, SoShadowStyle, SoShape, SoShapeHints, SoShuttle, SoSphere, SoSpotLight, SoStereoCamera, SoSurroundScale, SoSwitch, SoTessellationControlShader, SoTessellationEvaluationShader, SoText2, SoText3, SoTextProperty, SoTexture, SoTexture2, SoTexture2Transform, SoTexture3, SoTexture3Transform, SoTextureCombiner, SoTextureCoordinate2, SoTextureCoordinate3, SoTextureCoordinateBinding, SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateFunction, SoTextureCoordinateNormalMap, SoTextureCoordinateObject, SoTextureCoordinatePlane, SoTextureCoordinateReflectionMap, SoTextureCubeMap, SoTextureMatrix, SoTextureUnit, SoTransform, SoTransformation, SoTransformProjection, SoTransformSeparator, SoTranslation, SoTransparencyType, SoTriangleSet, SoTriangleStripSet, SoUnits, SoValueOrdering, SoVertexAttribFeedback, SoVertexFlag, SoVertexProperty, SoVertexShader, SoVertexShape, SoViewport, SoViewportClipping, SoWWWAnchor, SoWWWInline, SoPath, SoVRMLAnchor, SoVRMLAppearance, SoVRMLArc2D, SoVRMLArcClose2D, SoVRMLAudioClip, SoVRMLBackground, SoVRMLBillboard, SoVRMLBooleanToggle, SoVRMLBox, SoVRMLCircle2D, SoVRMLCollision, SoVRMLColor, SoVRMLColorRGBA, SoVRMLCone, SoVRMLCoordinate, SoVRMLCylinder, SoVRMLCylinderSensor, SoVRMLDirectionalLight, SoVRMLDisk2D, SoVRMLElevationGrid, SoVRMLEXTERNPROTODef, SoVRMLEXTERNPROTOField, SoVRMLEXTERNPROTOInstance, SoVRMLExtrusion, SoVRMLFillProperties, SoVRMLFog, SoVRMLFontStyle, SoVRMLGeometry, SoVRMLGridShape, SoVRMLGroup, SoVRMLImageTexture, SoVRMLIndexedFaceSet, SoVRMLIndexedLine, SoVRMLIndexedLineSet, SoVRMLIndexedShape, SoVRMLIndexedTriangleFanSet, SoVRMLIndexedTriangleSet, SoVRMLIndexedTriangleStripSet, SoVRMLInline, SoVRMLInterpolator, SoVRMLKeySensor, SoVRMLLight, SoVRMLLineProperties, SoVRMLLineSet, SoVRMLLoadSensor, SoVRMLLOD, SoVRMLMaterial, SoVRMLMetadataDouble, SoVRMLMetadataFloat, SoVRMLMetadataInteger, SoVRMLMetadataObject, SoVRMLMetadataSet, SoVRMLMetadataString, SoVRMLMovieTexture, SoVRMLMultiTexture, SoVRMLMultiTextureCoordinate, SoVRMLMultiTextureTransform, SoVRMLNavigationInfo, SoVRMLNode, SoVRMLNormal, SoVRMLParent, SoVRMLPixelTexture, SoVRMLPlaneSensor, SoVRMLPointLight, SoVRMLPointSet, SoVRMLPolyline2D, SoVRMLPolypoint2D, SoVRMLPROTODef, SoVRMLPROTOField, SoVRMLPROTOInstance, SoVRMLProximitySensor, SoVRMLRectangle2D, SoVRMLScript, SoVRMLShape, SoVRMLSound, SoVRMLSphere, SoVRMLSphereSensor, SoVRMLSpotLight, SoVRMLStaticGroup, SoVRMLStringSensor, SoVRMLSwitch, SoVRMLText, SoVRMLTexture, SoVRMLTextureBackground, SoVRMLTextureCoordinate, SoVRMLTextureCoordinateGenerator, SoVRMLTextureTransform, SoVRMLTouchSensor, SoVRMLTransform, SoVRMLTriangle, SoVRMLTriangleFanSet, SoVRMLTriangleSet, SoVRMLTriangleSet2D, SoVRMLTriangleStripSet, SoVRMLVertexLine, SoVRMLVertexPoint, SoVRMLVertexShape, SoVRMLViewpoint, SoVRMLVisibilitySensor, SoVRMLWorldInfo, SoROIManip, SoDataCompositor, SoDataRange, SoDataSet, SoDataSetId, SoGeometryPriority, SoHardwareQuery, SoLDMDataTransform, SoLDMResourceParameters, SoLdmShape, SoMultiDataSeparator, SoROI, SoTimeHints, SoTransferFunction, SoLDMReader, SoVolumeReader, SoVRLdmFileBorderReader, SoVRLdmFileReader, SoVolumeWriter, SoVRLdmFileWriter, DicomInfo, Gnomon, Magnifier, ObliqueSliceBorder, OrthoSliceBorder, PlaneBoxIntersection, PlaneGeometryIntersection, Ruler, SceneView, SliceOrientationMarkers, SliceScaleBar, TextBox, ViewManager, 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, PoBevelEdge, PoCartesianGrid2D, PoCartesianGrid3D, PoCellFilter, PoCircularProfile, PoCoordinateListFilter, PoDataMapping, PoDateFormatMapping, PoDomain, PoEllipticProfile, PoHexahedronMesh3D, PoIndexedMesh2D, PoIndexedMesh3D, PoIndexListFilter, PoIntervalCellFilter, PoIrregularMesh1D, PoIsovaluesList, PoLabelHints, PoLinearDataMapping, PoMesh1DFilter, PoMesh1DHints, PoMeshProperty, PoMiscTextAttr, PoNode, PoNonLinearDataMapping, PoNonLinearDataMapping2, PoNumericDisplayFormat, PoParalCartesianGrid2D, PoParalCartesianGrid3D, PoPeriodFilter, PoPeriodIndexFilter, PoPolarGrid2D, PoProfile, PoProfileCoordinate2, PoQuadrangleMesh2D, PoRegularCartesianGrid2D, PoRegularCartesianGrid3D, PoRegularMesh1D, PoSquareProfile, PoTetrahedronMesh3D, PoTriangleMesh2D, MoActionNode, MoCellFilter, MoColorMapping, MoCombineColorMapping, MoCustomColorMapping, MoDataBinding, MoDrawStyle, MoLegend, MoLevelColorMapping, MoLinearColorMapping, MoMaterial, MoMesh, MoMeshAnnotatedIsoline, MoMeshBaseRepresentation, MoMeshCellShape, MoMeshClipLine, MoMeshClipPoint, MoMeshCylinderSlice, MoMeshElevatedPlaneSlice, MoMeshFenceSlice, MoMeshGridPlaneSlice, MoMeshInterpolatedLogicalSlice, MoMeshIsoline, MoMeshIsosurface, MoMeshLine, MoMeshLineRepresentation, MoMeshLogicalSlice, MoMeshOutline, MoMeshPlaneSlice, MoMeshPointProbe, MoMeshRepresentation, MoMeshSkin, MoMeshSlab, MoMeshSphereSlice, MoMeshStreamline, MoMeshSurface, MoMeshSurfaceRepresentation, MoMeshVector, MoPredefinedColorMapping, MoScalarSet, MoScalarSetI, MoScalarSetIj, MoScalarSetIjk, MoTessellator, MoVec3SetI, MoVec3SetIj, MoVec3SetIjk, SoRemoteVizClient, SoBaseScreen, SoClusterGateway, SoDepthComposer, SoDepthComposerParams, SoFlatScreen, SoMasterConfig, SoRemoteParams, SoScaleVizConfig, SoScaleVizParameters, SoScreen, SoTileComposer, SoTileComposerParams, SoTracker, SoCSGGroup, SoTVizRender, SoOrthoSliceDragger, SoFenceSlice, SoHeightFieldGeometry, SoHeightFieldProperty, SoHeightFieldPropertyMask, SoHeightFieldRender, SoObliqueSlice, SoOffscreenVolumeRender, SoOrthoSlice, SoSlice, SoUniformGridClipping, SoUniformGridProjectionClipping, SoVolumeBufferedShape, SoVolumeClippingGroup, SoVolumeData, SoVolumeDataDrawStyle, SoVolumeFaceSet, SoVolumeGroup, SoVolumeIndexedFaceSet, SoVolumeIndexedTriangleStripSet, SoVolumeIsosurface, SoVolumeMask, SoVolumeMaskGroup, SoVolumeRender, SoVolumeRenderingPhysicalQuality, SoVolumeRenderingQuality, SoVolumeShader, SoVolumeShape, SoVolumeSkin, SoVolumeTransform, SoVolumeTriangleStripSet, SoVRAmFileReader, SoVRAvsFileReader, SoVRDicomFileReader, SoVRGenericFileReader, SoVRMemoryReader, SoVRRasterStackReader, SoVRSegyFileReader, SoVRTiffFileReader, SoVRVolFileReader, SoVRVoxFileReader, SoVRXtFileReader, SoVRMemoryWriter, and SoDialogSpreadSheet.
| static SoVRMLEXTERNPROTODef* SoBase::getEXTERNPROTO | ( | const SbName & | name | ) | [static] |
Returns the definition for the externproto node externprotoName .
| virtual SbName SoBase::getName | ( | ) | const [virtual] |
| static SoVRMLPROTODef* SoBase::getPROTO | ( | const SbName & | name | ) | [static] |
Returns the definition for the prototype node protoName .
| bool SoBase::isSynchronizable | ( | ) | const [inline] |
Gets the ScaleViz synchronizable state of this object.
| virtual void SoBase::setName | ( | const SbName & | name | ) | [virtual] |
Sets the name of an instance.
Object names are preserved when objects are written to or read from files. Object names must not begin with a digit, and must not contain spaces or control characters, periods, single or double quote characters, backslashes, curly braces, square brackets or the plus character.
The SbName::isBaseNameChar() and SbName::isBaseNameStartChar() methods can be used to validate names input by users.
This method will replace any bad characters in the name with underscore characters, and will print out an error message if the application is using the Open Inventor debugging library.
The same name may be assigned to more than one instance.
Avoid using names that begin with "OIV_". Such names may be used internally.
Nodes may be queried by name using the SoNode::getByName methods. Node names may also be used with SoSearchAction.
| void SoBase::setSynchronizable | ( | const bool | b | ) | [inline] |
Sets this to be a ScaleViz synchronizable object.
By default all objects are synchronizable.
| virtual void SoBase::touch | ( | ) | [inline, virtual] |
Marks an instance as modified, simulating a change to it.
This will notify auditors (parent nodes, connected engines, and so on) of a change to this object and cause attached sensors to be triggered.
Reimplemented in SoNode.
The documentation for this class was generated from the following file:
- Inventor/misc/SoBase.h