SoLocateHighlight(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoLocateHighlight(3) — Library Functions Manual 💖

🌸 NAME 🌸

SoLocateHighlight is the class that highlights geometry under the cursor. Like, the geometry literally under your cursor gets the spotlight. It's giving main character energy for your 3D scene. No cap. ✨

✨ SYNOPSIS ✨

Okay bestie, to use it, include this header:

#include <Inventor/nodes/SoLocateHighlight.h>

It inherits SoSeparator. Lowkey a whole family tree.

It's inherited by SoWWWAnchor. The legacy continues, periodt.

👑 Public Types 👑

  • enum Modes { AUTO, ON, OFF } — the modes, bestie: AUTO, ON, OFF. Pick your vibe.
  • enum Styles { EMISSIVE, EMISSIVE_DIFFUSE } — the styles: EMISSIVE, EMISSIVE_DIFFUSE. It's giving options.

💫 Public Types inherited from SoSeparator 💫

  • enum CacheEnabled { OFF, ON, AUTO } — caching states: 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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

🛠️ Public Member Functions 🛠️

  • virtual SoType getTypeId (void) const — grab the type ID.
  • SoLocateHighlight (void) — constructor, no args.
  • virtual void handleEvent (SoHandleEventAction *action) — handle that event.
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — GL render below path.
  • virtual void GLRenderInPath (SoGLRenderAction *action) — GL render in path.

🧚 Public Member Functions inherited from SoSeparator 🧚

  • SoSeparator (void) — constructor.
  • SoSeparator (const int nchildren) — constructor with nchildren.
  • virtual void doAction (SoAction *action) — do the action.
  • virtual void GLRender (SoGLRenderAction *action) — GL render.
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — GL render off path.
  • virtual void callback (SoCallbackAction *action) — callback.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — get bounding box.
  • virtual void getMatrix (SoGetMatrixAction *action) — get matrix.
  • virtual void rayPick (SoRayPickAction *action) — ray pick.
  • virtual void search (SoSearchAction *action) — search.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — get primitive count.
  • virtual void audioRender (SoAudioRenderAction *action) — audio render.
  • virtual void notify (SoNotList *nl) — notify.
  • virtual SbBool affectsState (void) const — does it affect state?

🧚 Public Member Functions inherited from SoGroup 🧚

  • SoGroup (void) — constructor.
  • SoGroup (int nchildren) — constructor with nchildren.
  • virtual void addChild (SoNode *node) — add child.
  • virtual void insertChild (SoNode *child, int newchildindex) — insert child at index.
  • virtual SoNode * getChild (int index) const — get child.
  • virtual int findChild (const SoNode *node) const — find child.
  • virtual int getNumChildren (void) const — get number of children.
  • virtual void removeChild (int childindex) — remove child by index.
  • virtual void removeChild (SoNode *child) — remove child.
  • virtual void removeAllChildren (void) — remove all children.
  • virtual void replaceChild (int index, SoNode *newchild) — replace child at index.
  • virtual void replaceChild (SoNode *oldchild, SoNode *newchild) — replace child.
  • virtual void pick (SoPickAction *action) — pick.
  • virtual void write (SoWriteAction *action) — write.
  • virtual SoChildList * getChildren (void) const — get children list.

🧚 Public Member Functions inherited from SoNode 🧚

  • void setOverride (const SbBool state) — set override.
  • SbBool isOverride (void) const — is override?
  • void setNodeType (const NodeType type) — set node type.
  • NodeType getNodeType (void) const — get node type.
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — copy.
  • virtual void grabEventsSetup (void) — grab events setup.
  • virtual void grabEventsCleanup (void) — grab events cleanup.
  • virtual void startNotify (void) — start notify.
  • uint32_t getNodeId (void) const — get node ID.
  • virtual void writeInstance (SoOutput *out) — write instance.
  • virtual SoNode * addToCopyDict (void) const — add to copy dict.
  • virtual SoFieldContainer * copyThroughConnection (void) const — copy through connection.

🧚 Public Member Functions inherited from SoFieldContainer 🧚

  • void setToDefaults (void) — set to defaults.
  • SbBool hasDefaultValues (void) const — has default values?
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — fields are equal?
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copy field values.
  • SbBool set (const char *const fielddata) — set from field data.
  • void get (SbString &fielddata) — get field data.
  • virtual int getFields (SoFieldList &l) const — get fields.
  • virtual int getAllFields (SoFieldList &l) const — get all fields.
  • virtual SoField * getField (const SbName &name) const — get field by name.
  • virtual SoField * getEventIn (const SbName &name) const — get event in.
  • virtual SoField * getEventOut (const SbName &name) const — get event out.
  • SbBool getFieldName (const SoField *const field, SbName &name) const — get field name.
  • SbBool enableNotify (const SbBool flag) — enable notify.
  • SbBool isNotifyEnabled (void) const — is notify enabled?
  • SbBool set (const char *fielddata, SoInput *input) — set with input.
  • void get (SbString &fielddata, SoOutput *out) — get with output.
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validate new field value.
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — add write reference.
  • SbBool getIsBuiltIn (void) const — get is built-in.
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — get fields memory size.
  • void setUserData (void *userdata) const — set user data.
  • void * getUserData (void) const — get user data.

🧚 Public Member Functions inherited from SoBase 🧚

  • void ref (void) const — ref.
  • void unref (void) const — unref.
  • void unrefNoDelete (void) const — unref no delete.
  • int32_t getRefCount (void) const — get ref count.
  • void touch (void) — touch.
  • SbBool isOfType (SoType type) const — is of type?
  • virtual SbName getName (void) const — get name.
  • virtual void setName (const SbName &newname) — set name.
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — add auditor.
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — remove auditor.
  • const SoAuditorList & getAuditors (void) const — get auditors.
  • SbBool shouldWrite (void) — should write?
  • void assertAlive (void) const — assert alive.

⚡ Static Public Member Functions ⚡

  • static SoType getClassTypeId (void) — get class type ID.
  • static void initClass (void) — init class.
  • static void turnOffCurrentHighlight (SoGLRenderAction *action) — turn off current highlight.

⚡ Static Public Member Functions inherited from SoSeparator ⚡

  • static SoType getClassTypeId (void) — get class type ID.
  • static void initClass (void) — init class.
  • static void setNumRenderCaches (const int howmany) — set number of render caches.
  • static int getNumRenderCaches (void) — get number of render caches.

⚡ Static Public Member Functions inherited from SoGroup ⚡

  • static SoType getClassTypeId (void) — get class type ID.
  • static void initClass (void) — init class.

⚡ Static Public Member Functions inherited from SoNode ⚡

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — get compatibility types.
  • static SoType getClassTypeId (void) — get class type ID.
  • static SoNode * getByName (const SbName &name) — get by name.
  • static int getByName (const SbName &name, SoNodeList &l) — get by name into list.
  • static void initClass (void) — init class.
  • static void initClasses (void) — init classes.
  • static uint32_t getNextNodeId (void) — get next node ID.
  • static int getActionMethodIndex (const SoType type) — get action method index.
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — get bounding box S.
  • static void GLRenderS (SoAction *action, SoNode *node) — GL render S.
  • static void callbackS (SoAction *action, SoNode *node) — callback S.
  • static void getMatrixS (SoAction *action, SoNode *node) — get matrix S.
  • static void handleEventS (SoAction *action, SoNode *node) — handle event S.
  • static void pickS (SoAction *action, SoNode *node) — pick S.
  • static void rayPickS (SoAction *action, SoNode *node) — ray pick S.
  • static void searchS (SoAction *action, SoNode *node) — search S.
  • static void writeS (SoAction *action, SoNode *node) — write S.
  • static void audioRenderS (SoAction *action, SoNode *node) — audio render S.
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — get primitive count S.

⚡ Static Public Member Functions inherited from SoFieldContainer ⚡

  • static void initClass (void) — init class.
  • static SoType getClassTypeId (void) — get class type ID.
  • static void cleanupClass (void) — cleanup class.
  • static void initCopyDict (void) — init copy dict.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — add copy.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — check copy.
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — find copy.
  • static void copyDone (void) — copy done.

⚡ Static Public Member Functions inherited from SoBase ⚡

  • static void initClass (void) — init class.
  • static SoType getClassTypeId (void) — get class type ID.
  • static void addName (SoBase *const base, const char *const name) — add name.
  • static void removeName (SoBase *const base, const char *const name) — remove name.
  • static void incrementCurrentWriteCounter (void) — increment current write counter.
  • static void decrementCurrentWriteCounter (void) — decrement current write counter.
  • static SoBase * getNamedBase (const SbName &name, SoType type) — get named base.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — get named bases.
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — read.
  • static void setInstancePrefix (const SbString &c) — set instance prefix.
  • static void setTraceRefs (SbBool trace) — set trace refs.
  • static SbBool getTraceRefs (void) — get trace refs.
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connect route.
  • static SbBool readRoute (SoInput *input) — read route.

🌟 Public Attributes 🌟

  • SoSFColor color — the color.
  • SoSFEnum style — the style.
  • SoSFEnum mode — the mode.

🌟 Public Attributes inherited from SoSeparator 🌟

  • SoSFEnum renderCaching — render caching.
  • SoSFEnum boundingBoxCaching — bounding box caching.
  • SoSFEnum renderCulling — render culling.
  • SoSFEnum pickCulling — pick culling.

🛡️ Protected Member Functions 🛡️

  • virtual const SoFieldData * getFieldData (void) const — get field data.
  • virtual ~SoLocateHighlight () — destructor.
  • virtual void redrawHighlighted (SoAction *act, SbBool flag) — redraw highlighted.

🛡️ Protected Member Functions inherited from SoSeparator 🛡️

  • virtual ~SoSeparator () — destructor.
  • virtual SbBool cullTest (SoState *state) — cull test.
  • virtual SbBool cullTest (SoGLRenderAction *action, int &cullresults) — cull test with results.
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — read instance.

🛡️ Protected Member Functions inherited from SoGroup 🛡️

  • virtual ~SoGroup () — destructor.
  • virtual SbBool readChildren (SoInput *in) — read children.
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copy contents.

🛡️ Protected Member Functions inherited from SoNode 🛡️

  • SoNode (void) — constructor.
  • virtual ~SoNode () — destructor.

🛡️ Protected Member Functions inherited from SoFieldContainer 🛡️

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

🛡️ Protected Member Functions inherited from SoBase 🛡️

  • SoBase (void) — constructor.
  • virtual ~SoBase () — destructor.
  • virtual void destroy (void) — destroy.
  • SbBool hasMultipleWriteRefs (void) const — has multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — write header.
  • void writeFooter (SoOutput *out) const — write footer.
  • virtual const char * getFileFormatName (void) const — get file format name.

🔒 Static Protected Member Functions 🔒

  • static const SoFieldData ** getFieldDataPtr (void) — get field data pointer.

🔒 Static Protected Member Functions inherited from SoSeparator 🔒

  • static const SoFieldData ** getFieldDataPtr (void) — get field data pointer.

🔒 Static Protected Member Functions inherited from SoGroup 🔒

  • static const SoFieldData ** getFieldDataPtr (void) — get field data pointer.

🔒 Static Protected Member Functions inherited from SoNode 🔒

  • static const SoFieldData ** getFieldDataPtr (void) — get field data pointer.
  • static void setNextActionMethodIndex (int index) — set next action method index.
  • static int getNextActionMethodIndex (void) — get next action method index.
  • static void incNextActionMethodIndex (void) — increment next action method index.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — set compatibility types.

🔒 Static Protected Member Functions inherited from SoBase 🔒

  • static uint32_t getCurrentWriteCounter (void) — get current write counter.
  • static void staticDataLock (void) — static data lock.
  • static void staticDataUnlock (void) — static data unlock.

🎁 Additional Inherited Members 🎁

🎁 Protected Types inherited from SoBase 🎁

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — base flags.

🎁 Protected Attributes inherited from SoGroup 🎁

  • SoChildList * children — children pointer.

🎁 Protected Attributes inherited from SoNode 🎁

  • uint32_t uniqueId — unique ID.

🎁 Protected Attributes inherited from SoFieldContainer 🎁

  • SbBool isBuiltIn — is built-in.

🎁 Static Protected Attributes inherited from SoNode 🎁

  • static uint32_t nextUniqueId = 1 — next unique ID.
  • static int nextActionMethodIndex = 0 — next action method index.

✨ DETAILED DESCRIPTION ✨

The SoLocateHighlight class highlights geometry under the cursor. It's giving "notice me" energy but, like, only when you hover. 🖱️💖

Note: this node is supposed to draw to the front buffer. However, in Coin we always draw to the back buffer, forcing a scene redraw whenever a highlight state changes. So yeah, bestie, it's a whole thing. 💀

FILE FORMAT/DEFAULTS:

LocateHighlight {
    renderCaching AUTO
    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
    color 0.3 0.3 0.3
    style EMISSIVE
    mode AUTO
}

🎀 MEMBER ENUMERATION DOCUMENTATION 🎀

enum SoLocateHighlight::Modes

Enum type for behaviour modes. It's literally the vibe check for how the highlight acts. ✨

  • AUTO — Highlight when mouse cursor is over the contents of the node. Main character behavior only when hovered. 👑
  • ON — Always highlight. No chill. 🔥
  • OFF — Never highlight. Ghosted. 🙈

enum SoLocateHighlight::Styles

Enum type for highlight styles. Pick your aesthetic. 💅

  • EMISSIVE — Highlight using emissive color override.
  • EMISSIVE_DIFFUSE — Highlight using emissive and diffuse color override. (The source says "useing" and honestly, same vibe. 🫶)

🧚 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🧚

SoLocateHighlight::SoLocateHighlight (void )

Constructor. It makes the thing. Slay. ✨

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

Destructor. Protected and virtual, so subclasses can do their little cleanup era. 💅

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

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

Reimplemented from SoSeparator.

Reimplemented in SoWWWAnchor.

const SoFieldData * SoLocateHighlight::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 SoSeparator.

Reimplemented in SoWWWAnchor.

void SoLocateHighlight::handleEvent (SoHandleEventAction * action) [virtual]

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it is something which this node should react to.

Nodes influencing relevant state variables for how event handling is done also overrides this method.

Reimplemented from SoSeparator.

Reimplemented in SoWWWAnchor.

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

SGI Open Inventor v2.1 obsoleted support for SoGLRenderAction::addMethod(). Instead, GLRender() might be called directly, and to optimize traversal, the SoSeparator node calls GLRenderBelowPath whenever the path code is BELOW_PATH or NO_PATH (path code is guaranteed not to change). To be compatible with SGI's Inventor (and thereby also TGS') we have chosen to follow their implementation in this respect.

SoSeparator::GLRenderBelowPath() do not traverse its children using SoChildList::traverse(), but calls GLRenderBelowPath() directly for all its children.

Reimplemented from SoSeparator.

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

Implements the SoAction::IN_PATH traversal method for the rendering action.

Reimplemented from SoSeparator.

void SoLocateHighlight::turnOffCurrentHighlight (SoGLRenderAction * action) [static]

Static method that can be used to turn off the current highlight. It's the "okay bye" button. 👋

void SoLocateHighlight::redrawHighlighted (SoAction * act, SbBool flag) [protected], [virtual]

Empty method in Coin. Can be used by subclasses to be told when status change. (Yes, the original says "when status change" — we're just keeping it real. 🫶)

Reimplemented in SoWWWAnchor.

💜 MEMBER DATA DOCUMENTATION 💜

SoSFColor SoLocateHighlight::color

The color used for highlighting. Default is [0.3, 0.3, 0.3], a dark gray. Moody but make it fashion. 🖤

SoSFEnum SoLocateHighlight::style

The highlight style. Default is SoLocateHighlight::EMISSIVE.

SoSFEnum SoLocateHighlight::mode

The highlight mode. Default is SoLocateHighlight::AUTO.

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code.

Okay bestie, that's the whole page. It came from <strong>Coin, version 3.1.3</strong>, and it's <strong>SoLocateHighlight(3)</strong>. Periodt. 💅✨

📦 where this page comes from