trusty (3) general.3.gz

NAME

       Miscellaneous Classes -

   Classes
       class SoFieldContainer
           The SoFieldContainer class is a base class for all classes that contain fields.

       The classes containing fields in Coin are the node and engine classes, so they are all subclasses of
       SoFieldContainer. "
   class SoInput
       The SoInput class is an abstraction 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. "
   class SoOutput
       The SoOutput class is an abstraction 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. "
   class SoAuditorList
       The SoAuditorList class is used to keep track of auditors for certain object classes.

       This class is mainly for internal use (from SoBase) and it should not be necessary to be familiar with it
       for 'ordinary' Coin use. "
   class SoBaseList
       The SoBaseList class is a container for pointers to SoBase derived objects.

       The additional capability of the SoBaseList class over its parent class, SbPList, is to automatically
       handle referencing and dereferencing of items as they are added or removed from the lists. "
   class SoCallbackList
       The 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. "
   class SoPathList
       The SoPathList class is a container for pointers to SoPath objects.

       As this class inherits SoBaseList, referencing and dereferencing will default be done on the objects at
       append(), remove(), insert() etc. "
   class SoPickedPointList
       The SoPickedPointList class is a container for pointers to SoPickedPoint objects.

       This list class will delete the picked points when destructed/truncated, or when a picked point in the
       list is replaced by another picked point The caller is responsible for allocating the picked points
       passed to the list, but should not deallocate them since this will be handled by the list. "
   class SoTypeList
       The SoTypeList class is a container class for arrays of SoType objects.
   class SoAudioDevice
       The SoAudioDevice class is used 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. "
   class SoBase
       The SoBase class is the top-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. "
   class SoChildList
       The SoChildList class is a container for node children.

       This class does automatic notification on the parent nodes upon adding or removing children. "
   class SoContextHandler
       The SoContextHandler class is for now to be treated as an internal class.
   class SoDB
       The SoDB class keeps track of internal global data.

       This class collects various methods for initializing, setting and accessing common global data from the
       Coin library. "
   class SoFullPath
       The SoFullPath class allows examination of hidden children in paths.

       SoPath allows only access from the head node to the first node with hidden children, but not any further.
       "
   class SoInteraction
       The SoInteraction class takes 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. "
   class SoLightPath
       The SoLightPath class is a light 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). "
   class SoNormalGenerator
       The SoNormalGenerator class is used to generate normals.

       FIXME: document properly. "
   class SoNotList
       The SoNotList class is a list of SoNotRec notification records.
   class SoNotRec
       The SoNotRec class specifies records for notification lists.
   class SoPath
       The SoPath class is a container class for traversal path descriptions.

       SoPath objects contain a list of SoNode pointers and a list of child indices. Indices are necessary to
       disambiguate situations where a node uses the same node as a child multiple times. "
   class SoPickedPoint
       The SoPickedPoint class is used 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. "
   class SoPrimitiveVertex
       The SoPrimitiveVertex class represents a single 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. "
   class SoSceneManager
       The SoSceneManager class provides the main 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. "
   class SoState
       The SoState class manages 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). "
   class SoTempPath
       The SoTempPath class is used to store temporary paths.

       The path simply turns off auditing in the constructor, and leaves the user with the responsibility of
       keeping the path valid. "
   class SoType
       The SoType class is the basis 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. "
   class SoOffscreenRenderer
       The SoOffscreenRenderer class is used 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). "

Detailed Description

Author

       Generated automatically by Doxygen for Coin from the source code.