SoNode.3coin3 man page

SoNode — The SoNode class is the base class for nodes used in scene graphs.

Coin is a retained mode 3D visualization library (built on top of the immediate mode OpenGL library). 'Retained mode' means that instead of passing commands to draw graphics primitives directly to the renderer, you build up data structures which are rendered by the library on demand.

Synopsis

#include <Inventor/nodes/SoNode.h>

Inherits SoFieldContainer.

Inherited by SoBaseColor, SoBaseKit, SoBumpMap, SoBumpMapCoordinate, SoBumpMapTransform, SoCacheHint, SoCallback, SoCamera, SoClipPlane, SoColorIndex, SoComplexity, SoCoordinate3, SoCoordinate4, SoDepthBuffer, SoDrawStyle, SoEnvironment, SoEventCallback, SoFile, SoFont, SoGeoCoordinate, SoGeoOrigin, SoGroup, SoInfo, SoLabel, SoLight, SoLightModel, SoListener, SoMaterial, SoMaterialBinding, SoNodeEngine, SoNodeKitListPart, SoNormal, SoNormalBinding, SoPackedColor, SoPickStyle, SoPolygonOffset, SoProfile, SoProfileCoordinate2, SoProfileCoordinate3, SoProfilerStats, SoProto, SoProtoInstance, SoSceneTexture2, SoSceneTextureCubeMap, SoShaderObject, SoShaderParameter, SoShaderProgram, SoShadowCulling, SoShadowStyle, SoShape, SoShapeHints, SoTexture, SoTexture2Transform, SoTexture3Transform, SoTextureCombine, SoTextureCoordinate2, SoTextureCoordinate3, SoTextureCoordinateBinding, SoTextureCoordinateCube, SoTextureCoordinateCylinder, SoTextureCoordinateFunction, SoTextureCoordinateSphere, SoTextureMatrixTransform, SoTextureScalePolicy, SoTextureUnit, SoTransformation, SoTransparencyType, SoVertexAttribute, SoVertexAttributeBinding, SoVertexProperty, SoVRMLAppearance, SoVRMLAudioClip, SoVRMLBackground, SoVRMLColor, SoVRMLCoordinate, SoVRMLFog, SoVRMLFontStyle, SoVRMLInline, SoVRMLLight, SoVRMLMaterial, SoVRMLNavigationInfo, SoVRMLNormal, SoVRMLProximitySensor, SoVRMLScript, SoVRMLSensor, SoVRMLShape, SoVRMLSound, SoVRMLTexture, SoVRMLTextureCoordinate, SoVRMLTextureTransform, SoVRMLTouchSensor, SoVRMLViewpoint, SoVRMLVisibilitySensor, SoVRMLWorldInfo, and SoWWWInline.

Public Types

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

Public Member Functions

void setOverride (const SbBool state)

SbBool isOverride (void) const

void setNodeType (const NodeType type)

NodeType getNodeType (void) const

virtual SoNode * copy (SbBool copyconnections=FALSE) const

virtual SbBool affectsState (void) const

virtual void doAction (SoAction *action)

virtual void GLRender (SoGLRenderAction *action)

virtual void GLRenderBelowPath (SoGLRenderAction *action)

virtual void GLRenderInPath (SoGLRenderAction *action)

virtual void GLRenderOffPath (SoGLRenderAction *action)

virtual void callback (SoCallbackAction *action)

virtual void getBoundingBox (SoGetBoundingBoxAction *action)

virtual void getMatrix (SoGetMatrixAction *action)

virtual void handleEvent (SoHandleEventAction *action)

virtual void pick (SoPickAction *action)

virtual void rayPick (SoRayPickAction *action)

virtual void search (SoSearchAction *action)

virtual void write (SoWriteAction *action)

virtual void audioRender (SoAudioRenderAction *action)

virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

virtual void grabEventsSetup (void)

virtual void grabEventsCleanup (void)

virtual void startNotify (void)

virtual void notify (SoNotList *l)

uint32_t getNodeId (void) const

virtual SoChildList * getChildren (void) const

virtual void writeInstance (SoOutput *out)

virtual SoNode * addToCopyDict (void) const

virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)

virtual SoFieldContainer * copyThroughConnection (void) const

Static Public Member Functions

static uint32_t getCompatibilityTypes (const SoType &nodetype)

static SoType getClassTypeId (void)

static SoNode * getByName (const SbName &name)

static int getByName (const SbName &name, SoNodeList &l)

static void initClass (void)

static void initClasses (void)

static uint32_t getNextNodeId (void)

static int getActionMethodIndex (const SoType type)

static void getBoundingBoxS (SoAction *action, SoNode *node)

static void GLRenderS (SoAction *action, SoNode *node)

static void callbackS (SoAction *action, SoNode *node)

static void getMatrixS (SoAction *action, SoNode *node)

static void handleEventS (SoAction *action, SoNode *node)

static void pickS (SoAction *action, SoNode *node)

static void rayPickS (SoAction *action, SoNode *node)

static void searchS (SoAction *action, SoNode *node)

static void writeS (SoAction *action, SoNode *node)

static void audioRenderS (SoAction *action, SoNode *node)

static void getPrimitiveCountS (SoAction *action, SoNode *node)

Protected Member Functions

SoNode (void)

virtual ~SoNode ()

virtual SbBool readInstance (SoInput *in, unsigned short flags)

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

static void setNextActionMethodIndex (int index)

static int getNextActionMethodIndex (void)

static void incNextActionMethodIndex (void)

static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

Protected Attributes

uint32_t uniqueId

Static Protected Attributes

static uint32_t nextUniqueId = 1

static int nextActionMethodIndex = 0

Additional Inherited Members

Detailed Description

The SoNode class is the base class for nodes used in scene graphs.

Coin is a retained mode 3D visualization library (built on top of the immediate mode OpenGL library). 'Retained mode' means that instead of passing commands to draw graphics primitives directly to the renderer, you build up data structures which are rendered by the library on demand.

The node classes are the main 'primitive' for building these data structures. In Coin, you build tree hierarchies made up of different node types: group nodes (for the tree structure layout of the other nodes), appearance nodes (for setting up materials, textures, etc), shape nodes (for the actual geometry), and nodes for lighting and camera positioning.

One common issue with newcomers to the API is that you should not and can not use the C++ delete operator on nodes -- the destructor is protected. This is because node instances are using a common technique for memory resource handling called 'reference counting'. Nodes are deleted (actually, they delete themselves) when their unref() method is called and the reference count goes to zero.

One important side-effect of this is that SoNode-derived classes should not be statically allocated, neither in static module memory nor on function's stack-frames. SoNode-derived classes must always be allocated dynamically from the memory heap with the new operator (or else the scheme with self-destruction upon de-referencing to 0 would not work).

Usually application programmers won't manually ref() and unref() nodes a lot, because you pass the nodes directly to SoGroup::addChild() or So*Viewer::setSceneGraph() or something similar. These functions will ref() the nodes they are passed, and unref() them when they are finished with them.

Make sure you do ref() nodes that you keep pointers to so they aren't accidentally deleted prematurely due to an unref() call from within the library itself. If you haven't manually called ref() on a top-level root node, it will then be deleted automatically. This code shows how to do it:

SoSeparator * root = new SoSeparator; // root's refcount starts out at zero
root->addChild(foo_node); // foo_node refcount is increased by 1
root->addChild(bar_node); // bar_node refcount +1

// increase refcount before passing it to setScenegraph(), to avoid
// premature destruction
root->ref();

myviewer->setSceneGraph(root); // root's refcount +1, is now 2

// [misc visualization and processing]

// myviewer will let go of it's reference to the root node, thereby
// decreasing it's referencecount by 1
myviewer->setSceneGraph(NULL);

// root's refcount goes from +1 to 0, and it will self-destruct controllably
root->unref();
// avoid dangling pointer, in case "root" is attempted used again
// (not really necessary, but good for smoking out bugs early)
root = NULL;

For full information and tutorial-style introductions to all API issues, see the 'Inventor Mentor: Programming Object-Oriented 3D Graphics with Open Inventor' (ISBN 0-201-62495-8). It has detailed explanations on all the basic principles involved.

See specifically the section 'References and Deletion' in Chapter 3 to learn about the reference counting techniques.

Often when using the Coin library, one is interested in making extensions to it. Of particular interest is setting up extension nodes, which are then traversed, rendered and otherwise used by the rest of the library as any internal node.

The Coin header file Inventor/nodes/SoSubNode.h includes a set of convenience macros for quick and easy construction of extension nodes. Here's a complete snippet of code which shows how to set up a skeleton framework for an extension node class:

#include <Inventor/nodes/SoWWWInline.h>

class MyWWWInline : public SoWWWInline {
  SO_NODE_HEADER(MyWWWInline);

public:
  static void initClass(void);
  MyWWWInline(void);

protected:
  virtual ~MyWWWInline();
};

SO_NODE_SOURCE(MyWWWInline);

MyWWWInline::MyWWWInline(void)
{
  SO_NODE_CONSTRUCTOR(MyWWWInline);
}

MyWWWInline::~MyWWWInline()
{
}

void
MyWWWInline::initClass(void)
{
  SO_NODE_INIT_CLASS(MyWWWInline, SoWWWInline, "SoWWWInline");
}

int
main(int argc, char ** argv)
{
  SoDB::init();
  MyWWWInline::initClass();

  // [...]

  return 0;
}

You can then override for instance the GLRender() method to have your new class render OpenGL geometry different from it's superclass.

For extending the Coin library with your own classes, we strongly recommend that you make yourself acquainted with the excellent «The Inventor Toolmaker» book (ISBN 0-201-62493-1), which describes the tasks involved in detail. This book was written by the original SGI Inventor designers and explains many of the underlying design ideas, aswell as having lots of hands-on examples on how to extend the Coin toolkit in ways that are true to the fundamental design ideas. («The Inventor Toolmaker» is also available at SGI's online library, at no cost. See Download The Inventor Toolmaker.) Reading the sourcecode of the built-in classes in Coin should also provide very helpful.

For information about dynamic loading of extension nodes, see the documentation of SoType::fromName().

Member Enumeration Documentation

enum SoNode::NodeType

Used to store node type.

Enumerator

INVENTOR
Specifies Inventor node type.
VRML1
Node is VRML V1.0 compatible.
VRML2
Node is from the VRML V2.0 specification.
INVENTOR_1
Node was part of SGI Inventor version 1.
INVENTOR_2_0
Node was part of SGI Inventor version 2.0.
INVENTOR_2_1
Node was introduced with SGI / TGS Inventor version 2.1.
INVENTOR_2_5
Node was introduced with TGS Inventor version 2.5.
INVENTOR_2_6
Node was introduced with TGS Inventor version 2.6.
COIN_1_0
Node was part of Coin version 1.
COIN_2_0
Node was introduced with Coin 2.0.
EXTENSION
Node is a client code extension.

Constructor & Destructor Documentation

SoNode::SoNode (void) [protected]

Default constructor, initializes node instance.

SoNode::~SoNode () [protected], [virtual]

Destructor.

Member Function Documentation

void SoNode::setOverride (const SbBool state)

Set the override flag.

If this flag is TRUE, the field values of this node will override the field values of other nodes of the same type during scene graph traversal.

A common applicaton for 'override nodes' is to place them at the top of the tree as a convenient way to force e.g. a common drawstyle on the complete tree.

The override flag does not exist in the Inventor file format. This flag is in other words not persistent, and must be programmatically set. The rationale for this flag is for viewers to be able to control rendering style of the 3D models, so it would look stupid if some parts of certain models suddenly didn't adhere to the viewer mode.

SbBool SoNode::isOverride (void) const

Return status of override flag.

See also:

setOverride()

uint32_t SoNode::getCompatibilityTypes (const SoType & nodetype) [static]

Get the node compatibility mask for node type nodetype. The return value will be a bit mask of SoNode::NodeType flags, containing one or several flags.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:

Coin 2.0

void SoNode::setNodeType (const NodeType type)

Sets the node type for this node to type. Since some nodes should be handled differently in VRML1 vs. Inventor, this should be used to get correct behavior for those cases. The default node type is INVENTOR.

This method is an extension versus the Open Inventor API.

See also:

getNodeType()

SoNode::NodeType SoNode::getNodeType (void) const

Returns the node type set for this node.

This method is an extension versus the Open Inventor API.

See also:

setNodeType()

SoNode * SoNode::copy (SbBool copyconnections = FALSE) const [virtual]

Make a duplicate of this node and return a pointer to the duplicate.

If this node is a group node, children are also copied and we return a pointer to the root of a full copy of the subgraph rooted here.

If copyconnections is TRUE, we also copy the connections to fields within this node (and ditto for any children and children's children etc).

Note that this function has been made virtual in Coin, which is not the case in the original Open Inventor API. We may change this method back into being non-virtual again for major Coin versions after this, as it was made virtual more or less by mistake. So please don't write application code that depends on SoNode::copy() being virtual.

The reason this method should not be virtual is because this is not the function the application programmer should override in extension nodes if she needs some special behavior during a copy operation (like copying the value of internal data not exposed as fields).

For that purpose, override the copyContents() method. Your overridden copyContents() method should then both copy internal data aswell as calling the parent superclass' copyContents() method for automatically handling of fields and other common data.

SbBool SoNode::affectsState (void) const [virtual]

Returns TRUE if the node could have any effect on the state during traversal.

If it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. The SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. All SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state.

The default method returns TRUE, on a 'better safe than sorry' philosophy.

Reimplemented in SoSeparator, SoNodeKitListPart, SoShape, SoVRMLShape, SoVRMLSwitch, SoArray, SoVRMLProximitySensor, SoVRMLTouchSensor, SoVRMLLOD, SoSwitch, SoSceneKit, SoVRMLParent, and SoMultipleCopy.

void SoNode::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action.

Reimplemented in SoSceneTexture2, SoCamera, SoWWWInline, SoVRMLInline, SoBaseKit, SoTextureCombine, SoSceneTextureCubeMap, SoVRMLFontStyle, SoTextureCubeMap, SoVRMLSwitch, SoShapeHints, SoTexture2, SoTexture3, SoVRMLVertexShape, SoNodeKitListPart, SoVRMLTransform, SoVertexProperty, SoVRMLLOD, SoVRMLGroup, SoUnits, SoTransform, SoVRMLShape, SoFontStyle, SoVRMLParent, SoMaterialBinding, SoNormalBinding, SoTransparencyType, SoArray, SoBumpMap, SoDrawStyle, SoVRMLImageTexture, SoVRMLProximitySensor, SoClipPlaneManip, SoDirectionalLightManip, SoSpotLightManip, SoSeparator, SoPointLightManip, SoTransformManip, SoGroup, SoPolygonOffset, SoRotationXYZ, SoVertexAttribute, SoVRMLScript, SoProfile, SoTextureCoordinateBinding, SoAntiSquish, SoComplexity, SoMaterial, SoPickStyle, SoSwitch, SoVRMLMaterial, SoTexture3Transform, SoGeoCoordinate, SoVertexAttributeBinding, SoVRMLBillboard, SoVRMLTextureTransform, SoCacheHint, SoGeoLocation, SoLOD, SoResetTransform, SoTextureCoordinatePlane, SoTextureUnit, SoVRMLAppearance, SoBumpMapTransform, SoLightModel, SoSurroundScale, SoTexture2Transform, SoGeoOrigin, SoLevelOfDetail, SoFile, SoTextureCoordinateObject, SoVRMLColor, SoVRMLCoordinate, SoVRMLNormal, SoVRMLPixelTexture, SoVRMLTextureCoordinate, SoVRMLVertexLine, SoVRMLVertexPoint, SoMultipleCopy, SoNormal, SoPathSwitch, SoBaseColor, SoClipPlane, SoCoordinate3, SoCoordinate4, SoFont, SoPackedColor, SoTextureCoordinate3, SoTextureCoordinateReflectionMap, SoCallback, SoMatrixTransform, SoRotation, SoScale, SoTextureCoordinate2, SoTextureCoordinateNormalMap, SoTranslation, SoBumpMapCoordinate, SoProfileCoordinate2, SoProfileCoordinate3, SoTextureMatrixTransform, SoTransformSeparator, SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateCube, SoTextureCoordinateCylinder, and SoTextureCoordinateSphere.

void SoNode::GLRender (SoGLRenderAction * action) [virtual]

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 in SoSceneTexture2, SoCamera, SoWWWInline, SoVRMLInline, SoBaseKit, SoMarkerSet, SoTextureCombine, SoSceneTextureCubeMap, SoVRMLFontStyle, SoTextureCubeMap, SoTabPlaneDragger, SoVRMLSwitch, SoProfilerStats, SoShapeHints, SoTexture2, SoTexture3, SoVRMLVertexShape, SoDragger, SoText3, SoNodeKitListPart, SoImage, SoUnits, SoVRMLElevationGrid, SoVRMLLOD, SoVertexProperty, SoVRMLGroup, SoShaderObject, SoVRMLMovieTexture, SoShape, SoTransform, SoVRMLShape, SoFontStyle, SoArray, SoCylinder, SoDepthBuffer, SoGeometryShader, SoMaterialBinding, SoNormalBinding, SoTransparencyType, SoClipPlaneManip, SoDirectionalLightManip, SoAntiSquish, SoBumpMap, SoDrawStyle, SoVRMLBackground, SoVRMLImageTexture, SoVRMLProximitySensor, SoVRMLText, SoSpotLightManip, SoVRMLExtrusion, SoPointLightManip, SoTransformManip, SoAsciiText, SoCone, SoIndexedNurbsSurface, SoPolygonOffset, SoSeparator, SoSurroundScale, SoVRMLScript, SoComplexity, SoGroup, SoProfile, SoRotationXYZ, SoShaderProgram, SoTextureCoordinateBinding, SoVertexAttribute, SoVRMLViewpoint, SoSwitch, SoVRMLIndexedFaceSet, SoMaterial, SoNurbsSurface, SoText2, SoTexture3Transform, SoVRMLMaterial, SoVRMLNavigationInfo, SoGeoCoordinate, SoVRMLBillboard, SoVRMLTextureTransform, SoVRMLVisibilitySensor, SoEnvironment, SoGeoLocation, SoLOD, SoResetTransform, SoTextureScalePolicy, SoTextureUnit, SoVertexAttributeBinding, SoVRMLAppearance, SoVRMLCollision, SoVRMLFog, SoShadowStyle, SoBumpMapTransform, SoCacheHint, SoTexture2Transform, SoTextureCoordinatePlane, SoVRMLSpotLight, SoGeoOrigin, SoIndexedNurbsCurve, SoLevelOfDetail, SoLightModel, SoVRMLCylinder, SoShadowCulling, SoFile, SoVRMLCone, SoVRMLLight, SoVRMLTextureCoordinate, SoCube, SoMultipleCopy, SoNurbsCurve, SoSpotLight, SoTextureCoordinateObject, SoVRMLColor, SoVRMLCoordinate, SoVRMLIndexedLineSet, SoVRMLNormal, SoVRMLPixelTexture, SoVRMLPointLight, SoVRMLVertexLine, SoVRMLVertexPoint, SoFont, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedTriangleStripSet, SoNormal, SoPathSwitch, SoBaseColor, SoCallback, SoClipPlane, SoCoordinate3, SoCoordinate4, SoFaceSet, SoIndexedMarkerSet, SoMatrixTransform, SoPackedColor, SoScale, SoTextureCoordinate3, SoTextureCoordinateReflectionMap, SoTranslation, SoIndexedPointSet, SoLineSet, SoQuadMesh, SoRotation, SoTextureCoordinate2, SoTextureCoordinateNormalMap, SoTextureMatrixTransform, SoTransformSeparator, SoVRMLBox, SoVRMLDirectionalLight, SoVRMLSphere, SoVRMLTexture, SoShadowSpotLight, SoBumpMapCoordinate, SoDirectionalLight, SoPointLight, SoPointSet, SoProfileCoordinate2, SoProfileCoordinate3, SoSphere, SoTriangleStripSet, SoColorIndex, SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoVRMLPointSet, SoAnnotation, SoTextureCoordinateCube, SoTextureCoordinateCylinder, and SoTextureCoordinateSphere.

void SoNode::GLRenderBelowPath (SoGLRenderAction * action) [virtual]

Implements the SoAction::BELOW_PATH traversal method for the rendering action.

Reimplemented in SoExtSelection, SoVRMLGroup, SoVRMLLOD, SoVRMLTransform, SoShadowGroup, SoLocateHighlight, SoVRMLBillboard, SoSeparator, SoLOD, SoGeoSeparator, and SoAnnotation.

void SoNode::GLRenderInPath (SoGLRenderAction * action) [virtual]

Implements the SoAction::IN_PATH traversal method for the rendering action.

Reimplemented in SoVRMLGroup, SoVRMLLOD, SoVRMLTransform, SoShadowGroup, SoLocateHighlight, SoVRMLBillboard, SoSeparator, SoLOD, SoGeoSeparator, and SoAnnotation.

void SoNode::GLRenderOffPath (SoGLRenderAction * action) [virtual]

Implements the SoAction::OFF_PATH traversal method for the rendering action.

Reimplemented in SoVRMLGroup, SoVRMLLOD, SoVRMLBillboard, SoSeparator, SoLOD, and SoAnnotation.

void SoNode::callback (SoCallbackAction * action) [virtual]

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 in SoSceneTexture2, SoCamera, SoWWWInline, SoVRMLInline, SoBaseKit, SoTextureCombine, SoSceneTextureCubeMap, SoProfilerStats, SoVRMLFontStyle, SoTextureCubeMap, SoShapeHints, SoTexture2, SoVRMLSwitch, SoVRMLVertexShape, SoTexture3, SoDragger, SoVertexProperty, SoNodeKitListPart, SoVRMLTransform, SoVRMLLOD, SoShape, SoVRMLGroup, SoTransform, SoUnits, SoFontStyle, SoVRMLShape, SoMaterialBinding, SoNormalBinding, SoSeparator, SoTransparencyType, SoBumpMap, SoDrawStyle, SoVRMLImageTexture, SoVRMLProximitySensor, SoArray, SoClipPlaneManip, SoDirectionalLightManip, SoAntiSquish, SoSpotLightManip, SoGroup, SoRotationXYZ, SoPointLightManip, SoTransformManip, SoPolygonOffset, SoSurroundScale, SoVRMLScript, SoMaterial, SoProfile, SoTextureCoordinateBinding, SoVRMLMaterial, SoComplexity, SoPickStyle, SoSwitch, SoEnvironment, SoPathSwitch, SoTexture3Transform, SoTextureCoordinatePlane, SoVertexAttributeBinding, SoCacheHint, SoGeoCoordinate, SoVRMLBillboard, SoVRMLTextureTransform, SoGeoLocation, SoGeoSeparator, SoLOD, SoLightModel, SoResetTransform, SoTextureUnit, SoVRMLAppearance, SoBumpMapTransform, SoTexture2Transform, SoTextureCoordinateObject, SoVRMLCoordinate, SoVRMLVertexLine, SoVRMLVertexPoint, SoGeoOrigin, SoLevelOfDetail, SoVRMLColor, SoVRMLNormal, SoVRMLPixelTexture, SoCoordinate4, SoFile, SoFont, SoNormal, SoTextureCoordinateReflectionMap, SoVRMLTextureCoordinate, SoBaseColor, SoClipPlane, SoCoordinate3, SoMultipleCopy, SoPackedColor, SoTextureCoordinate3, SoTextureCoordinateNormalMap, SoLight, SoRotation, SoTextureCoordinate2, SoBumpMapCoordinate, SoCallback, SoMatrixTransform, SoProfileCoordinate2, SoProfileCoordinate3, SoScale, SoTextureCoordinateEnvironment, SoTranslation, SoTextureCoordinateDefault, SoTextureMatrixTransform, SoTransformSeparator, SoTextureCoordinateCube, SoTextureCoordinateCylinder, and SoTextureCoordinateSphere.

void SoNode::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

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 in SoDragger, SoCamera, SoWWWInline, SoVRMLInline, SoCenterballDragger, SoBaseKit, SoVRMLFontStyle, SoProfilerStats, SoVRMLSwitch, SoShapeHints, SoVRMLVertexShape, SoNodeKitListPart, SoVRMLLOD, SoVRMLTransform, SoVertexProperty, SoVRMLGroup, SoTransform, SoUnits, SoVRMLShape, SoArray, SoSeparator, SoShape, SoVRMLProximitySensor, SoFontStyle, SoClipPlaneManip, SoDirectionalLightManip, SoAntiSquish, SoSpotLightManip, SoPointLightManip, SoTransformManip, SoGroup, SoRotationXYZ, SoSurroundScale, SoVRMLScript, SoLOD, SoProfile, SoSwitch, SoComplexity, SoGeoCoordinate, SoGeoSeparator, SoVRMLBillboard, SoCacheHint, SoGeoLocation, SoIndexedNurbsCurve, SoResetTransform, SoLevelOfDetail, SoGeoOrigin, SoNurbsCurve, SoFile, SoMultipleCopy, SoVRMLIndexedLineSet, SoPathSwitch, SoVRMLCoordinate, SoVRMLVertexLine, SoVRMLVertexPoint, SoBlinker, SoCoordinate3, SoIndexedLineSet, SoCallback, SoCoordinate4, SoMatrixTransform, SoProfileCoordinate2, SoProfileCoordinate3, SoRotation, SoScale, SoTransformSeparator, SoTranslation, SoFont, SoIndexedPointSet, SoLineSet, SoPointSet, and SoVRMLPointSet.

void SoNode::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented in SoWWWInline, SoVRMLInline, SoCenterballDragger, SoBaseKit, SoProfilerStats, SoVRMLSwitch, SoDragger, SoNodeKitListPart, SoVRMLTransform, SoVRMLGroup, SoTransform, SoUnits, SoArray, SoSeparator, SoClipPlaneManip, SoDirectionalLightManip, SoAntiSquish, SoSpotLightManip, SoPointLightManip, SoTransformManip, SoGroup, SoRotationXYZ, SoSurroundScale, SoSwitch, SoGeoSeparator, SoTexture3Transform, SoVRMLBillboard, SoGeoLocation, SoResetTransform, SoVRMLTextureTransform, SoBumpMapTransform, SoGeoOrigin, SoMultipleCopy, SoTexture2Transform, SoFile, SoPathSwitch, SoCallback, SoMatrixTransform, SoRotation, SoScale, SoTransformSeparator, SoTranslation, and SoTextureMatrixTransform.

void SoNode::handleEvent (SoHandleEventAction * action) [virtual]

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 in SoDragger, SoCamera, SoExtSelection, SoSelection, SoWWWInline, SoVRMLInline, SoBaseKit, SoVRMLSwitch, SoEventCallback, SoProfilerStats, SoNodeKitListPart, SoSeparator, SoArray, SoClipPlaneManip, SoDirectionalLightManip, SoWWWAnchor, SoSpotLightManip, SoPointLightManip, SoTransformManip, SoGroup, SoVRMLScript, SoVRMLAnchor, SoLocateHighlight, SoSwitch, SoVRMLTimeSensor, SoVRMLTouchSensor, SoFile, SoMultipleCopy, SoPathSwitch, SoVRMLDragSensor, and SoCallback.

void SoNode::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented in SoWWWInline, SoVRMLInline, SoTextureCombine, SoProfilerStats, SoVRMLFontStyle, SoShapeHints, SoVRMLSwitch, SoVRMLVertexShape, SoNodeKitListPart, SoVertexProperty, SoUnits, SoTransform, SoFontStyle, SoClipPlaneManip, SoDirectionalLightManip, SoSpotLightManip, SoAntiSquish, SoMaterialBinding, SoNormalBinding, SoPointLightManip, SoTransformManip, SoArray, SoGroup, SoRotationXYZ, SoSurroundScale, SoVRMLScript, SoProfile, SoComplexity, SoTextureCoordinateBinding, SoSwitch, SoTexture3Transform, SoVRMLBillboard, SoGeoCoordinate, SoGeoLocation, SoPickStyle, SoResetTransform, SoVRMLTextureTransform, SoCacheHint, SoVertexAttributeBinding, SoBumpMapTransform, SoFile, SoGeoOrigin, SoTexture2Transform, SoTextureUnit, SoTextureCoordinatePlane, SoVRMLCoordinate, SoVRMLVertexLine, SoVRMLVertexPoint, SoCallback, SoVRMLNormal, SoVRMLTextureCoordinate, SoCoordinate3, SoCoordinate4, SoFont, SoMatrixTransform, SoMultipleCopy, SoNormal, SoRotation, SoScale, SoTextureCoordinateObject, SoTranslation, SoClipPlane, SoPathSwitch, SoTextureCoordinate3, SoTextureCoordinate2, SoTextureCoordinateReflectionMap, SoTextureMatrixTransform, SoBumpMapCoordinate, SoProfileCoordinate2, SoProfileCoordinate3, SoTextureCoordinateNormalMap, SoTransformSeparator, SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateCube, SoTextureCoordinateCylinder, and SoTextureCoordinateSphere.

void SoNode::rayPick (SoRayPickAction * action) [virtual]

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 in SoSceneTexture2, SoCamera, SoBaseKit, SoSceneTextureCubeMap, SoTextureCubeMap, SoProfilerStats, SoTexture2, SoDragger, SoVRMLTransform, SoImage, SoVRMLGroup, SoVRMLElevationGrid, SoVRMLLOD, SoSeparator, SoVRMLShape, SoShape, SoBumpMap, SoVRMLImageTexture, SoVRMLProximitySensor, SoCone, SoCylinder, SoIndexedNurbsSurface, SoGeoSeparator, SoLOD, SoNurbsSurface, SoText2, SoIndexedNurbsCurve, SoLevelOfDetail, SoVRMLCylinder, SoVRMLCone, SoVRMLPixelTexture, SoCube, SoNurbsCurve, SoVRMLBox, SoVRMLSphere, and SoSphere.

void SoNode::search (SoSearchAction * action) [virtual]

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.

See also:

SoSearchAction

Reimplemented in SoWWWInline, SoVRMLInline, SoBaseKit, SoProfilerStats, SoVRMLSwitch, SoDragger, SoNodeKitListPart, SoVRMLGroup, SoVRMLLOD, SoSeparator, SoVRMLShape, SoArray, SoShaderObject, SoClipPlaneManip, SoDirectionalLightManip, SoSpotLightManip, SoPointLightManip, SoTransformManip, SoGroup, SoVRMLParent, SoSwitch, SoShaderProgram, SoVRMLBillboard, SoFile, SoMultipleCopy, SoVRMLAppearance, SoPathSwitch, SoCallback, and SoVRMLGeometry.

void SoNode::write (SoWriteAction * action) [virtual]

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary.

Reimplemented in SoSceneTexture2, SoBaseKit, SoProfilerStats, SoVRMLSwitch, SoDragger, SoProto, SoVRMLGroup, SoVRMLLOD, SoVRMLShape, SoProtoInstance, SoGroup, SoVRMLParent, SoSwitch, SoVRMLScript, SoVertexShape, SoVertexAttribute, SoVRMLTimeSensor, SoPendulum, SoShuttle, SoCallback, and SoBlinker.

void SoNode::audioRender (SoAudioRenderAction * action) [virtual]

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances.

Reimplemented in SoCamera, SoWWWInline, SoVRMLSwitch, SoProfilerStats, SoVRMLSound, SoVRMLGroup, SoVRMLLOD, SoVRMLTransform, SoSeparator, SoArray, SoGroup, SoSwitch, SoLOD, SoFile, SoMultipleCopy, SoPathSwitch, SoLevelOfDetail, SoListener, and SoTransformSeparator.

void SoNode::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

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 in SoCamera, SoWWWInline, SoVRMLInline, SoBaseKit, SoMarkerSet, SoVRMLFontStyle, SoProfilerStats, SoDragger, SoNodeKitListPart, SoVRMLGroup, SoVRMLLOD, SoText3, SoVRMLTransform, SoImage, SoVertexProperty, SoUnits, SoVRMLElevationGrid, SoShape, SoTransform, SoVRMLShape, SoSeparator, SoArray, SoFontStyle, SoGroup, SoMaterialBinding, SoNormalBinding, SoVRMLParent, SoSwitch, SoRotationXYZ, SoVRMLText, SoCone, SoCylinder, SoIndexedNurbsSurface, SoProfile, SoVRMLExtrusion, SoAsciiText, SoComplexity, SoLOD, SoGeoSeparator, SoGeoCoordinate, SoGeoLocation, SoNurbsSurface, SoResetTransform, SoText2, SoVRMLIndexedFaceSet, SoVertexAttributeBinding, SoFile, SoGeoOrigin, SoMultipleCopy, SoPathSwitch, SoCallback, SoIndexedNurbsCurve, SoVRMLCylinder, SoVRMLVertexPoint, SoVRMLCone, SoVRMLNormal, SoVRMLTextureCoordinate, SoCoordinate3, SoCoordinate4, SoCube, SoFont, SoMatrixTransform, SoNormal, SoNurbsCurve, SoRotation, SoScale, SoTranslation, SoIndexedLineSet, SoTransformSeparator, SoVRMLIndexedLineSet, SoFaceSet, SoIndexedFaceSet, SoIndexedTriangleStripSet, SoProfileCoordinate2, SoProfileCoordinate3, SoIndexedPointSet, SoLineSet, SoVRMLBox, SoVRMLSphere, SoPointSet, SoQuadMesh, SoSphere, and SoTriangleStripSet.

void SoNode::grabEventsSetup (void) [virtual]

Called from SoHandleEventAction::setGrabber() to notify a node when it becomes the node where all events are sent.

Reimplemented in SoDragger.

void SoNode::grabEventsCleanup (void) [virtual]

Called from SoHandleEventAction to notify a node when it looses status as the node where events are sent.

Reimplemented in SoDragger.

void SoNode::startNotify (void) [virtual]

This is the method which starts the notification sequence after changes.

At the end of a notification sequence, all 'immediate' sensors (i.e. sensors set up with a zero priority) are triggered.

Reimplemented from SoBase.

void SoNode::notify (SoNotList * l) [virtual]

Notifies all auditors for this instance when changes are made.

Reimplemented from SoFieldContainer.

Reimplemented in SoSceneTexture2, SoVRMLSwitch, SoVRMLLOD, SoProfilerStats, SoSceneTextureCubeMap, SoTextureCubeMap, SoText3, SoTexture2, SoImage, SoVRMLGroup, SoTexture3, SoVRMLParent, SoVRMLTransform, SoVRMLVertexShape, SoVertexProperty, SoVRMLElevationGrid, SoShadowGroup, SoVRMLShape, SoAsciiText, SoSeparator, SoVRMLScript, SoBumpMap, SoVRMLProximitySensor, SoVRMLExtrusion, SoSwitch, SoVRMLBillboard, SoVRMLText, SoLOD, SoMaterial, SoShape, SoVertexAttribute, SoVRMLTouchSensor, SoVRMLAppearance, SoVRMLIndexedLine, SoVRMLPixelTexture, SoLevelOfDetail, SoVRMLIndexedLineSet, SoVertexShape, SoVRMLCollision, SoVRMLTimeSensor, SoVRMLVertexPoint, SoBlinker, SoIndexedLineSet, SoPackedColor, SoVRMLGeometry, SoVRMLVertexLine, SoVRMLIndexedShape, SoNodeEngine, SoIndexedPointSet, and SoIndexedMarkerSet.

uint32_t SoNode::getNodeId (void) const

This returns the node's current unique identification number. It is unlikely that application programmers will ever need use this method fom client application code, unless working with extensions to the core library (and probably not even then).

The id number is only valid for as long as the node is kept unchanged -- upon any kind of change the internal id will be updated (in the notify() method), and the old id number forgotten.

The technique described above plays an important role in the way internal scenegraph caches are set up and invalidated.

See also:

SoNode::getNextNodeId()

SoChildList * SoNode::getChildren (void) const [virtual]

Returns list of children for this node.

Reimplemented in SoVRMLInline, SoBaseKit, SoVRMLSwitch, SoVRMLLOD, SoWWWInline, SoNodeKitListPart, SoVRMLShape, SoClipPlaneManip, SoDirectionalLightManip, SoGroup, SoSpotLightManip, SoPointLightManip, SoTransformManip, SoVRMLText, SoFile, SoVRMLParent, SoVRMLAppearance, and SoVRMLGeometry.

void SoNode::writeInstance (SoOutput * out) [virtual]

Writes all the fields contained in this instance to the output stream within out.

This method is solely called from the write methods of fields.

Either from SoField if the write is done because of a field-to-field connection, or from one of the fields which may actually write SoFieldContainer instances, i.e. SoSFNode, SoMFNode, SoSFEngine, SoMFEngine, SoSFPath and SoMFPath.

This method, in addition to the ordinary write() method of SoNode, needs to be present since the fields don't have a write action instance in their writeValue() method, and writeInstance() will create a new SoWriteAction and call continueToApply() on it.

Reimplemented from SoFieldContainer.

Reimplemented in SoNodeEngine.

SoNode * SoNode::addToCopyDict (void) const [virtual]

Add a copy of this node and (recursively) all children to the copy dictionary of SoFieldContainer if this has not already been done.

Used internally during copy operations.

Reimplemented in SoBaseKit.

void SoNode::copyContents (const SoFieldContainer * from, SbBool copyconnections) [virtual]

Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE.

This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically.

For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

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 SoFieldContainer.

Reimplemented in SoWWWInline, SoBaseKit, SoVRMLSwitch, SoVRMLLOD, SoInteractionKit, SoNodeKitListPart, SoVRMLParent, SoClipPlaneManip, SoGroup, SoDirectionalLightManip, SoVRMLShape, SoSpotLightManip, SoPointLightManip, SoTransformManip, SoVRMLScript, SoRotateSphericalDragger, SoRotateCylindricalDragger, SoFile, SoCallback, SoVertexAttribute, SoVRMLAppearance, and SoVRMLGeometry.

SoFieldContainer * SoNode::copyThroughConnection (void) const [virtual]

Return copy of this instance.

Note: default implementation just returns this pointer, SoNode and SoEngine overrides this method to return the pointer to the actual copy.

Reimplemented from SoFieldContainer.

SoNode * SoNode::getByName (const SbName & name) [static]

Returns the last node that was registered under name.

See also:

SoBase::setName()

int SoNode::getByName (const SbName & name, SoNodeList & l) [static]

Finds all nodes with name and appends them to the l nodelist. Returns the number of nodes with the specified name.

See also:

SoBase::setName()

void SoNode::initClasses (void) [static]

Initialize all the node classes of Coin.

uint32_t SoNode::getNextNodeId (void) [static]

Return the next unique identification number to be assigned upon node construction or change. It is unlikely that application programmers will ever need use this method from client application code, unless working with extensions to the core library (and probably not even then).

See also:

SoNode::getNodeId

int SoNode::getActionMethodIndex (const SoType type) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

void SoNode::getBoundingBoxS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::getBoundingBox() virtual method which does the real work.

void SoNode::GLRenderS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::GLRender() virtual method which does the real work.

void SoNode::callbackS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::callback() virtual method which does the real work.

void SoNode::getMatrixS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::getMatrix() virtual method which does the real work.

void SoNode::handleEventS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::handleEvent() virtual method which does the real work.

void SoNode::pickS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::pick() virtual method which does the real work.

void SoNode::rayPickS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::rayPick() virtual method which does the real work.

void SoNode::searchS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::search() virtual method which does the real work.

void SoNode::writeS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::write() virtual method which does the real work.

void SoNode::audioRenderS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::audioRender() virtual method which does the real work.

void SoNode::getPrimitiveCountS (SoAction * action, SoNode * node) [static]

This is a static 'helper' method registered with the action, and used for calling the SoNode::getPrimitiveCount() virtual method which does the real work.

SbBool SoNode::readInstance (SoInput * in, unsigned short flags) [protected], [virtual]

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.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoFieldContainer.

Reimplemented in SoBaseKit, SoWWWInline, SoVRMLSwitch, SoVRMLLOD, SoInteractionKit, SoTextureCubeMap, SoNodeKitListPart, SoSeparator, SoTexture2, SoVRMLParent, SoImage, SoTexture3, SoShaderObject, SoProto, SoFile, SoGroup, SoVRMLImageTexture, SoProtoInstance, SoNormalBinding, SoBumpMap, SoVertexAttribute, SoTextureCoordinateBinding, SoNodeEngine, and SoVRMLPixelTexture.

const SoFieldData ** SoNode::getFieldDataPtr (void) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

void SoNode::setNextActionMethodIndex (int index) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Only in TGS Inventor on Win32 -- to avoid needing to export the nextActionMethodIndex member, see SoNode.h for more info.

int SoNode::getNextActionMethodIndex (void) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Only in TGS Inventor on Win32 -- to avoid needing to export the nextActionMethodIndex member, see SoNode.h for more info.

void SoNode::incNextActionMethodIndex (void) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Only in TGS Inventor on Win32 -- to avoid needing to export the nextActionMethodIndex member, see SoNode.h for more info.

void SoNode::setCompatibilityTypes (const SoType & nodetype, const uint32_t bitmask) [static], [protected]

Set the node compatibility mask for node type nodetype. The mask specifies for which file formats the node is supported.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

See also:

getCompatibilityMode()

Since:

Coin 2.0

Member Data Documentation

uint32_t SoNode::uniqueId [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

uint32_t SoNode::nextUniqueId = 1 [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

int SoNode::nextActionMethodIndex = 0 [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Author

Generated automatically by Doxygen for Coin from the source code.

Referenced By

SoNode.3coin2(3) is an alias of SoNode.3coin3(3).

Mon Sep 5 2016 Version 3.1.3 Coin