SoGeoSeparator(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ SoGeoSeparator(3) ✨

okay bestie 💖 welcome to the SoGeoSeparator(3) page from the Library Functions Manual. this is part 1, and there is more coming, so don't you dare think we're done. it's giving georeference-a-scene-graph energy and we are gonna list every single function like it's a group chat roll call. no skips. periodt. 🫶

🌸 NAME 🌸

SoGeoSeparator — The SoGeoSeparator class is used to georeference a scene graph.

🎀 SYNOPSIS 🎀

#include <Inventor/nodes/SoGeoSeparator.h>

Inherits SoSeparator.

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • SoGeoSeparator (void)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

✨ Public Member Functions inherited from SoSeparator ✨

  • SoSeparator (void)
  • SoSeparator (const int nchildren)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void notify (SoNotList *nl)
  • virtual SbBool affectsState (void) const

🦋 Public Member Functions inherited from SoGroup 🦋

  • SoGroup (void)
  • SoGroup (int nchildren)
  • virtual void addChild (SoNode *node)
  • virtual void insertChild (SoNode *child, int newchildindex)
  • virtual SoNode * getChild (int index) const
  • virtual int findChild (const SoNode *node) const
  • virtual int getNumChildren (void) const
  • virtual void removeChild (int childindex)
  • virtual void removeChild (SoNode *child)
  • virtual void removeAllChildren (void)
  • virtual void replaceChild (int index, SoNode *newchild)
  • virtual void replaceChild (SoNode *oldchild, SoNode *newchild)
  • virtual void pick (SoPickAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual SoChildList * getChildren (void) const

🌈 Public Member Functions inherited from SoNode 🌈

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=0) const
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • virtual SoFieldContainer * copyThroughConnection (void) const

💜 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=0)
  • 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 *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • SbBool getIsBuiltIn (void) 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)
  • 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 initClass (void)

✨ Static Public Member Functions inherited from SoSeparator ✨

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void setNumRenderCaches (const int howmany)
  • static int getNumRenderCaches (void)

🎀 Static Public Member Functions inherited from SoGroup 🎀

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

💅 Static Public Member Functions inherited from SoNode 💅

  • static uint32_t getCompatibilityTypes (const SoType &nodetype)
  • static SoType getClassTypeId (void)
  • static SoNode * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoNodeList &l)
  • static void initClass (void)
  • static void initClasses (void)
  • static uint32_t getNextNodeId (void)
  • static int getActionMethodIndex (const SoType type)
  • static void getBoundingBoxS (SoAction *action, SoNode *node)
  • static void GLRenderS (SoAction *action, SoNode *node)
  • static void callbackS (SoAction *action, SoNode *node)
  • static void getMatrixS (SoAction *action, SoNode *node)
  • static void handleEventS (SoAction *action, SoNode *node)
  • static void pickS (SoAction *action, SoNode *node)
  • static void rayPickS (SoAction *action, SoNode *node)
  • static void searchS (SoAction *action, SoNode *node)
  • static void writeS (SoAction *action, SoNode *node)
  • static void audioRenderS (SoAction *action, SoNode *node)
  • static void getPrimitiveCountS (SoAction *action, SoNode *node)

🦋 Static Public Member Functions inherited from SoFieldContainer 🦋

  • static void initClass (void)
  • static SoType getClassTypeId (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 *in, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *in)

💖 Public Attributes 💖

  • SoSFVec3d geoCoords
  • SoMFString geoSystem

✨ Public Attributes inherited from SoSeparator ✨

  • SoSFEnum renderCaching
  • SoSFEnum boundingBoxCaching
  • SoSFEnum renderCulling
  • SoSFEnum pickCulling

🎀 Protected Member Functions 🎀

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoGeoSeparator ()

💅 Protected Member Functions inherited from SoSeparator 💅

  • virtual ~SoSeparator ()
  • virtual SbBool cullTest (SoState *state)
  • virtual SbBool cullTest (SoGLRenderAction *action, int &cullresults)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)

🦋 Protected Member Functions inherited from SoGroup 🦋

  • virtual ~SoGroup ()
  • virtual SbBool readChildren (SoInput *in)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)

🌈 Protected Member Functions inherited from SoNode 🌈

  • SoNode (void)
  • virtual ~SoNode ()

💜 Protected Member Functions inherited from SoFieldContainer 💜

  • SoFieldContainer (void)
  • ~SoFieldContainer ()

🌸 Protected Member Functions inherited from SoBase 🌸

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • 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 ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoSeparator ✨

  • static const SoFieldData ** getFieldDataPtr (void)

🎀 Static Protected Member Functions inherited from SoGroup 🎀

  • static const SoFieldData ** getFieldDataPtr (void)

💅 Static Protected Member Functions inherited from SoNode 💅

  • static const SoFieldData ** getFieldDataPtr (void)
  • static void setNextActionMethodIndex (int index)
  • static int getNextActionMethodIndex (void)
  • static void incNextActionMethodIndex (void)
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

🦋 Static Protected Member Functions inherited from SoBase 🦋

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

🌈 Additional Inherited Members 🌈

💖 Public Types inherited from SoSeparator 💖

  • enum CacheEnabled { OFF, ON, AUTO }

✨ Public Types inherited from SoNode ✨

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
           INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
           INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
           COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
           0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000
           }

🎀 Protected Types inherited from SoBase 🎀

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

💅 Protected Attributes inherited from SoGroup 💅

  • SoChildList * children

🦋 Protected Attributes inherited from SoNode 🦋

  • uint32_t uniqueId

💜 Protected Attributes inherited from SoFieldContainer 💜

  • SbBool isBuiltIn

🌸 Static Protected Attributes inherited from SoNode 🌸

  • static uint32_t nextUniqueId = 0
  • static int nextActionMethodIndex = 0

✨ Detailed Description ✨

okay so bestie, here's the tea: the SoGeoSeparator class is what you use to georeference a scene graph. like, you're telling Coin where on planet Earth your lil geometry actually lives. 🌍💅

FILE FORMAT/DEFAULTS:

GeoSeparator {
  geoSystem ["GD", "WE"]
  geoCoords ""
}

So this node is out here specifying an absolute geographic coordinate system for all its children, no cap. When it's rendering (or doing any of the other actions), Coin is gonna add a transformation that moves the geometry into the SoGeoOrigin coordinate system. And listen — all the objects get rotated so that the local Z axis points up from the ground (right at the specified geo-location), the Y axis points toward the north pole, and the X axis is figured out using the right hand rule. it's giving math girlie behavior and we love it. 🔥

See also

SoGeoOrigin

Since

Coin 2.5 ✨

🎀 Constructor & Destructor Documentation 🎀

SoGeoSeparator::SoGeoSeparator (void )

Constructor. that's it, that's the whole vibe. building one of these bad boys. 💖

References geoCoords, geoSystem, and SoGeoSeparator().

Referenced by getFieldData(), and SoGeoSeparator().

SoGeoSeparator::~SoGeoSeparator () [protected], [virtual]

Destructor. the lil goodbye. 👋 protected + virtual, so she's doing her thing properly for the class hierarchy.

🌈 Member Function Documentation 🌈

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

Returns the type identification of an object derived from a class inheriting SoBase. basically it's the run-time type checking + "downward" casting plug. 🔍

Usage example:

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

Now for the app devs who wanna extend the library with new nodes, engines, nodekits, draggers, whatever: this method needs to be overridden in all subclasses. bestie this is not optional, it's the law. 🫶 Usually you do this as part of setting up the full type system for your extension classes, and that's normally handled by using the pre-defined macros you get through, like, 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.

Wanna know more about writing Coin extensions? go check the class documentation of the toplevel superclasses for the various class groups. iykyk. 📚

Reimplemented from SoSeparator.

const SoFieldData * SoGeoSeparator::getFieldData (void ) const [protected], [virtual]

Hands you back a pointer to the class-wide field data storage object for this instance. And if there are no fields? it returns NULL. empty-handed, iconic, periodt. 💀

Reimplemented from SoSeparator.

References SoGeoSeparator().

void SoGeoSeparator::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction.

She just updates the state according to how the node behaves for the render action, so that you, the application programmer, can use the SoCallbackAction to extract info about the scene graph. giving tour guide energy. 🧚

Reimplemented from SoSeparator.

References SoSeparator::callback(), SoAction::getState(), SoState::pop(), and SoState::push().

void SoGeoSeparator::GLRenderBelowPath (SoGLRenderAction * action) [virtual]

so real talk: SGI Open Inventor v2.1 obsoleted support for SoGLRenderAction::addMethod().

Instead, GLRender() might get called directly, and to optimize traversal, the SoSeparator node calls GLRenderBelowPath whenever the path code is BELOW_PATH or NO_PATH (and the path code is guaranteed not to change in that case). To stay compatible with SGI's Inventor (and thereby also TGS'), they chose to follow their implementation in this respect. respect the elders fr fr. 🙏

Also important: SoSeparator::GLRenderBelowPath() does not traverse its children using SoChildList::traverse(), but calls GLRenderBelowPath() directly for all its children. no middleman.

Reimplemented from SoSeparator.

References SoAction::getState(), SoSeparator::GLRenderBelowPath(), SoState::pop(), and SoState::push().

void SoGeoSeparator::GLRenderInPath (SoGLRenderAction * action) [virtual]

Implements the SoAction::IN_PATH traversal method for the rendering action. she's got a specific route and she's walking it. 🚶‍♀️✨

Reimplemented from SoSeparator.

References SoAction::getState(), SoSeparator::GLRenderInPath(), SoState::pop(), and SoState::push().

void SoGeoSeparator::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction.

Calculates the bounding box and center coordinates for the node, and modifies the values of the action so it encompasses the bounding box for this node and shifts the scene's center point more toward the one for this node. very "let me just scooch the whole vibe over here" of her. 🎯

And heads up: nodes that influence how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoSeparator.

References SoSeparator::getBoundingBox(), SoAction::getState(), SoState::pop(), and SoState::push().

void SoGeoSeparator::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

Updates the action by accumulating with the transformation matrix of this node (if any). if there's no matrix, she simply doesn't. 🙈

Reimplemented from SoSeparator.

References SoGetMatrixAction::getInverse(), SoGetMatrixAction::getMatrix(), SoAction::getState(), and SbMatrix::inverse().

void SoGeoSeparator::rayPick (SoRayPickAction * action) [virtual]

Action method for SoRayPickAction.

Checks the ray specification of the action and tests for intersection with the data of the node. pew pew, ray goes in, does it hit the thing? we find out. 💥

And again: nodes that influence relevant state variables for how picking is done also override this method.

Reimplemented from SoSeparator.

References SoAction::getState(), SoState::pop(), SoState::push(), and SoSeparator::rayPick().

void SoGeoSeparator::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. tallying it all up like a girl with a spreadsheet. 📊💅

And yes, same deal: nodes that influence how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoSeparator.

References SoSeparator::getPrimitiveCount(), SoAction::getState(), SoState::pop(), and SoState::push().

🌸 Member Data Documentation 🌸

SoSFVec3d SoGeoSeparator::geoCoords

Used for specifying the geographic coordinates. 📍

See also

SoGeoOrigin::geoCoords

Referenced by SoGeoSeparator().

SoMFString SoGeoSeparator::geoSystem

Used to specify a spatial reference frame. the whole "where are we and by what rules" situation. 🗺️

See also

SoGeoOrigin::geoSystem

Referenced by SoGeoSeparator().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

aaand that's a wrap bestie!! 🎀✨ this whole thing is from Coin Version 2.5.0, and yeah it's literally called SoGeoSeparator(3) — the doxygen wrote it, i just made it slay. go georeference something iconic, you got this 💖🦋🌸

📦 where this page comes from