SoViewportRegionElement(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

✨ SoViewportRegionElement(3) ✨

okay bestie, gather round 💖 this one is from the Coin library — it's SoViewportRegionElement, and ngl, the docs are... a work in progress 🙈 like, the original literally says "yet to be documented." So we're gonna work with what we've got and keep every single crumb of it, no cap.

🌸 NAME 🌸

SoViewportRegionElement — the SoViewportRegionElement class is yet to be documented.

fr fr, that's what it says. The maintainers left a FIXME: write doc. and honestly? relatable.

🎀 SYNOPSIS 🎀

#include <Inventor/elements/SoViewportRegionElement.h>
  • Inherits SoElement.
  • Inherited by SoGLViewportRegionElement.

💅 Public Member Functions

  • virtual void init (SoState *state)
  • virtual SbBool matches (const SoElement *element) const — FIXME: write doc.
  • virtual SoElement * copyMatchInfo () const — FIXME: write doc.
  • virtual void print (FILE *file) const — FIXME: write doc.

🫶 Public Member Functions inherited from SoElement

  • const SoType getTypeId (void) const
  • int getStackIndex (void) const
  • virtual void push (SoState *state)
  • virtual void pop (SoState *state, const SoElement *prevTopElement)
  • void setDepth (const int depth)
  • int getDepth (void) const
  • virtual ~SoElement ()

⭐ 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 SbViewportRegion &viewportRegion) — FIXME: write doc.
  • static const SbViewportRegion & get (SoState *const state) — FIXME: write doc.

🧚 Static Public Member Functions inherited from SoElement

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void initElements (void)
  • static int getNumStackIndices (void)
  • static SoType getIdFromStackIndex (const int stackIndex)

🦋 Protected Member Functions

  • virtual ~SoViewportRegionElement ()
  • virtual void setElt (const SbViewportRegion &viewportRegion) — FIXME: write doc.

🌈 Protected Member Functions inherited from SoElement

  • SoElement (void)
  • void capture (SoState *const state) const
  • virtual void captureThis (SoState *state) const
  • void setTypeId (const SoType typeId)
  • void setStackIndex (const int index)
  • SoElement * getNextInStack (void) const
  • SoElement * getNextFree (void) const

👑 Protected Attributes

  • SbViewportRegion viewportRegion

💜 Protected Attributes inherited from SoElement

  • SoType typeId
  • int stackIndex
  • int depth

🍓 Additional Inherited Members

💖 Static Protected Member Functions inherited from SoElement

  • static SoElement * getElement (SoState *const state, const int stackIndex)
  • static const SoElement * getConstElement (SoState *const state, const int stackIndex)
  • static int createStackIndex (const SoType id)

🌸 Static Protected Attributes inherited from SoElement

  • static int classStackIndex
  • static SoTypeList * stackToType

🌟 Detailed Description 🌟

The SoViewportRegionElement class is yet to be documented.

FIXME: write doc.

not me reading this and going "same" 😭 the docs are giving "we'll finish it later" and later never came.

🎀 Constructor & Destructor Documentation 🎀

SoViewportRegionElement::~SoViewportRegionElement (void ) [protected], [virtual]

Destructor.

she's protected, she's virtual, she's the end of the line. iconic behavior 💅

✨ Member Function Documentation ✨

SoType SoViewportRegionElement::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class.

int SoViewportRegionElement::getClassStackIndex (void ) [static]

This static method returns the state stack index for the class.

void * SoViewportRegionElement::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.

Creates a new instance of the class type corresponding to the SoType object.

internal, bestie. you probably don't need to touch this one 🫶

void SoViewportRegionElement::initClass (void ) [static]

Initialize relevant common data for all instances, like the type system.

void SoViewportRegionElement::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.
  • Reimplemented in SoGLViewportRegionElement.

SbBool SoViewportRegionElement::matches (const SoElement * element) const [virtual]

FIXME: write doc.

Implements SoElement.

SoElement * SoViewportRegionElement::copyMatchInfo (void ) const [virtual]

FIXME: write doc.

Implements SoElement.

void SoViewportRegionElement::print (FILE * file) const [virtual]

FIXME: write doc.

Reimplemented from SoElement.

void SoViewportRegionElement::setElt (const SbViewportRegion & viewportRegion) [protected], [virtual]

FIXME: write doc.

Reimplemented in SoGLViewportRegionElement.

🌈 Member Data Documentation 🌈

SbViewportRegion SoViewportRegionElement::viewportRegion [protected]

FIXME: write doc.

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code.

not a human wrote this, it's literally a bot doing its best 😭 and we love that for it.

🌸 Sign-off 🌸

k that's the whole page, bestie — you made it to the bottom, so proud 🥹💖 this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and the man page you just read is SoViewportRegionElement(3). go forth and viewport-region responsibly, mwah 💅✨

📦 where this page comes from