trusty (3) SoNormalBinding.3.gz

Provided by: libcoin80-doc_3.1.4~abc9f50-4ubuntu2_all bug

NAME

       SoNormalBinding -

       The SoNormalBinding class is a node for specifying normal vector bindings.

       Use nodes of this type to specify how to map normal vectors from SoNormal nodes in the scene graph to
       shape nodes.

SYNOPSIS

       #include <Inventor/nodes/SoNormalBinding.h>

       Inherits SoNode.

   Public Types
       enum Binding { OVERALL = SoNormalBindingElement::OVERALL, PER_PART = SoNormalBindingElement::PER_PART,
           PER_PART_INDEXED = SoNormalBindingElement::PER_PART_INDEXED, PER_FACE =
           SoNormalBindingElement::PER_FACE, PER_FACE_INDEXED = SoNormalBindingElement::PER_FACE_INDEXED,
           PER_VERTEX = SoNormalBindingElement::PER_VERTEX, PER_VERTEX_INDEXED =
           SoNormalBindingElement::PER_VERTEX_INDEXED, DEFAULT = PER_VERTEX_INDEXED, NONE = PER_VERTEX_INDEXED }

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase. This is used for
           run-time type checking and 'downward' casting.
       SoNormalBinding (void)
       virtual void doAction (SoAction *action)
       virtual void GLRender (SoGLRenderAction *action)
       virtual void callback (SoCallbackAction *action)
       virtual void pick (SoPickAction *action)
       virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)

   Public Attributes
       SoSFEnum value

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoNormalBinding ()
       virtual SbBool readInstance (SoInput *in, unsigned short flags)

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoNormalBinding class is a node for specifying normal vector bindings.

       Use nodes of this type to specify how to map normal vectors from SoNormal nodes in the scene graph to
       shape nodes.

       FILE FORMAT/DEFAULTS:

       NormalBinding {
           value PER_VERTEX_INDEXED
       }

Member Enumeration Documentation

   enum SoNormalBinding::Binding
       Enumeration of available types of mappings. See documentation of SoMaterialBinding node for explanation
       of the different values.

       Note that SoNormalBinding::DEFAULT and SoNormalBinding::NONE has been obsoleted and are both mapped to
       SoNormalBinding::PER_VERTEX_INDEXED.

Constructor & Destructor Documentation

   SoNormalBinding::SoNormalBinding (void)
       Constructor.

   SoNormalBinding::~SoNormalBinding () [protected],  [virtual]
       Destructor.

Member Function Documentation

   SoType SoNormalBinding::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This is used for
       run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

       For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or
       others: this method needs to be overridden in all subclasses. This is typically done as part of setting
       up the full type system for extension classes, which is usually accomplished by using the pre-defined
       macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and
       SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

       For more information on writing Coin extensions, see the class documentation of the toplevel superclasses
       for the various class groups.

       Implements SoBase.

   const SoFieldData * SoNormalBinding::getFieldData (void) const [protected],  [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no fields are
       present, returns NULL.

       Reimplemented from SoFieldContainer.

   void SoNormalBinding::doAction (SoAction *action) [virtual]
       This function performs the typical operation of a node for any action.

       Reimplemented from SoNode.

   void SoNormalBinding::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 from SoNode.

   void SoNormalBinding::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 from SoNode.

   void SoNormalBinding::pick (SoPickAction *action) [virtual]
       Action method for SoPickAction.

       Does common processing for SoPickAction action instances.

       Reimplemented from SoNode.

   void SoNormalBinding::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 from SoNode.

   SbBool SoNormalBinding::readInstance (SoInput *in, unsigned shortflags) [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 SoNode.

Member Data Documentation

   SoSFEnum SoNormalBinding::value
       The normal binding to use for subsequent shape nodes in the scene graph.

Author

       Generated automatically by Doxygen for Coin from the source code.