Coin Logo http://www.sim.no/
http://www.coin3d.org/

Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12345678]
oCcc_stringThe cc_string type is a C ADT for ASCII string management.This is a Coin extension
oCSbBarrierImplements the "barrier" multi-thread synchronization technique.A barrier is a synchronization mechanism that is used for blocking threads as they enter the barrier until a given number of threads are blocked, at which point all the threads are released again
oCSbBox2d2 dimensional box with double precision corner coordinates.This box class is used by many other classes in Coin for data exchange and storage. It provides two box corners with double precision coordinates, which is among other things useful for representing screen or canvas dimensions in normalized coordinates
oCSbBox2f2 dimensional box with floating point corner coordinates.This box class is used by many other classes in Coin for data exchange and storage. It provides two box corners with floating point coordinates, which is among other things useful for representing screen or canvas dimensions in normalized coordinates
oCSbBox2s2 dimensional box with short integer coordinates.This box class is used by other classes in Coin for data exchange. It provides storage for two box corners with short integer coordinates, which is among other things useful for representing screen or canvas areas in absolute window coordinates
oCSbBox3dAbstraction for an axis aligned 3 dimensional box.This box abstraction class is used by other entities in the Coin library for data exchange and storage. It provides a representation of the defining corners of a box in 3D space, with the sides aligned with the 3 principal axes
oCSbBox3fAbstraction for an axis aligned 3 dimensional box.This box abstraction class is used by other entities in the Coin library for data exchange and storage. It provides a representation of the defining corners of a box in 3D space, with the sides aligned with the 3 principal axes
oCSbBox3s3 dimensional box with short integer coordinates.This box class is used by other classes in Coin for data exchange. It provides storage for two box corners with short integer coordinates, which is among other things useful for representing screen or canvas areas in absolute window coordinates
oCSbBSPTreeBinary space partitioning container.This class can be used to organize searches for 3D points or normals in a set in O(log(n)) time
oCSbClipGeneric polygon clipper class.It is used by first adding all vertices in the polygon, and then clipping against any number of planes. If you need to supply additional information per vertex (e.g. texture coordinates), you should supply a callback in the constructor, and a pointer to your vertex structure in addVertex(). For every new vertex created, the callback is called with the line being clipped, including the pointers to your vertex structures and the position of the new (clipped against some plane) vertex. You should then create a new vertex structure, calculate your data (e.g. a new texture coordinate) and return a pointer to this structure
oCSbCondVarA class for synchronizing access to global variables.Condition variables are used to protect global variables in an environment where multiple threads are running concurrently
oCSbCylinderRepresentation of a cylinder.This class is used within other classes in Coin. It contains data to represent a cylinder by an axis and a radius. The cylinder has no length/height value, which means it is treated as of infinite length
oCSbDictOrganizes a dictionary of keys and values.It uses hashing to quickly insert and find entries in the dictionary. An entry consists of an unique key and a generic pointer
oCSbDPLineLine in 3D space.SbDPLine is used by many other classes in Coin. It provides a way of specifying a directed line (also known as a ray) through a specified point (origin) and a direction in 3D space. Note that the line is infinite in both directions from its definition point
oCSbDPMatrix4x4 dimensional representation of a double-precision matrix.This class is like the SbMatrix class, but uses double-precision floating point values for its elements. For more class documentation, see SbMatrix
oCSbDPRotationRotation in 3D space.SbDPRotation is used extensively throughout the Coin library
oCSbDPViewVolumeDouble precision viewing volume in 3D space.This class contains the necessary information for storing a view volume. It has methods for projection of primitives from or into the 3D volume, doing camera transforms, view volume transforms etc
oCSbFifoA class for managing a pointer first-in, first-out queue
oCSbHeapGeneric heap class.FIXME: write doc
oCSbHeapFuncsThe SbHeapFuncs struct is used to specify functions on heap elements
oCSbImageAbstract datatype for 2D and 3D images.Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API
oCSbLineLine in 3D space.SbLine provides a way of specifying a directed line, through a 3D point (origin) and a vector direction in 3D space
oCSbList< Type >The SbList class is a template container class for lists.SbList is an extension of the Coin library versus the original Open Inventor API. Open Inventor handles most list classes by inheriting the SbPList class, which contains an array of generic void* pointers. By using this template-based class instead, we can share more code and make the list handling code more typesafe
oCSbList< BogusSet * >
oCSbList< CallbackInfo >
oCSbList< cc_xml_attr * >
oCSbList< cc_xml_elt * >
oCSbList< class CatalogItem * >
oCSbList< ContentsCopiedMap * >
oCSbList< dldata >
oCSbList< double >
oCSbList< float >
oCSbList< int >
oCSbList< int32_t >
oCSbList< ReadImageCBData >
oCSbList< SbBool >
oCSbList< SbClipData >
oCSbList< SbList< SbVec2s > >
oCSbList< SbMatrix >
oCSbList< SbName >
oCSbList< SbString >
oCSbList< SbTri3f * >
oCSbList< SbVec2f >
oCSbList< SbVec2s >
oCSbList< SbVec3f >
oCSbList< SbVec4f >
oCSbList< ShapeData * >
oCSbList< so_plane_data >
oCSbList< SoDelayQueueSensor * >
oCSbList< SoElement * >
oCSbList< SoEnumEntry * >
oCSbList< SoFieldContainerCopyMap * >
oCSbList< SoFieldEntry * >
oCSbList< SoGLDisplayList * >
oCSbList< SoGLDriver * >
oCSbList< SoGLRenderCache * >
oCSbList< SoInput_FileInfo * >
oCSbList< SoNode * >
oCSbList< SoOutputDataEntry * >
oCSbList< SoOutputROUTE >
oCSbList< SoOutputROUTEList * >
oCSbList< SoPath * >
oCSbList< SoProto * >
oCSbList< SoSFNode * >
oCSbList< SoShadowLightCache * >
oCSbList< soshape_bigtexture * >
oCSbList< SoTempPath * >
oCSbList< SoTimerQueueSensor * >
oCSbList< SoTimerSensor * >
oCSbList< SoTypeData * >
oCSbList< SoVBO * >
oCSbList< struct so_eval_node * >
oCSbList< struct Vertex * >
oCSbList< uint16_t >
oCSbList< uint32_t >
oCSbList< uint8_t >
oCSbList< unsigned int >
oCSbList< versionrange >
oCSbList< Vertex >
oCSbList< void * >
oCSbMatrix4x4 dimensional representation of a matrix.SbMatrix is used by many other classes in Coin. It provides storage for a 4x4 matrix of single-precision floating point values
oCSbMutexA basic class for managing a mutex.This class provides a portable framework around the mutex interface of the underlying native thread-handling toolkit
oCSbNameStores strings by reference.The class is used by Coin for storing keywords, names and other strings. They are stored in a manner where identical strings are guaranteed to map to the same memory address (as returned by the SbName::getString() method)
oCSbOctTreeDefines a generic oct tree for fast geometry searches.Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API
oCSbOctTreeFuncs
oCSbPlanePlane in 3D space.SbDPPlane is used by many other classes in Coin. It provides a way of representing a plane, specified by a plane normal vector and a distance from the origin of the coordinate system
oCSbPListContainer class for void pointers
oCSbProfilingDataData structure for gathering scene graph traversal profiling information
oCSbProjectorAbstract base projector class.Projectors are used in the Coin library for mapping 2D coordinates (typically from the position of the mouse cursor in the rendering window) to 3D "world" coordinates
oCSbRotationRotation in 3D space.SbRotation is used extensively throughout the Coin library
oCSbRWMutex
oCSbSphereRepresentation of a sphere.This class is used within many other classes in Coin. It contains the data neccessary to represent a sphere (a 3D point and a radius)
oCSbStorageManages thread-local memory.This class manages thread-local memory. When different threads access the memory an SbStorage object manages, they will receive different memory blocks back
oCSbStringString class with convenience functions for string operations.This is the class used for storing and working with character strings. It automatically takes care of supporting all the "bookkeeping" tasks usually associated with working with character strings, like memory allocation and deallocation etc
oCSbTesselatorUsed to tessellate polygons into triangles.SbTesselator is used within Coin to split polygons into triangles. It handles concave polygons, does Delaunay triangulation and avoids generating self-intersecting triangles
oCSbThreadA class for managing threads.This class provides a portable framework around the tasks of instantiating, starting, stopping and joining threads
oCSbThreadAutoLockSimple convenience class for locking access to a function.This class provides a simple convenience mechanism for automatically locking access to a function that is not re-entrant
oCSbTimeInstances represents time values.SbTime is a convenient way of doing system independent representation and calculations on time values of high resolution
oCSbTypedStorage< Type >The SbTypedStorage class manages generic thread-local memory.This class manages thread-local memory. When different threads access the memory an SbTypedStorage object manages, they will receive different memory blocks back
oCSbVec2bVector class for containing two byte integers
oCSbVec2d2 dimensional vector with double precision floating point coordinates.This vector class is used by many other classes in Coin. It provides storage for a vector in 2 dimensions aswell as simple floating point arithmetic operations on this vector
oCSbVec2f2 dimensional vector with floating point coordinates.This vector class is used by many other classes in Coin. It provides storage for a vector in 2 dimensions aswell as simple floating point arithmetic operations on this vector
oCSbVec2i322 dimensional vector with short integer coordinates.This vector class is used by many other classes in Coin. It provides storage for a vector in 2 dimensions as well as simple integer arithmetic operations
oCSbVec2s2 dimensional vector with short integer coordinates.This vector class is used by many other classes in Coin. It provides storage for a vector in 2 dimensions as well as simple integer arithmetic operations
oCSbVec2ub
oCSbVec2ui32
oCSbVec2us
oCSbVec3b
oCSbVec3d3 dimensional vector with double precision floating point coordinates.This vector class provides storage for a 3 dimensional double precision floating point vector aswell as simple floating point arithmetic operations
oCSbVec3f3 dimensional vector with floating point coordinates.This vector class is used by many other classes in Coin. It provides storage for a 3 dimensional vector aswell as simple floating point arithmetic operations
oCSbVec3i32
oCSbVec3s3 dimensional vector with short integer coordinates.This vector class provides storage for a 3 dimensional vector as well as simple integer arithmetic operations
oCSbVec3ub
oCSbVec3ui32
oCSbVec3us
oCSbVec4b
oCSbVec4d4 dimensional vector with double precision floating point coordinates.This vector class is not by many other classes in Coin. It provides storage for a 3 dimensional homogeneoues vector (with the 4 components usually referred to as <x, y, z, w>) aswell as simple double precision floating point arithmetic operations
oCSbVec4f4 dimensional vector with floating point coordinates.This vector class is used by many other classes in Coin. It provides storage for a 3 dimensional homogeneoues vector (with the 4 components usually referred to as <x, y, z, w>) aswell as simple floating point arithmetic operations
oCSbVec4i32
oCSbVec4s
oCSbVec4ub
oCSbVec4ui32
oCSbViewportRegionViewport within a full window.The SbViewportRegion class contains information to represent a subview within a window. It stores information about the origin and size of the subview, aswell as the size of the underlying "full" window
oCSbViewVolumeViewing volume in 3D space.This class contains the necessary information for storing a view volume. It has methods for projection of primitives into the 3D volume from 2D points in the projection plane or vice versa, doing camera transforms, view volume transforms, etc
oCScXMLNamespace for static ScXML-related functions
oCScXMLObjectBase class for all SCXML objects
oCSoActionBase class for all traversal actions.Applying actions is the basic mechanism in Coin for executing various operations on scene graphs or paths within scene graphs, including search operations, rendering, interaction through picking, etc
oCSoAudioDeviceUsed to control an audio device.The SoAudioDevice class is responsible for initialization of an audio device, as well as enabling and disabling sound. It is a singleton class
oCSoBaseTop-level superclass for a number of class-hierarchies.SoBase provides the basic interfaces and methods for doing reference counting, type identification and import/export. All classes in Coin which uses these mechanisms are descendent from this class
oCSoBundleSuperclass for all bundle classes
oCSoCacheSuperclass for all internal cache classes.It organizes reference counting to make it possible to share cache instances. It also organizes a list of elements that will affect the cache. If any of the elements have changed since the cache was created, the cache is invalid
oCSoCallbackListThe SoCallbackList is a container for callback function pointers.This list stores callback function pointers (along with user-specified extra data to pass to the callbacks) and provides a method for triggering the callback functions
oCSoContextHandlerFor now to be treated as an internal class
oCSoDBKeeps track of internal global data.This class collects various methods for initializing, setting and accessing common global data from the Coin library
oCSoDebug
oCSoDetailSuperclass for all classes storing detailed information about particular shapes.Detail information about shapes is used in relation to picking actions in Coin. They typically contain the relevant information about what particular part of the shape a pick ray intersected with
oCSoElementSoElement is the abstract base class for all elements
oCSoEnabledElementsListContainer for type info for element types that are enabled in actions.This class is probably not interesting for the application programmer
oCSoEngineOutputOutput slots in SoEngine instances.SoEngineOutput has methods for convenient handling of the connections made from SoEngine objects to SoField objects
oCSoEngineOutputDataContainer for a prototype set of outputs.This class is instantiated once for each class of objects which use outputs, and which needs to be able to import and export them
oCSoErrorBase class for all the error handling classes.The default error handler just prints messages on the standard error output channel, but this can be overridden by client applications
oCSoEventBase class for all Coin events.Coin contains its own set of event classes, independent of the underlying window system
oCSoEventManagerEvent handling for a Coin3D viewer
oCSoFieldTop-level abstract base class for fields.Fields is the mechanism used throughout Coin for encapsulating basic data types to detect changes made to them, and to provide conversion, import and export facilities
oCSoFieldDataContainer for a prototype set of fields.This class is instantiated once for each class of objects which use fields, and which needs to be able to import and export them
oCSoGLCacheListUsed to store and manage OpenGL caches
oCSoGLDisplayListStores and manages OpenGL display lists.The TEXTURE_OBJECT type is not directly supported in Coin. We handle textures differently in a more flexible class called SoGLImage, which also stores some information about the texture used when rendering. Old code which use this element should not stop working though. The texture object extension will just not be used, and the texture will be stored in a display list instead
oCSoGLDriverDatabaseUsed for looking up broken/slow features in OpenGL drivers
oCSoGLImageUsed to handle OpenGL 2D/3D textures
oCSoGLMultiTextureCoordinateElementStores the current gltexture coordinates for several units
oCSoGLProjectionMatrixElementYet to be documented.FIXME: write doc
oCSoGLShapeHintsElementYet to be documented.FIXME: write doc
oCSoGLTexture3EnabledElementElement which controls whether 3D texturing is enabled or not.Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API
oCSoGlyphUsed to generate and reuse font glyph bitmaps and outlines
oCSoHardCopyStatic class for initializing the hardcopy support
oCSoInputAbstraction of file import functionality.This class takes care of most of the chores of doing data import in Coin. It puts a layer of abstraction over the read operations to make it transparent for the rest of the Coin code whether or not we're reading from a file, from a memory buffer or from stdin
oCSoInteractionTakes care of initalizing internal classes.SoInteraction is present for the sole purpose of providing an interface to the initialization methods of the classes in Coin which are somehow related to user interaction, like the draggers and manipulators
oCSoIntersectingPrimitiveStruct with collision information
oCSoLightPathLight version of SoPath.SoLightPath can be used if you only need a temporary path, and don't want the overhead that comes with an SoPath (ref, unref, auditing etc)
oCSoLockManagerThe SoLockManager is a defunct software license lock mechanism.This is just a dummy implementation of the TGS Inventor class used to provide a license locking mechanism. Since Coin can be used without any royalty fees or client-site license locks, no such mechanism is needed
oCSoNodeKitUsed to initialize the nodekit classes.The sole function of SoNodeKit is to be just a placeholder for the toplevel initialization code for all nodekit-related classes
oCSoNodekitCatalogContainer for nodekit layouts.Nodekits store all their hierarchical layout information and part information in instances of this class
oCSoNormalGeneratorUsed to generate normals.FIXME: document properly
oCSoNotListList of SoNotRec notification records
oCSoNotRecRecords for notification lists
oCSoOffscreenRendererUsed for rendering scenes in offscreen buffers.If you want to render to a memory buffer instead of an on-screen OpenGL context, use this class. Rendering to a memory buffer can be used to generate texture maps on-the-fly, or for saving snapshots of the scene to disk files (as pixel bitmaps or as Postscript files for sending to a Postscript-capable printer)
oCSoOutputAbstraction of an output stream.SoOutput offers the ability to write basic types to a file or a memory buffer in either ASCII or binary format
oCSoPickedPointUsed for specifying picked points.It holds miscellaneous information about the picked point, such as position, normal, texture coordinate and material index in the current material. It might also hold detail information (an SoDetail subclass) for every node in the picked path
oCSoPrimitiveVertexSingle vertex of a generated primitive.Instances of SoPrimitiveVertex are constructed when generating primitive data, primarily during an SoCallbackAction traversal. Depending on the context the vertex could represent a single 3D point, one of the two vertices in a line or one of the three vertices in a triangle
oCSoProfilerMain static class for initializing the scene graph profiling subsystem
oCSoProfilingReportGeneratorConvenience report generator functionality
oCSoRenderManager
oCSoSceneManagerMain interface between the scene graph and the GUI toolkit.The renderarea class from the GUI toolkit you are using uses this class as the interface against the scene graph. Event handling and providing "hooks" to do rendering are the main functions of the class
oCSoSensorAbstract base class for all sensors.Sensors is a mechanism in Coin for scheduling jobs to be run upon specific events. The events in question could be particular points in time, or changes to entities in the scene graph
oCSoSensorManagerHandles the sensor queues.There are two major sensor types in Coin, "delay" sensors and "timer" sensors:
oCSoStateManages the Coin scenegraph traversal state data.The SoState class is used by actions derived from the SoAction class. It manages the scenegraph state as stacks of elements (ie instances of classes derived from SoElement)
oCSoTexture2Used to map a 2D texture onto subsequent geometry in the scenegraph.Shape nodes within the scope of SoTexture2 nodes in the scenegraph (ie below the same SoSeparator and to the righthand side of the SoTexture2) will have the texture applied according to each shape type's individual characteristics. See the documentation of the various shape types (SoFaceSet, SoCube, SoSphere, etc etc) for information about the specifics of how the textures will be applied
oCSoTexture3Used to map a 3D texture onto geometry.Shape nodes within the scope of SoTexture3 nodes in the scenegraph (ie below the same SoSeparator and to the righthand side of the SoTexture3) will have the texture applied according to each shape type's individual characteristics. See the documentation of the various shape types (SoFaceSet, SoCube, SoSphere, etc etc) for information about the specifics of how the textures will be applied. An SoTexture3 node will override any previous encountered SoTexture2 nodes and vice versa. Mixing of SoTexture3 and SoTextureCoordinate2 (or the other way around) is legal, but the third texture coordinate component will be ignored (set to 0.0)
oCSoTextureCubeMapUsed to map a cube map onto subsequent shape nodes.Shape nodes within the scope of SoTextureCubeMap nodes in the scenegraph (ie below the same SoSeparator and to the righthand side of the SoTextureCubeMap) will have the texture applied according to each shape type's individual characteristics. See the documentation of the various shape types (SoFaceSet, SoCube, SoSphere, etc etc) for information about the specifics of how the textures will be applied
oCSoTypeBasis for the run-time type system in Coin.Many of the classes in the Coin library must have their type information registered before any instances are created (including, but not limited to: engines, nodes, fields, actions, nodekits and manipulators). The use of SoType to store this information provides lots of various functionality for working with class hierarchies, comparing class types, instantiating objects from classnames, etc etc
\CSoVectorOutputUsed for setting vector output file.SoVectorizeAction will create an SoVectorOutput which will output to stdout by default. SoVectorizeAction::getOutput() can be used to fetch this output, and the user will probably want to set a file to output to

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated on Fri Sep 9 2016 for Coin by Doxygen 1.8.5.