nodes(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 nodes(3) 💖

okay so bestie, welcome to nodes(3) from the Library Functions Manual — yes that's the whole vibe of this page, and it's about to be your new hyperfixation fr fr 🦋✨

✨ NAME ✨

nodes — Node Classes 👑

that's it, that's the whole name section — short, sweet, and serving main character energy. we are talking Node Classes here, and ngl the rest of this manual is gonna eat 💅🌸

✨ SYNOPSIS ✨

🎀 Classes 🎀

okay so here's the full lineup of classes, bestie — every single one, no cap. 💅

  • SoGeoCoordinate — the class you use when you need to specify a whole list of geographical coordinates 🌍
  • SoGeoLocation — this one georeferences the nodes that come after it 📍
  • SoGeoOrigin — specifies an absolute geographic location, and geometry gets referenced against it 🗺️
  • SoGeoSeparator — used to georeference a scene graph 🌐
  • SoAnnotation — draws all its child geometry on top of other geometry, main character energy ✨
  • SoAntiSquish — resets to uniform scaling, no squishing allowed 🙅‍♀️
  • SoArray — a group node for setting up regular arrays of subgraphs 🧩
  • SoBaseColor — a node type for conveniently setting the base material color 🎨
  • SoBlinker — a cycling switch node, blink blink 👀
  • SoBumpMap — maps a bump map onto subsequent shapes 🗺️
  • SoBumpMapCoordinate — provides bump map coordinates to shape nodes 📐
  • SoBumpMapTransform — defines 2D bump map transformations 🔄
  • SoCacheHint — a node with hints about how to cache geometry 💾
  • SoCallback — a node type that gives you a way to set callback hooks in the scene graph 🪝
  • SoCamera — the abstract base class for camera definition nodes 📷
  • SoClipPlane — a node type for specifying clipping planes ✂️
  • SoColorIndex — specifies color indices for subsequent shapes 🌈
  • SoComplexity — a node type for setting the tradeoff between quality and performance ⚖️
  • SoCoordinate3 — provides coordinates to shape nodes (3D, bestie) 📌
  • SoCoordinate4 — provides coordinates to shape nodes (4D, fancy) 🧊
  • SoDepthBuffer — controls the GL depth buffer 🕳️
  • SoDirectionalLight — a node type for specifying directional light sources 💡
  • SoDrawStyle — specifies common rendering properties for shapes 🖌️
  • SoEnvironment — specifies global rendering parameters 🌎
  • SoEventCallback — gives you functionality for catching events 🎣
  • SoExtSelection — can be used for extended selection functionality 🖱️
  • SoFile — a node container for another model file 📁
  • SoFont — an appearance node for setting fonts 🔤
  • SoFontStyle — changes the appearance of fonts for text rendering nodes ✍️
  • SoFrustumCamera — defines a camera with a generic frustum.. (yes, two dots, iconic) 📸
  • SoGroup — a node which manages other node instances 👯‍♀️
  • SoInfo — a node for holding text information 📝
  • SoLOD — chooses a child based on distance between viewer and object 📏
  • SoLabel — a node for holding label information in a scene graph 🏷️
  • SoLevelOfDetail — chooses a child based on projected size 📐
  • SoLight — the base class for light emitting nodes 💡
  • SoLightModel — a node for specifying the model for geometry lighting 🌟
  • SoLinearProfile — a node for specifying linear profile curves 📈
  • SoListener — defines listener attributes used when rendering sound 🔊
  • SoLocateHighlight — highlights geometry under the cursor 🖱️
  • SoMaterial — a node type for setting up material values for scene geometry 🧵
  • SoMaterialBinding — sets up how materials are mapped to shapes 🗺️
  • SoMatrixTransform — a transformation node 🔢
  • SoMultipleCopy — redraws its children multiple times at different transformations 🔁
  • SoNode — the base class for nodes used in scene graphs 🧬
  • SoNormal — a node for providing normals to the state 📐
  • SoNormalBinding — specifies normal vector bindings 🧭
  • SoNurbsProfile — a node for specifying smooth profile curves 🌀
  • SoOrthographicCamera — defines a camera node with orthographic rendering 📷
  • SoPackedColor — a node for setting diffuse and transparency material values 🎨
  • SoPathSwitch — traverses only when current path matches a configurable path 🛤️
  • SoPendulum — used to create oscillating rotations 🕰️
  • SoPerspectiveCamera — defines a camera node with perspective rendering 📸
  • SoPickStyle — sets up how to do picking 🎯
  • SoPointLight — a node type for light sources 💡
  • SoPolygonOffset — a node type for layering rendering primitives 🧱
  • SoProfile — the abstract superclass for profile definitions 📜
  • SoProfileCoordinate2 — specifies a set of 2D coordinates for profiles 📌
  • SoProfileCoordinate3 — specifies a set of 3D coordinates for profiles 📌
  • SoResetTransform — makes it possible to nullify state during traversal 🔄
  • SoRotation — specifies a rotation transformation 🔄
  • SoRotationXYZ — a node type for specifying rotation around a particular axis 🌀
  • SoRotor — a node used to animate rotations 🎠
  • SoScale — a node type for scaling scene graph geometry 📏
  • SoSceneTexture2 — creates a 2D texture from a Coin scene graph 🖼️
  • SoSceneTextureCubeMap — renders a scene into a texture cube map 🧊
  • SoSelection — manages a list of selected nodes ✅
  • SoSeparator — a state-preserving group node 🛡️
  • SoShapeHints — a node with hints about how to render geometry 💡
  • SoShuttle — oscillates between two translations 🚌
  • SoSpotLight — a node type for light sources with a cone shaped light volume 🔦
  • SoSurroundScale — automatically scales geometry to surround other geometry 🔄
  • SoSwitch — a group node which selects one child subgraph for traversal 🔀
  • SoTexture2 — maps a 2D texture onto subsequent geometry in the scene graph 🖼️
  • SoTexture2Transform — defines 2D texture transformations 🔄
  • SoTexture3 — maps a 3D texture onto geometry 🧊
  • SoTexture3Transform — defines 3D texture transformations 🔄
  • SoTextureCombine — a node for setting texture combine functions 🧪
  • SoTextureCoordinate2 — contains a set of coordinates for the mapping of 2D textures 📌
  • SoTextureCoordinate3 — contains a set of coordinates for the mapping of 2D textures 📌
  • SoTextureCoordinateBinding — says how texture coordinates should be bound to shapes 🧵
  • SoTextureCoordinateCube — autogenerates cubemapped texture coordinated for shapes 🧊
  • SoTextureCoordinateCylinder — autogenerates cylinder mapped texture coordinated for shapes 🛢️
  • SoTextureCoordinateDefault — removes texture coordinates from the state 🧹
  • SoTextureCoordinateEnvironment — generates texture coordinates by projecting onto a surrounding texture 🌐
  • SoTextureCoordinateFunction — an abstract base class for texture coordinate generating nodes 🧬
  • SoTextureCoordinateNormalMap — generates texture coordinates by projecting onto a surrounding texture 🌐
  • SoTextureCoordinateObject — generates texture coordinates by... (yes, it just trails off, iconic) ✨
  • SoTextureCoordinatePlane — generates texture coordinates by projecting onto a plane ✈️
  • SoTextureCoordinateReflectionMap — generates 3D reflection texture coordinates 🪞
  • SoTextureCoordinateSphere — autogenerates spheremapped texture coordinated for shapes 🌍
  • SoTextureCubeMap — maps a cube map onto subsequent shape nodes 🧊
  • SoTextureMatrixTransform — defines a texture matrix transformation 🔢
  • SoTextureScalePolicy — a node for controlling the texture scale policy 📏
  • SoTextureUnit — a node for setting the active texture unit 🎛️
  • SoTransform
  • SoTransform — the all-purpose transformation node type, she does it all 💅
  • SoTransformSeparator — a group node that preserves the current transformations
  • SoTransformation — the abstract base class for transformation nodes
  • SoTranslation — a node type for specifying geometry translations
  • SoTransparencyType — a node for setting the transparency type for shapes
  • SoUnits — a node for setting unit types
  • SoVertexProperty — collects the functionality of various appearance nodes
  • SoWWWAnchor — adds URL callbacks to the highlighted geometry
  • SoWWWInline — a node used to include data from an URL
  • SoFragmentShader — used for setting up fragment shader programs
  • SoGeometryShader — used for loading geometry shader programs
  • SoVertexShader — used for setting up vertex shader programs
  • SoShadowCulling — a node for setting the shadow style on nodes
  • SoShadowSpotLight — a node for setting up a spot light which casts shadows
  • SoShadowStyle — a node for setting the shadow style on nodes
  • SoAsciiText — renders flat 3D text
  • SoCone — for rendering cone shapes
  • SoCube — for rendering cubes
  • SoCylinder — for rendering cylinder shapes
  • SoFaceSet — used to render and organize non-indexed polygonal face data
  • SoImage — draws a 2D image on the viewport
  • SoIndexedFaceSet — used to handle generic indexed facesets
  • SoIndexedLineSet — used to render and otherwise represent indexed lines
  • SoIndexedMarkerSet — used to display a set of bitmap markers at 3D positions
  • SoIndexedNurbsCurve — a node for representing smooth curves
  • SoIndexedNurbsSurface — can be used to render NURBS surfaces
  • SoIndexedPointSet — used to display a set of 3D points
  • SoIndexedShape — the superclass for all indexed vertex shapes
  • SoIndexedTriangleStripSet — keeps data for rendering and otherwise representing triangle strips
  • SoLineSet — used to render and organize non-indexed polylines
  • SoMarkerSet — displays a set of 2D bitmap markers in 3D
  • SoNonIndexedShape — the superclass for all non-indexed vertex based shapes
  • SoNurbsCurve — a node for representing smooth curves
  • SoNurbsSurface — used to render smooth surfaces
  • SoPointSet — used to display a set of 3D points
  • SoQuadMesh — used to render and optimize a quadrilateral mesh
  • SoShape — the superclass for geometry shapes
  • SoSphere — for rendering sphere shapes
  • SoText2 — a node type for visualizing 2D text aligned with the camera plane
  • SoText3 — renders extruded 3D text
  • SoTriangleStripSet — used to render and control non-indexed triangle strips
  • SoVertexShape — the superclass for all vertex based shapes

🦋 Macros 🦋

okay bestie, these are the macro signatures, copied exactly, no edits, no cap:

#define SO_NODE_HEADER(classname)
#define SO_NODE_ABSTRACT_HEADER(classname)
#define SO_NODE_INIT_CLASS(classname,  parentclass,  parentname)
#define SO_NODE_INIT_ABSTRACT_CLASS(classname,  parentclass,
    parentname)
#define SO_NODE_SOURCE(classname)
#define SO_NODE_ABSTRACT_SOURCE(classname)
#define SO_NODE_CONSTRUCTOR(classname)
#define SO_NODE_IS_FIRST_INSTANCE()
#define SO_NODE_ADD_FIELD(field,  defaultvalue)
#define SO_NODE_DEFINE_ENUM_VALUE(enumname,  enumvalue)

🦋 Functions 🦋

  • static SoType SoTexture::getClassTypeId (void) — common base class for texture nodes ✨

💖 Detailed Description 💖

so here's the tea 🍓: this is the set of nodes Coin implements using the original Open Inventor pattern — meaning they read and write to and from files using the Inventor/VRML1 format, and they produce side-effects for subsequent siblings under the same SoSeparator node during action traversal.

A subset of these nodes constitute the VRML1 format, and a bigger subset constitutes the Inventor format. The rest of the nodes are extensions that are not part of any standardized format. periodt.

For VRML97 nodes, see the VRML97 Classes page. 👑

The VRML1.0 specification lives at http://www.web3d.org/x3d/specifications/vrml/VRML1.0/index.html 🌈

🧚 Dynamic Loading of Extension Nodes 🧚

When Coin tries to get hold of a node type object (SoType) for a class based on the name string of the node type, it will — if no such node type has been initialized yet — scan the file system for a dynamically loadable extension node with that given name. This can be completely disabled by setting the environment variable COIN_NO_SOTYPE_DYNLOAD to a positive integer value, new from Coin v2.5.0. 🫶

On UNIX, extensions nodes are regular .so files. On Win32, extension nodes are built as DLLs. On Mac OS X systems, extension nodes are built as .dylib files.

Note: the extension nodes have to be built using the flag -dynamiclib, not -bundle. 💀

Whether the dynamically loadable objects should be named with or without the "lib" prefix is optional. Both schemes will work. slay.

People don't usually program in a way so that they instantiate new nodes through the node class' SoType object, but that is the way nodes are created when model files are loaded. This means that for all Coin applications that load model files, the custom extension nodes will automatically be supported for the model files without you having to modify their source code and rebuild the applications. iconic behaviour honestly.

See ftp://ftp.coin3d.org/pub/coin/src/dynloadsample.tar.gz for an example using two dynamically loadable extension nodes. You only use an examiner viewer to view the two extension nodes in action. ✨

Only a limited set of C++ compilers are supported as of yet. This is because, to initialize the extension node, it is necessary to know something about how the C++ compiler mangles the initClass symbol. If we don't know that, there is no way to locate the initClass method in the library, which means the extension node can not make itself known to the type system. 😭

If your C++ compiler is not supported, the source file to add support for a new compiler in is src/misc/cppmangle.icc. It is fairly trivial to add support for new compilers, but if you don't understand how, just ask us about it. Patches with support for new compilers are of course very welcome. 💜

See also

  • SoType

Since

  • Coin 2.0

🌸 Macro Definition Documentation 🌸

#define SO_NODE_HEADER( classname)

This macro adds standard declarations needed in Coin nodes for object creation and type identification.

See also

  • SO_NODE_SOURCE

#define SO_NODE_ABSTRACT_HEADER( classname)

This macro adds standard declarations needed in Coin nodes for type identification. It differs from SO_NODE_HEADER in that the object creation part is omitted. 🙈

See also

  • SO_NODE_ABSTRACT_SOURCE

#define SO_NODE_INIT_CLASS( classname, parentclass, parentname)

This macro is used in the initClass-function in a node class. It registers the class by name (by creating a new SoType for the class), so file reading will be able to create a node of this type and fill it with its field values. ✨

See also

  • SO_NODE_INIT_ABSTRACT_CLASS

#define SO_NODE_INIT_ABSTRACT_CLASS( classname, parentclass, parentname)

This macro is used in the initClass-function in abstract node classes. It registers the class by name (by creating a new SoType for the class) for type identification purposes.

See also

  • SO_NODE_INIT_CLASS

#define SO_NODE_SOURCE( classname)

This macro sets up the impementation of the declarations in SO_NODE_HEADER. It chould be placed in the implementation file for extension nodes. (yes, "impementation" and "chould" — we keep the originals, typos are part of the lore 🎀)

See also

  • SO_NODE_HEADER

#define SO_NODE_ABSTRACT_SOURCE( classname)

This macro sets up the impementation of the declarations in SO_NODE_ABSTRACT_HEADER. It chould be placed in the implementation file for abstract extension nodes.

See also

  • SO_NODE_ABSTRACT_HEADER

#define SO_NODE_CONSTRUCTOR( classname)

Place this in the node constructor. It sets up the fielddata object for the node class.

#define SO_NODE_IS_FIRST_INSTANCE()

This macro can be used as a predicate to test if the constructed node is the first constructed instance of a node class, in case some extra initialization needs to be done that can't be done in the initClass() function. main character energy fr fr. 👑

#define SO_NODE_ADD_FIELD( field, defaultvalue)

This registers a field for a node, and sets its value to the default value. For use in the constructor, below the SO_NODE_CONSTRUCTOR macro.

#define SO_NODE_DEFINE_ENUM_VALUE( enumname, enumvalue)

This macro associates enum names with values, used for file input/output. 💅

🌈 Function Documentation 🌈

SoType SoTexture::getClassTypeId (void ) [static]

Common base class for texture nodes. SoTexture SoTexture.h Inventor/nodes/SoTexture.h 🌸

Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since

  • Coin 3.0

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code. (not a human, just a lil robot doing its thing 🤖✨)

and that's the whole page bestie, we ate and left no crumbs 💅🍓 this was nodes(3) from Coin Version 3.1.3, so if you ever need to cite it or summon it again, that's the version and the date tag it's riding with. ily, go build something iconic 🦋💖

📦 where this page comes from