SoGeoSeparator(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

💖 NAME 💖

SoGeoSeparator — this is the SoGeoSeparator(3) page bestie, and the class itself is the one that georeferences a scene graph. That's the whole vibe: you drop it in and your scene gets actual geo-reality. Slay. 🌍✨

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoGeoSeparator.h>

It inherits from SoSeparator. So like… everything a separator can do, this one already ate and left no crumbs. 🍽️

🎀 Public Member Functions 🎀

virtual SoType getTypeId (void) const — the type-id flex, virtual edition 💅
SoGeoSeparator (void) — the constructor, your main character entrance 🚪✨
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
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

⭐ 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=FALSE) const
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
SbUniqueId 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=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)
SbBool getIsBuiltIn (void) const
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 — hands you back TRUE if the type of this object is either of the same type as type, or inherited from type. ✅
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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🛠️✨
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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🛠️✨

🧚 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🛠️✨
static void initClasses (void)
static SbUniqueId 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🛠️✨
static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class. 🔎
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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🛠️✨
static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class. 🔎
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 🌈

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 (void)

🛡️ 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)
virtual SoNotRec createNotRec (void)
void setOperation (const SoNotRec::OperationType opType=SoNotRec::UNSPECIFIED, const SoNode *cc=NULL, const SoNode *pc=NULL, const int ci=-1)

🛡️ Protected Member Functions inherited from `SoNode` 🛡️

SoNode (void)
virtual ~SoNode ()

🛡️ Protected Member Functions inherited from `SoFieldContainer` 🛡️

SoFieldContainer (void)
virtual ~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 ✨

SoNode is literally handing down a whole enum, bestie, and it's giving "version history but make it hexadecimal":

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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

🫶 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 🌸

SbUniqueId uniqueId

🌸 Protected Attributes inherited from SoFieldContainer 🌸

SbBool isBuiltIn

🌸 Static Protected Attributes inherited from SoNode 🌸

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0

💖 Detailed Description 💖

The SoGeoSeparator class is used to georeference a scene graph. Like, it plants your whole scene graph on the actual planet. 🌍✨

FILE FORMAT/DEFAULTS:

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

This node specifies an absolute geographic coordinate system for the children. When rendering (or applying other actions), Coin will add a transformation which transforms the geometry into the SoGeoOrigin coordinate system. All objects will be rotated to make the local Z-axis point up from the ground (at the specified geo-location), the Y-axis will point towards the north pole, and the X-axis is found using the right hand rule. 🧭 manifesting correct orientation

See also SoGeoOrigin

Since Coin 2.5

🎀 Constructor & Destructor Documentation 🎀

`SoGeoSeparator::SoGeoSeparator (void )`

Constructor. ✨ It makes the thing. That's it, that's the whole vibe.

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

Destructor. 💀 It unmakes the thing. Protected, so don't come for it directly.

💅 Member Function Documentation 💅

`SoType SoGeoSeparator::getClassTypeId (void ) [static]`

This static method returns the SoType object associated with objects of this class. Class-wide ID check, no instance required. 💫

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. iykyk — it's the "who are you really" of the class hierarchy.