.TH "SoGLUpdateAreaElement" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoGLUpdateAreaElement \- .PP The \fBSoGLUpdateAreaElement\fP class is yet to be documented\&. .PP FIXME: write doc\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoElement\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual void \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual void \fBpush\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual void \fBpop\fP (\fBSoState\fP *state, const \fBSoElement\fP *prevTopElement)" .br .ti -1c .RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *element) const " .br .ti -1c .RI "virtual \fBSoElement\fP * \fBcopyMatchInfo\fP () const " .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static int \fBgetClassStackIndex\fP (void)" .br .ti -1c .RI "static void * \fBcreateInstance\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, const \fBSbVec2f\fP &\fBorigin\fP, const \fBSbVec2f\fP &\fBsize\fP)" .br .ti -1c .RI "static SbBool \fBget\fP (\fBSoState\fP *const state, \fBSbVec2f\fP &\fBorigin\fP, \fBSbVec2f\fP &\fBsize\fP)" .br .ti -1c .RI "static \fBSbVec2f\fP \fBgetDefaultOrigin\fP ()" .br .ti -1c .RI "static \fBSbVec2f\fP \fBgetDefaultSize\fP ()" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual \fB~SoGLUpdateAreaElement\fP ()" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBSbVec2f\fP \fBorigin\fP" .br .ti -1c .RI "\fBSbVec2f\fP \fBsize\fP" .br .in -1c .SS "Additional Inherited Members" .SH "Detailed Description" .PP The \fBSoGLUpdateAreaElement\fP class is yet to be documented\&. .PP FIXME: write doc\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoGLUpdateAreaElement::~SoGLUpdateAreaElement ()\fC [protected]\fP, \fC [virtual]\fP" The destructor\&. .SH "Member Function Documentation" .PP .SS "void * SoGLUpdateAreaElement::createInstance (void)\fC [static]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .SS "void SoGLUpdateAreaElement::initClass (void)\fC [static]\fP" This static method initializes static data for the \fBSoGLUpdateAreaElement\fP class\&. .SS "void SoGLUpdateAreaElement::init (\fBSoState\fP *state)\fC [virtual]\fP" This function initializes the element type in the given \fBSoState\fP\&. It is called for the first element of each enabled element type in \fBSoState\fP objects\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "void SoGLUpdateAreaElement::push (\fBSoState\fP *state)\fC [virtual]\fP" 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 \fBSoState::getElement()\fP or indirectly \fBSoElement::getElement()\fP, and the depth of the current element is less than the state depth\&. .PP Override this method if your element needs to copy data from the previous top of stack\&. The \fBpush()\fP method is called on the new element, and the previous element can be found using \fBSoElement::getNextInStack()\fP\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "void SoGLUpdateAreaElement::pop (\fBSoState\fP *state, const \fBSoElement\fP *prevTopElement)\fC [virtual]\fP" This method is callled when the state is popped, and the depth of the element is bigger than the current state depth\&. \fBpop()\fP is called on the new top of stack, and a pointer to the previous top of stack is passed in \fIprevTopElement\fP\&. .PP Override this method if you need to copy some state information from the previous top of stack\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "SbBool SoGLUpdateAreaElement::matches (const \fBSoElement\fP *element) const\fC [virtual]\fP" This function returns \fCTRUE\fP is the element matches another element (of the same class), with respect to cache validity\&. .PP If the application programmer's extension element has a \fBmatches()\fP function, it should also have a \fBcopyMatchInfo()\fP function\&. .PP Implements \fBSoElement\fP\&. .SS "\fBSoElement\fP * SoGLUpdateAreaElement::copyMatchInfo (void) const\fC [virtual]\fP" This function creates a copy of the element that contains enough information to enable the \fBmatches()\fP function to work\&. .PP Used to help with scenegraph traversal caching operations\&. .PP Implements \fBSoElement\fP\&. .SS "void SoGLUpdateAreaElement::set (\fBSoState\fP *conststate, const \fBSbVec2f\fP &origin, const \fBSbVec2f\fP &size)\fC [static]\fP" 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\&. \fIorigin\fP and \fIsize\fP is in normalized window coordinates\&. .SS "SbBool SoGLUpdateAreaElement::get (\fBSoState\fP *conststate, \fBSbVec2f\fP &origin, \fBSbVec2f\fP &size)\fC [static]\fP" Returns the current update area\&. .PP \fBSee also:\fP .RS 4 \fBset()\fP .RE .PP .SS "\fBSbVec2f\fP SoGLUpdateAreaElement::getDefaultOrigin (void)\fC [static]\fP" Returns the default update area origin, (0,0)\&. .SS "\fBSbVec2f\fP SoGLUpdateAreaElement::getDefaultSize (void)\fC [static]\fP" Returns the default update area size, (1,1)\&. .SH "Member Data Documentation" .PP .SS "SoGLUpdateAreaElement::origin\fC [protected]\fP" FIXME: write doc .SS "SoGLUpdateAreaElement::size\fC [protected]\fP" FIXME: write doc .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.