Open Inventor Release 2023.2.2
 
Loading...
Searching...
No Matches
SoUpdateAreaElement Class Reference

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

#include <Inventor/elements/SoUpdateAreaElement.h>

+ Inheritance diagram for SoUpdateAreaElement:

Public Member Functions

virtual void push (SoState *state)
 Overrides push() method to copy values from next instance in the stack.
 
virtual void print (FILE *fp) const
 Prints element (for debugging).
 
- Public Member Functions inherited from SoElement
virtual void pop (SoState *state, const SoElement *prevTopElement)
 Pops element.
 
virtual SoType getTypeId () const
 Returns type identifier for element instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static int getClassStackIndex ()
 Returns the stack id for this element.
 
static void set (SoState *state, const SbVec2f &origin, const SbVec2f &size)
 Sets the current update area in the state.
 
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.
 
static SbVec2f getDefaultSize ()
 Returns the default update area size.
 
- Static Public Member Functions inherited from SoElement
static SoType getClassTypeId ()
 Returns type identifier for SoElement class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Detailed Description

Stores the rectangular area within the current viewport region that needs to be updated when rendering.

This element stores the rectangular area within the current viewport region that needs to be updated when rendering. 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 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.

SEE ALSO

PoBaseView, SoGLRenderAction

Definition at line 51 of file SoUpdateAreaElement.h.

Member Function Documentation

◆ get()

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

Returns current update area from the state.

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

◆ getClassStackIndex()

static int SoUpdateAreaElement::getClassStackIndex ( )
static

Returns the stack id for this element.


◆ getClassTypeId()

static SoType SoUpdateAreaElement::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getDefaultOrigin()

static SbVec2f SoUpdateAreaElement::getDefaultOrigin ( )
inlinestatic

Returns the default update area origin.

Definition at line 71 of file SoUpdateAreaElement.h.

◆ getDefaultSize()

static SbVec2f SoUpdateAreaElement::getDefaultSize ( )
inlinestatic

Returns the default update area size.

Definition at line 76 of file SoUpdateAreaElement.h.

◆ print()

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

Prints element (for debugging).

Reimplemented from SoElement.

◆ push()

virtual void SoUpdateAreaElement::push ( SoState state)
virtual

Overrides push() method to copy values from next instance in the stack.

Reimplemented from SoElement.

◆ set()

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

Sets the current update area in the state.


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