SoNodeKitDetail(3)

SoNodeKitDetail(3) 💖

okay bestie, welcome to the SoNodeKitDetail(3) page from the Library Functions Manual — yes that's the manual name, we're folding it in right at the top because we're cute AND organized. 🎀

---

✨ NAME ✨

SoNodeKitDetail — the SoNodeKitDetail class is, and I quote, yet to be documented. 💀 (we'll fix that vibe in a sec, keep reading)

---

🌸 SYNOPSIS 🌸

#include <Inventor/details/SoNodeKitDetail.h>

Inherits SoDetail.

👑 Public Member Functions

• virtual SoType getTypeId (void) const
• SoNodeKitDetail (void)
• virtual ~SoNodeKitDetail ()
• virtual SoDetail * copy (void) const
• void setNodeKit (SoBaseKit *kit)
• SoBaseKit * getNodeKit (void) const
• void setPart (SoNode *part)
• SoNode * getPart (void) const
• void setPartName (const SbName &name)
• const SbName & getPartName (void) const

💜 Public Member Functions inherited from SoDetail

• virtual ~SoDetail ()
• SbBool isOfType (const SoType type) const

✨ Static Public Member Functions

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

🦋 Static Public Member Functions inherited from SoDetail

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

🎀 Protected Attributes

• SoBaseKit * myNodeKit
• SoNode * myPart
• SbName myPartName

🌈 Additional Inherited Members

Protected Member Functions inherited from SoDetail

• SoDetail (void)

---

💅 Detailed Description 💅

So the SoNodeKitDetail class is yet to be documented. not me reading that for the third time 😭

But here's the tea, fr fr: when a pick action is executed and geometry within a nodekit is hit, the nodekit generates an SoNodeKitDetail object which contains information about the specific part inside the nodekit hit by the pick ray. ✨ iconic behavior, honestly.

See also

• SoRayPickAction

---

🫶 Constructor & Destructor Documentation 🫶

SoNodeKitDetail::SoNodeKitDetail (void )

Constructor. 🎉

References myNodeKit, myPart, and myPartName.

Referenced by copy(), and getTypeId().

SoNodeKitDetail::~SoNodeKitDetail () [virtual]

Destructor. bye bestie 👋

References myNodeKit, and myPart.

---

🔥 Member Function Documentation 🔥

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

Returns the type identification of a detail derived from a class inheriting SoDetail. This is used for run-time type checking and "downward" casting.

Usage example:

void fuhbear(SoDetail * detail)
{
  if (detail->getTypeId() == SoFaceDetail::getClassTypeId()) {
    // safe downward cast, know the type
    SoFaceDetail * facedetail = (SoFaceDetail *)detail;
  }
  return; // ignore if not a SoFaceDetail
}

For application programmers wanting to extend the library with new detail classes: 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 Inventor/nodes/SoSubDetail.h: SO_DETAIL_SOURCE and SO_DETAIL_INIT_CLASS.

Implements SoDetail.

References SoNodeKitDetail().

SoDetail * SoNodeKitDetail::copy (void ) const [virtual]

Return a deep copy of ourself. (yes, self-copy, main character energy 💅)

Note that if the Coin library has been built as a DLL under Microsoft Windows and you use this method from application code, you must make sure that both the Coin DLL and the application executable is using the same instance of a C Run-Time (CRT) library. Otherwise, you will get memory heap corruption upon deallocating the returned instances, eventually leading to mysterious crashes.

that warning is giving serious do-not-skip energy, bestie. 🚨

Implements SoDetail.

References copy(), myNodeKit, myPart, myPartName, and SoNodeKitDetail().

Referenced by copy().

void SoNodeKitDetail::setNodeKit (SoBaseKit * kit)

Set the pointer indicating which nodekit generated this detail object.

References myNodeKit, and SoBase::ref().

SoBaseKit * SoNodeKitDetail::getNodeKit (void ) const

Returns a pointer to the nodekit generating this details object.

References myNodeKit.

void SoNodeKitDetail::setPart (SoNode * part)

Set the pointer indicating which node inside the nodekit was hit by a pick.

References myPart, and SoBase::ref().

SoNode * SoNodeKitDetail::getPart (void ) const

Return node inside nodekit which was hit.

References myPart.

void SoNodeKitDetail::setPartName (const SbName & name)

Set catalog name of node part which was hit.

References myPartName.

const SbName & SoNodeKitDetail::getPartName (void ) const

Return catalog name of nodekit part which was hit.

References myPartName.

---

⭐ Member Data Documentation ⭐

SoBaseKit* SoNodeKitDetail::myNodeKit [protected]

The nodekit generating this details object.

Referenced by copy(), getNodeKit(), setNodeKit(), SoNodeKitDetail(), and ~SoNodeKitDetail().

SoNode* SoNodeKitDetail::myPart [protected]

Node inside nodekit which was hit.

Referenced by copy(), getPart(), setPart(), SoNodeKitDetail(), and ~SoNodeKitDetail().

SbName SoNodeKitDetail::myPartName [protected]

Catalog name of nodekit part which was hit.

Referenced by copy(), getPartName(), setPartName(), and SoNodeKitDetail().

---

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. (the robots wrote this one, not me 🙈)

---

and that's the whole page, bestie! 💖 this lil doc came from Coin, Version 2.5.0 — so if you're quoting it in the group chat, that's the version you're quoting. slay, go forth, and may your pick rays always hit the part you wanted. 🎀✨🦋