Open Inventor Reference
SoGLUpdateAreaElement Class Reference

Element that stores the rectangular area within the current viewport region that needs to be updated when rendering. More...

#include <Inventor/elements/SoGLUpdateAreaElement.h>

Inheritance diagram for SoGLUpdateAreaElement:
SoElement

Public Member Functions

virtual void init (SoState *state)
 Initializes element.
 
virtual void push (SoState *state)
 Override push() and pop() methods to keep GL up to date.
 
virtual void pop (SoState *state, const SoElement *prevTopElement)
 
virtual bool matches (const SoElement *elt) const
 Returns TRUE if the update areas match in both elements.
 
virtual SoElementcopyMatchInfo () const
 Create and return a copy of this element.
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
- Public Member Functions inherited from SoElement
virtual void init (SoState *state)
 Initializes element.
 
virtual void push (SoState *state)
 Pushes/pops element.
 
virtual void pop (SoState *state, const SoElement *prevTopElement)
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
virtual bool matches (const SoElement *elt) const =0
 Returns TRUE if the element matches another element (of the same class, presumably) with respect to cache validity.
 
virtual SoElementcopyMatchInfo () const =0
 Create a copy that we can put in a cache used list and call matches() on later.
 
SoType getTypeId () const
 Returns type identifier for element instance.
 
int getStackIndex () const
 Returns the stack index for an element instance.
 
void setDepth (int dpth)
 Sets stuff in an element instance.
 
void setNext (SoElement *nxt)
 
void setNextInStack (SoElement *nxt)
 
void setNextFree (SoElement *nxt)
 
int getDepth () const
 Returns stuff from element instance.
 
SoElementgetNext () const
 
virtual ~SoElement ()
 Destructor.
 

Static Public Member Functions

static void set (SoState *state, const SbVec2f &origin, const SbVec2f &size)
 Sets the current update area in the state. May have GL side effects.
 
static bool get (SoState *state, SbVec2f &origin, SbVec2f &size)
 Returns current update area from the state.
 
static SbVec2f getDefaultOrigin ()
 Returns the default update area origin and size.
 
static SbVec2f getDefaultSize ()
 
static void initClass ()
 Initializes the SoGLUpdateAreaElement class.
 
- Static Public Member Functions inherited from SoElement
static SoType getClassTypeId ()
 Returns type identifier for SoElement class.
 
static void initElements ()
 Initialize ALL Inventor element classes.
 
static void initClass ()
 Initializes the SoElement class.
 
static int getNumStackIndices ()
 Returns the number of stack indices allocated.
 
static SoType getIdFromStackIndex (int stackIndex)
 Returns the id for the element with the given stack index.
 

Protected Member Functions

virtual ~SoGLUpdateAreaElement ()
 
- Protected Member Functions inherited from SoElement
 SoElement ()
 Constructor; use typeId.createInstance to create elements.
 
void capture (SoState *state) const
 Does whatever is necessary in state to capture this element for caching purposes.
 
virtual void captureThis (SoState *state) const
 Really captures this element, once it has been determined that a cache is open to capture it.
 
void setTypeId (SoType id)
 Sets typeId in instance.
 
void setStackIndex (int index)
 Sets stackIndex in instance.
 
SoElementgetNextInStack () const
 Returns next instance in specific element stack.
 
SoElementgetNextFree () const
 Returns next free element in a specific element stack.
 

Protected Attributes

SbVec2f origin
 
SbVec2f size
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *state, int stackIndex)
 Returns an instance of an element from the stack with the given index in the given state.
 
static const SoElementgetConstElement (SoState *state, int stackIndex)
 Returns a read-only pointer to the top instance in the given element stack.
 
static int createStackIndex (SoType id)
 Creates and returns a new stack index.
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 Stack index for SoElement class.
 

Detailed Description

It can be used for partial rendering updates when applications know that only a portion of the objects need to be rerendered. Cameras can use the info in this element to set up a view volume against which culling can be performed. This element also sets up the GL scissor box to limit drawing.

The update area is specified in normalized viewport coordinates, where (0,0) is the lower left corner of the viewport and (1,1) is the upper right corner. The area is given as an origin and a size.

Definition at line 80 of file SoGLUpdateAreaElement.h.

Constructor & Destructor Documentation

◆ ~SoGLUpdateAreaElement()

virtual SoGLUpdateAreaElement::~SoGLUpdateAreaElement ( )
protectedvirtual

Member Function Documentation

◆ copyMatchInfo()

virtual SoElement * SoGLUpdateAreaElement::copyMatchInfo ( ) const
virtual

Implements SoElement.

◆ get()

static bool SoGLUpdateAreaElement::get ( SoState state,
SbVec2f origin,
SbVec2f size 
)
static

Returns TRUE if the update area is the default, namely, the entire viewport.

◆ getDefaultOrigin()

static SbVec2f SoGLUpdateAreaElement::getDefaultOrigin ( )
inlinestatic

Definition at line 97 of file SoGLUpdateAreaElement.h.

◆ getDefaultSize()

static SbVec2f SoGLUpdateAreaElement::getDefaultSize ( )
inlinestatic

Definition at line 98 of file SoGLUpdateAreaElement.h.

◆ init()

virtual void SoGLUpdateAreaElement::init ( SoState state)
virtual

Reimplemented from SoElement.

◆ initClass()

static void SoGLUpdateAreaElement::initClass ( )
static

◆ matches()

virtual bool SoGLUpdateAreaElement::matches ( const SoElement elt) const
virtual

Implements SoElement.

◆ pop()

virtual void SoGLUpdateAreaElement::pop ( SoState state,
const SoElement prevTopElement 
)
virtual

Reimplemented from SoElement.

◆ print()

virtual void SoGLUpdateAreaElement::print ( FILE *  fp) const
virtual

Reimplemented from SoElement.

◆ push()

virtual void SoGLUpdateAreaElement::push ( SoState state)
virtual

Reimplemented from SoElement.

◆ set()

static void SoGLUpdateAreaElement::set ( SoState state,
const SbVec2f origin,
const SbVec2f size 
)
static

Member Data Documentation

◆ origin

SbVec2f SoGLUpdateAreaElement::origin
protected

Definition at line 118 of file SoGLUpdateAreaElement.h.

◆ size

SbVec2f SoGLUpdateAreaElement::size
protected

Definition at line 118 of file SoGLUpdateAreaElement.h.


The documentation for this class was generated from the following file: