trusty (3) SoGLUpdateAreaElement.3.gz

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 SoType getClassTypeId (void)
       static int getClassStackIndex (void)
       static void * createInstance (void)
       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

   Additional Inherited Members

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::createInstance (void) [static]
       This API member is considered internal to the library, as it is not likely to be of interest to the
       application programmer.

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

   void SoGLUpdateAreaElement::init (SoState *state) [virtual]
       This function initializes the element type in the given SoState. It is called for the first element of
       each enabled element type in SoState objects.

       Reimplemented from SoElement.

   void SoGLUpdateAreaElement::push (SoState *state) [virtual]
       This method is called every time a new element is required in one of the stacks. This happens when a
       writable element is requested, using SoState::getElement() or indirectly SoElement::getElement(), and the
       depth of the current element is less than the state depth.

       Override this method if your element needs to copy data from the previous top of stack. The push() method
       is called on the new element, and the previous element can be found using SoElement::getNextInStack().

       Reimplemented from SoElement.

   void SoGLUpdateAreaElement::pop (SoState *state, const SoElement *prevTopElement) [virtual]
       This method is callled when the state is popped, and the depth of the element is bigger than the current
       state depth. pop() is called on the new top of stack, and a pointer to the previous top of stack is
       passed in prevTopElement.

       Override this method if you need to copy some state information from the previous top of stack.

       Reimplemented from SoElement.

   SbBool SoGLUpdateAreaElement::matches (const SoElement *element) const [virtual]
       This function returns TRUE is the element matches another element (of the same class), with respect to
       cache validity.

       If the application programmer's extension element has a matches() function, it should also have a
       copyMatchInfo() function.

       Implements 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 *conststate, 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 *conststate, 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.