SoComputeBoundingBox(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 NAME 💖

SoComputeBoundingBox — the class that is used to calculate a bounding box. bestie that's literally its whole job and it eats 💅

🦋 SYNOPSIS 🦋

#include <Inventor/engines/SoComputeBoundingBox.h>

Inherits SoEngine.

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • virtual const SoFieldData * getFieldData (void) const
  • virtual const SoEngineOutputData * getOutputData (void) const
  • SoComputeBoundingBox (void)
  • void setViewportRegion (const SbViewportRegion &vpr)
  • const SbViewportRegion & getViewportRegion (void) const

🌸 Public Member Functions inherited from SoEngine 🌸

  • void evaluateWrapper (void)
  • virtual int getOutputs (SoEngineOutputList &l) const
  • SoEngineOutput * getOutput (const SbName &outputname) const
  • SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const
  • SbBool isNotifying (void) const
  • virtual void notify (SoNotList *nl)
  • SoEngine * copy (void) const
  • virtual SoFieldContainer * copyThroughConnection (void) const
  • SbBool shouldCopy (void) const
  • virtual void writeInstance (SoOutput *out)

🎀 Public Member Functions inherited from SoFieldContainer 🎀

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
  • SbBool set (const char *const fielddata)
  • void get (SbString &fielddata)
  • virtual int getFields (SoFieldList &l) const
  • virtual int getAllFields (SoFieldList &l) const
  • virtual SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (const SbName &name) const
  • SbBool getFieldName (const SoField *const field, SbName &name) const
  • SbBool enableNotify (const SbBool flag)
  • SbBool isNotifyEnabled (void) const
  • SbBool set (const char *fielddata, SoInput *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn (void) const
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

💜 Public Member Functions inherited from SoBase 💜

  • void ref (void) const
  • void unref (void) const
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const
  • void touch (void)
  • SbBool isOfType (SoType type) const
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • virtual void startNotify (void)
  • void addAuditor (void *const auditor, const SoNotRec::Type type)
  • void removeAuditor (void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void)
  • static void * createInstance (void)
  • static void initClass (void)

🌈 Static Public Member Functions inherited from SoEngine 🌈

  • static void initClass (void)
  • static void initClasses (void)
  • static SoType getClassTypeId (void)
  • static SoEngine * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoEngineList &el)

🫶 Static Public Member Functions inherited from SoFieldContainer 🫶

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void cleanupClass (void)
  • static void initCopyDict (void)
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
  • static void copyDone (void)

🧚 Static Public Member Functions inherited from SoBase 🧚

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

🔥 Public Attributes 🔥

  • SoSFNode node
  • SoSFPath path
  • SoEngineOutput min
  • SoEngineOutput max
  • SoEngineOutput boxCenter
  • SoEngineOutput objectCenter

🍓 Protected Member Functions 🍓

  • virtual ~SoComputeBoundingBox (void)

💀 Protected Member Functions inherited from SoEngine 💀

  • SoEngine (void)
  • virtual ~SoEngine (void)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void inputChanged (SoField *which)
  • void writeOutputTypes (SoOutput *out)

💀 Protected Member Functions inherited from SoFieldContainer 💀

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

💀 Protected Member Functions inherited from SoBase 💀

  • SoBase (void)
  • virtual ~SoBase ()
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const

🦋 Static Protected Member Functions 🦋

  • static const SoFieldData ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

🦋 Static Protected Member Functions inherited from SoEngine 🦋

  • static const SoFieldData ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

🦋 Static Protected Member Functions inherited from SoBase 🦋

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

✨ Additional Inherited Members ✨

🎀 Protected Types inherited from SoBase 🎀

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

🎀 Protected Attributes inherited from SoFieldContainer 🎀

  • SbBool isBuiltIn

🌸 Detailed Description 🌸

The SoComputeBoundingBox class is used to calculate a bounding box. no cap, that is the vibe. ✨

This engine is simply a wrapper around the SoGetBoundingBoxAction, for a convenient way of having automatic updating of some data in the scene graph which is dependent on the bounding box of some other part of the scene. like it's giving "I'll watch that corner of the graph for you, bestie" 🫶

🎀 Constructor & Destructor Documentation 🎀

SoComputeBoundingBox::SoComputeBoundingBox (void )

Default constructor. Sets up the internal SoGetBoundingBoxAction instance. it's born ready 💅

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

Destructor. Deallocate the SoGetBoundingBoxAction instance. it cleans up after itself, iconique 🌸

⭐ Member Function Documentation ⭐

SoType SoComputeBoundingBox::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. yes bestie, runtime type checking, it's giving main character energy 🔥

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. so like, if you're building your own class, you have to override this, periodt 💅

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

const SoFieldData * SoComputeBoundingBox::getFieldData (void ) const [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. (fr fr, could just be NULL on you) 🙈

Reimplemented from SoFieldContainer.

const SoEngineOutputData * SoComputeBoundingBox::getOutputData (void ) const [virtual]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. lowkey not your business bestie, move along 😭

Implements SoEngine.

void SoComputeBoundingBox::setViewportRegion (const SbViewportRegion & vpr)

Set viewport region for the SoGetBoundingBoxAction instance we're using for calculating bounding boxes.

The default setting is to use an SbViewportRegion with only default values. so if you don't touch it, it's just vibing on defaults ✨

const SbViewportRegion & SoComputeBoundingBox::getViewportRegion (void ) const

Returns viewport region used by the internal SoGetBoundingBoxAction instance.

👑 Member Data Documentation 👑

SoSFNode SoComputeBoundingBox::node

If this input field is set and SoComputeBoundingBox::path is NULL, the resultant bounding box will be the box encompassing the scene graph rooted at this node pointer. it's giving "everything under this node, boxed" 🎁

SoSFPath SoComputeBoundingBox::path

If this input field is not NULL, the bounding box values of the given path will be set on the outputs. 🦋

SoEngineOutput SoComputeBoundingBox::min

(SoSFVec3f) Corner coordinates of the bounding box.

SoEngineOutput SoComputeBoundingBox::max

(SoSFVec3f) Corner coordinates of the bounding box.

SoEngineOutput SoComputeBoundingBox::boxCenter

(SoSFVec3f) Geometric center point of the bounding box.

SoEngineOutput SoComputeBoundingBox::objectCenter

(SoSFVec3f) Object center point for the bounding box. See SoGetBoundingBoxAction::getCenter() for an explanation for how this can differ from the geometric center point of the bounding box. yeah they're not the same thing, don't @ me, go read that other page 👀

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. (not me writing my own autobiography, the robot did it 🫶)

okay that's the whole page bestie, you ate 💅✨

Coin — Version 3.1.3 — SoComputeBoundingBox(3) 🎀🦋🌸

📦 where this page comes from