Man Linux: Main Page and Category List

NAME

       SoGLUpdateAreaElement -

       The SoGLUpdateAreaElement class is yet to be documented.

       FIXME: write doc.

SYNOPSIS

       #include <Inventor/elements/SoGLUpdateAreaElement.h>

       Inherits SoElement.

   Public Member Functions
       virtual void init (SoState *state)
       virtual void push (SoState *state)
       virtual void pop (SoState *state, const SoElement *prevTopElement)
       virtual SbBool matches (const SoElement *element) const
       virtual SoElement * copyMatchInfo () const

   Static Public Member Functions
       static void initClass (void)
       static void set (SoState *const state, const SbVec2f &origin, const
           SbVec2f &size)
       static SbBool get (SoState *const state, SbVec2f &origin, SbVec2f
           &size)
       static SbVec2f getDefaultOrigin ()
       static SbVec2f getDefaultSize ()

   Protected Member Functions
       virtual ~SoGLUpdateAreaElement ()

   Protected Attributes
       SbVec2f origin
       SbVec2f size

Detailed Description

       The SoGLUpdateAreaElement class is yet to be documented.

       FIXME: write doc.

Constructor & Destructor Documentation

   SoGLUpdateAreaElement::~SoGLUpdateAreaElement () [protected, virtual] The
       destructor.

Member Function Documentation

   void SoGLUpdateAreaElement::initClass (void) [static] This static method
       initializes static data for the SoGLUpdateAreaElement class.
       Reimplemented from SoElement.

   SoElement * SoGLUpdateAreaElement::copyMatchInfo (void) const [virtual]
       This function creates a copy of the element that contains enough
       information to enable the matches() function to work.
       Used to help with scenegraph traversal caching operations.

       Implements SoElement.

   void SoGLUpdateAreaElement::set (SoState *const  state, const SbVec2f &
       origin, const SbVec2f & size) [static] Sets the update area. This can,
       for instance, be used when rendering in the front buffer, to only
       render parts of the scene during a window expose event. origin and size
       is in normalized window coordinates.
   SbBool SoGLUpdateAreaElement::get (SoState *const  state, SbVec2f & origin,
       SbVec2f & size) [static] Returns the current update area.
       See also:
           set()

   SbVec2f SoGLUpdateAreaElement::getDefaultOrigin (void) [static] Returns the
       default update area origin, (0,0).
   SbVec2f SoGLUpdateAreaElement::getDefaultSize (void) [static] Returns the
       default update area size, (1,1).

Member Data Documentation

   SoGLUpdateAreaElement::origin [protected] FIXME: write doc
   SoGLUpdateAreaElement::size [protected] FIXME: write doc

Author

       Generated automatically by Doxygen for Coin from the source code.