SoGeoOrigin(3)

💖 SoGeoOrigin 💖

okay bestie, welcome to the manual page for SoGeoOrigin, straight out of the Library Functions Manual. It's a SoGeoOrigin(3) situation and we're gonna get into it 💅

SoGeoOrigin — the class that lets you pin down one absolute geographic location, and then everything else's geometry gets referenced against that spot. Iconic, honestly. Like dropping a pin and saying "everybody orient yourselves to HERE." 📍✨

---

🌍 NAME 🌍

SoGeoOrigin — this class is used to specify an absolute geographic location that geometry gets referenced against. That's the whole vibe. One anchor point, and the rest of your scene is like "okay so relative to her." 🫶

---

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoGeoOrigin.h>

Lowkey important detail: it inherits SoNode. Family tree matters, bestie 🌳

👑 Public Member Functions 👑

🌸 SoGeoOrigin's own, no middleman 🌸

• virtual SoType getTypeId (void) const — hands you back the type id, virtual-style ✨
• SoGeoOrigin (void) — the constructor. the birth. the origin story (literally) 🎀
• virtual void doAction (SoAction *action) — does the action thing 💫
• virtual void callback (SoCallbackAction *action) — runs the callback action, no cap
• virtual void GLRender (SoGLRenderAction *action) — the render moment. main character energy 🔥
• virtual void getBoundingBox (SoGetBoundingBoxAction *action) — fetches the bounding box 📦
• virtual void getMatrix (SoGetMatrixAction *action) — grabs the matrix, matrixing away 🧚
• virtual void pick (SoPickAction *action) — pick action, as one does
• virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts the primitives, she's thorough 💅

💜 Public Member Functions inherited from SoNode

• void setOverride (const SbBool state) — sets the override state
• SbBool isOverride (void) const — is it overriding? a question only she can answer
• void setNodeType (const NodeType type) — sets the node type
• NodeType getNodeType (void) const — gets the node type
• virtual SoNode * copy (SbBool copyconnections=FALSE) const — copies, and the connections copy flag defaults to FALSE btw
• virtual SbBool affectsState (void) const — does it affect state? inquiring minds
• virtual void GLRenderBelowPath (SoGLRenderAction *action) — renders below the path 🌈
• virtual void GLRenderInPath (SoGLRenderAction *action) — renders in the path
• virtual void GLRenderOffPath (SoGLRenderAction *action) — renders off the path (she contains multitudes)
• virtual void handleEvent (SoHandleEventAction *action) — handles the event
• virtual void rayPick (SoRayPickAction *action) — ray picks 🔦
• virtual void search (SoSearchAction *action) — searches
• virtual void write (SoWriteAction *action) — writes
• virtual void audioRender (SoAudioRenderAction *action) — audio render, sound on 🔊
• virtual void grabEventsSetup (void) — sets up the event grabbing
• virtual void grabEventsCleanup (void) — cleans up the event grabbing
• virtual void startNotify (void) — starts the notify
• virtual void notify (SoNotList *l) — notifies, with the list l
• uint32_t getNodeId (void) const — gets the node id
• virtual SoChildList * getChildren (void) const — gets the children 🧸
• virtual void writeInstance (SoOutput *out) — writes the instance out
• virtual SoNode * addToCopyDict (void) const — adds herself to the copy dict, as she should
• virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copies contents from a field container
• virtual SoFieldContainer * copyThroughConnection (void) const — copies through the connection

🦋 Public Member Functions inherited from SoFieldContainer

• void setToDefaults (void) — back to defaults, reset era
• SbBool hasDefaultValues (void) const — does it have default values?
• SbBool fieldsAreEqual (const SoFieldContainer *container) const — are the fields equal to this container's? comparing girlies 💅
• void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copies field values; connections flag defaults to FALSE
• SbBool set (const char *const fielddata) — sets from field data
• void get (SbString &fielddata) — gets field data into a string
• virtual int getFields (SoFieldList &l) const — gets the fields into list l
• virtual int getAllFields (SoFieldList &l) const — gets all the fields, no crumbs left
• virtual SoField * getField (const SbName &name) const — gets one field by name
• virtual SoField * getEventIn (const SbName &name) const — gets an event in by name
• virtual SoField * getEventOut (const SbName &name) const — gets an event out by name
• SbBool getFieldName (const SoField *const field, SbName &name) const — gets the name of a given field
• SbBool enableNotify (const SbBool flag) — toggles notify with a flag
• SbBool isNotifyEnabled (void) const — is notify enabled?
• SbBool set (const char *fielddata, SoInput *input) — sets from field data, with an SoInput
• void get (SbString &fielddata, SoOutput *out) — gets field data out, with an SoOutput
• virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validates a new field value
• virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — adds a write reference; isfromfield defaults to FALSE
• SbBool getIsBuiltIn (void) const — is it built in?
• virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — reports fields memory size in managed and unmanaged buckets
• void setUserData (void *userdata) const — sets user data
• void * getUserData (void) const — gets user data back

🎀 Public Member Functions inherited from SoBase

• void ref (void) const — refs her up
• void unref (void) const — unrefs her
• void unrefNoDelete (void) const — unref but no delete, sneaky
• int32_t getRefCount (void) const — gets the ref count
• void touch (void) — touch. she felt that.
• SbBool isOfType (SoType type) const — is she of this type?
• virtual SbName getName (void) const — gets the name
• virtual void setName (const SbName &newname) — sets a new name
• void addAuditor (void *const auditor, const SoNotRec::Type type) — adds an auditor
• void removeAuditor (void *const auditor, const SoNotRec::Type type) — removes an auditor
• const SoAuditorList & getAuditors (void) const — gets the auditor list
• SbBool shouldWrite (void) — should she write? only she knows
• void assertAlive (void) const — asserts she's alive. dramatic but valid 💀

⭐ Static Public Member Functions ⭐

🌟 Her own 🌟

• static SoType getClassTypeId (void) — the class type id, statically
• static void initClass (void) — initializes the class

🌟 Inherited from SoNode 🌟

• static uint32_t getCompatibilityTypes (const SoType &nodetype) — gets compatibility types for a node type
• static SoType getClassTypeId (void) — class type id
• static SoNode * getByName (const SbName &name) — gets a node by name
• static int getByName (const SbName &name, SoNodeList &l) — gets by name, into a node list
• static void initClass (void) — init the class
• static void initClasses (void) — init ALL the classes, plural, she's ambitious
• static uint32_t getNextNodeId (void) — gets the next node id
• static int getActionMethodIndex (const SoType type) — gets the action method index
• static void getBoundingBoxS (SoAction *action, SoNode *node) — the static bounding box getter
• static void GLRenderS (SoAction *action, SoNode *node) — the static GL render
• static void callbackS (SoAction *action, SoNode *node) — the static callback
• static void getMatrixS (SoAction *action, SoNode *node) — the static matrix getter
• static void handleEventS (SoAction *action, SoNode *node) — the static event handler
• static void pickS (SoAction *action, SoNode *node) — the static pick
• static void rayPickS (SoAction *action, SoNode *node) — the static ray pick
• static void searchS (SoAction *action, SoNode *node) — the static search
• static void writeS (SoAction *action, SoNode *node) — the static write
• static void audioRenderS (SoAction *action, SoNode *node) — the static audio render
• static void getPrimitiveCountS (SoAction *action, SoNode *node) — the static primitive counter

🌟 Inherited from SoFieldContainer 🌟

• static void initClass (void) — init
• static SoType getClassTypeId (void) — class type id
• static void cleanupClass (void) — cleanup, the class gets a skincare routine 🧖
• static void initCopyDict (void) — init the copy dict
• static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — adds a copy, orig to copy
• static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks a copy
• static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds a copy, with the connections flag
• static void copyDone (void) — copy done, periodt

🌟 Inherited from SoBase 🌟

• static void initClass (void) — init
• static SoType getClassTypeId (void) — class type id
• static void addName (SoBase *const base, const char *const name) — adds a name to a base
• static void removeName (SoBase *const base, const char *const name) — removes a name from a base
• static void incrementCurrentWriteCounter (void) — bumps the current write counter
• static void decrementCurrentWriteCounter (void) — lowers the current write counter
• static SoBase * getNamedBase (const SbName &name, SoType type) — gets a named base by name and type
• static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — gets named bases into a base list
• static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads, with the expected type
• static void setInstancePrefix (const SbString &c) — sets the instance prefix
• static void setTraceRefs (SbBool trace) — sets trace refs
• static SbBool getTraceRefs (void) — gets trace refs
• static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connects a route, from node/field to node/field, so many params, she's doing the most
• static SbBool readRoute (SoInput *input) — reads a route

💎 Public Attributes 💎

• SoSFVec3d geoCoords — the geo coords, in a single-field SoSFVec3d
• SoMFString geoSystem — the geo system, a multi-field SoMFString (multi, because options, bestie)

🔒 Protected Member Functions 🔒

💗 Her own 💗

• virtual const SoFieldData * getFieldData (void) const — gets the field data
• virtual ~SoGeoOrigin () — the destructor, protected, don't touch 🚫

💗 Inherited from SoNode 💗

• SoNode (void) — the SoNode constructor
• virtual ~SoNode () — the SoNode destructor
• virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance with flags

💗 Inherited from SoFieldContainer 💗

• SoFieldContainer (void) — constructor
• virtual ~SoFieldContainer () — destructor

💗 Inherited from SoBase 💗

• SoBase (void) — constructor
• virtual ~SoBase () — destructor
• virtual void destroy (void) — destroy her
• SbBool hasMultipleWriteRefs (void) const — does she have multiple write refs?
• SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header with group and engine flags
• void writeFooter (SoOutput *out) const — writes the footer
• virtual const char * getFileFormatName (void) const — gets the file format name

🫧 Static Protected Member Functions 🫧

🌺 Her own 🌺

• static const SoFieldData ** getFieldDataPtr (void) — gets the field data pointer

🌺 Inherited from SoNode 🌺

• static const SoFieldData ** getFieldDataPtr (void) — field data pointer
• static void setNextActionMethodIndex (int index) — sets the next action method index
• static int getNextActionMethodIndex (void) — gets the next action method index
• static void incNextActionMethodIndex (void) — increments the next action method index
• static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types with a bitmask

🌺 Inherited from SoBase 🌺

• static uint32_t getCurrentWriteCounter (void) — gets the current write counter
• static void staticDataLock (void) — locks the static data 🔐
• static void staticDataUnlock (void) — unlocks the static data 🔓

---

🌈 Additional Inherited Members 🌈

🎠 Public Types inherited from SoNode 🎠

the enum, in all her glory, values EXACTLY as written:

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 }

🎠 Protected Types inherited from SoBase 🎠

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

🎀 Protected Attributes inherited from SoNode 🎀

• uint32_t uniqueId — her unique id, obviously unique, obviously iconic

🎀 Protected Attributes inherited from SoFieldContainer 🎀

• SbBool isBuiltIn — is she built in or not

🎀 Static Protected Attributes inherited from SoNode 🎀

• static uint32_t nextUniqueId = 1 — starts at 1, don't forget
• static int nextActionMethodIndex = 0 — starts at 0

---

…and bestie, we are SO not done. Part 2 is pulling up 💖🧚✨

🗺️ Detailed Description 🗺️

Okay so SoGeoOrigin is the class that lets you drop an absolute geographic location into your scene, and everything else gets referenced against it. It's giving "pin in the map" energy. 📍

📁 FILE FORMAT/DEFAULTS 📁

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

Now, real talk: a huge common problem when dealing with geographic data is that floating point precision gets absolutely wrecked. UTM coordinates are often in the 10^5 a 10^6 magnitude, and that leaves very little precision for details at that position. It's giving squished. 😭

That's exactly why the SoGeo nodes exist — you can keep your data in its original system but still get good floating point precision when rendering. Iconic, honestly. ✨

Coin needs a local Cartesian coordinate system when rendering. When a SoGeoOrigin node is used, Coin will create a coordinate system at the SoGeoOrigin position, and all geometry (and the camera) in the scene graph will be projected into that coordinate system. No cap.

The coordinate system will always have the Z axis point up from the ground. The Y axis will point towards the north pole, and the X-axis is found using the right hand rule. Slay.

A scene graph should only contain one GeoOrigin node, and all geometry in the scene graph will, as stated earlier, be rendered relative to this position. This means that the precision will be best if the GeoOrigin position is as close to actual camera position as possible. If you move around on a large area, it might therefore be a good idea to actually move the GeoOrigin position instead of the camera. Lowkey genius. 🧠

To place geometry in the scene graph, you can either use an SoGeoSeparator node or an SoGeoCoordinate node. When using a GeoSeparator node, all geometry inside that separator will be rendered relative to its geo-system position and orientation, and you then use regular shapes and regular SoCoordinate3 nodes to specify data (the points in an SoCoordinate3 must be adjusted to be relative to the GeoSeparator position).

The SoGeoCoordinate node on the other hand can contain double precision geo-coordinates, and that node will internally recalculate the double precision array to a single precision array which is relative to the SoGeoOrgin node (spelled exactly like that, bestie).

One note regarding UTM projections: Since it's quite common to assume a flat earth when working with UTM data, it's possible to supply a "FLAT" keyword for UTM coordinate systems:

GeoOrigin {
  geoSystem [ "UTM", "Z17", "FLAT" ]
  geoCoords  846889 4313850 0
}

Example scene graph, bestie:

GeoOrigin { geoSystem "GD" geoCoords 40.77 -73.97 0 }

GeoSeparator {
  # New York, NY
  geoSystem  "GD"
  geoCoords 40.67 -73.94 0

  BaseColor { rgb 0 1 0 }
  Cube { width 25000 height 25000 depth 25000 }
  Translation { translation 0 0 30000 }
  Text2 { string "New York" }
}

GeoSeparator {
  # Los Angeles, CA
  geoSystem "GD"
  geoCoords 34.11 -118.4 0

  BaseColor { rgb 1 0 0 }
  Cube { width 25000 height 25000 depth 25000 }
  Translation { translation 0 0 30000 }
  Text2 { string "Los Angeles" }
}

GeoSeparator {
  # Washington, DC
  geoSystem [ "UTM", "Z17" ]
  geoCoords  846889 4313850 0

  BaseColor { rgb 0 1 1 }
  Cube { width 25000 height 25000 depth 25000 }

  Translation { translation 0 0 30000 }
  Text2 { string "Washington" }
}

# add a small geogrid
GeoCoordinate {
  geoSystem "GD"
  point [
  32 -120 0,
  32 -110 0,
  32 -100 0,
  32 -90 0,
  32 -80 0,
  32 -70 0,

  34 -120 0,
  34 -110 0,
  34 -100 0,
  34 -90 0,
  34 -80 0,
  34 -70 0,

  36 -120 0,
  36 -110 0,
  36 -100 0,
  36 -90 0,
  36 -80 0,
  36 -70 0,

  38 -120 0,
  38 -110 0,
  38 -100 0,
  38 -90 0,
  38 -80 0,
  38 -70 0,

  40 -120 0,
  40 -110 0,
  40 -100 0,
  40 -90 0,
  40 -80 0,
  40 -70 0

  42 -120 0,
  42 -110 0,
  42 -100 0,
  42 -90 0,
  42 -80 0,
  42 -70 0
  ]
}

DrawStyle { style LINES }
BaseColor {}
ShapeHints { vertexOrdering COUNTERCLOCKWISE }
QuadMesh { verticesPerRow 6 verticesPerColumn 6 }

Since 🕰️

Coin 2.5

---

🛠️ Constructor & Destructor Documentation 🛠️

SoGeoOrigin::SoGeoOrigin (void )

Constructor. That's it. It constructs. 💅

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

Destructor. It destructs. Protected and virtual, iykyk.

---

📚 Member Function Documentation 📚

SoType SoGeoOrigin::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.

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.

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

Implements SoBase.

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

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoFieldContainer.

void SoGeoOrigin::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

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

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoNode.

void SoGeoOrigin::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

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

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

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

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoNode.

void SoGeoOrigin::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

void SoGeoOrigin::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.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

---

📦 Member Data Documentation 📦

SoSFVec3d SoGeoOrigin::geoCoords

Used for specifying the geographic coordinates. For the GD system this should be <latitude> <longitude> <elevation>. For UTM it is <easting> <northing> <elevation>, and for GC it is simply <x> <y> <z>.

SoMFString SoGeoOrigin::geoSystem

Used to specify a spatial reference frame. Coin currently supports three different systems. Support for more systems might be added in the future.

• "GD" — The Geodetic system (latitude/longitude).
• "UTM" — Universal Transverse Mercator coordinate system. The second string should be the zone, encoded as "Z<n>".
• "GC" — Earth-fixed Geocentric with respect to the WGS84 ellipsoid.

The "GD" and "UTM" systems can, for future support, have an ellipsoid specification. The default is "WE" which is the WGS84 ellipsoid, the only ellipsoid currently supported in Coin.

---

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code.

---

That's the whole vibe, bestie. This page was generated automatically by Doxygen for Coin from the source code, and it's from Coin Version 3.1.3, manual page SoGeoOrigin(3). Stay precise. 💖✨