trusty (3) SoSceneTextureCubeMap.3.gz

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

NAME

       SoSceneTextureCubeMap -

       Renders a scene into a texture cube map.

SYNOPSIS

       #include <Inventor/nodes/SoSceneTextureCubeMap.h>

       Inherits SoNode.

   Public Types
       enum Model { MODULATE = SoMultiTextureImageElement::MODULATE, DECAL = SoMultiTextureImageElement::DECAL,
           BLEND = SoMultiTextureImageElement::BLEND, REPLACE = SoMultiTextureImageElement::REPLACE }
       enum Wrap { REPEAT = SoMultiTextureImageElement::REPEAT, CLAMP = SoMultiTextureImageElement::CLAMP }
       enum TransparencyFunction { NONE, ALPHA_BLEND, ALPHA_TEST }

   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.
       SoSceneTextureCubeMap (void)
       virtual void doAction (SoAction *action)
       virtual void GLRender (SoGLRenderAction *action)
       virtual void callback (SoCallbackAction *action)
       virtual void rayPick (SoRayPickAction *action)

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

   Public Attributes
       SoSFVec2s size
       SoSFNode scene
       SoSFEnum wrapS
       SoSFEnum wrapT
       SoSFEnum wrapR
       SoSFEnum model
       SoSFColor backgroundColor
       SoSFEnum transparencyFunction
       SoSFColor blendColor

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoSceneTextureCubeMap ()
       virtual void notify (SoNotList *list)

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

   Additional Inherited Members

Detailed Description

       Renders a scene into a texture cube map.

       Since:
           Coin 2.5

Constructor & Destructor Documentation

   SoSceneTextureCubeMap::SoSceneTextureCubeMap (void)
       Constructor.

   SoSceneTextureCubeMap::~SoSceneTextureCubeMap () [protected],  [virtual]
       Destructor. Frees up internal resources used to store texture image data.

Member Function Documentation

   SoType SoSceneTextureCubeMap::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 * SoSceneTextureCubeMap::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 SoSceneTextureCubeMap::doAction (SoAction *action) [virtual]
       This function performs the typical operation of a node for any action.

       Reimplemented from SoNode.

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

   void SoSceneTextureCubeMap::notify (SoNotList *l) [protected],  [virtual]
       Notifies all auditors for this instance when changes are made.

       Reimplemented from SoNode.

Author

       Generated automatically by Doxygen for Coin from the source code.