SoNodeKitDetail(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

πŸ’– SoNodeKitDetail β€” the manual page, but make it a group chat πŸ’–

okay bestie, so this is the SoNodeKitDetail(3) page from the Coin library, and I'm gonna walk you through it like we're texting at 1am. it's a class. it lives in the Library Functions Manual. let's go πŸ’…


✨ NAME ✨

SoNodeKitDetail β€” the SoNodeKitDetail class is yet to be documented.

(not me reading the docs and the docs saying "yet to be documented" 😭 iconic honestly. but there IS more info further down, so stay with me 🫢)


🌈 SYNOPSIS 🌈

#include <Inventor/details/SoNodeKitDetail.h>

Inherits SoDetail. yes bestie, it's giving inheritance. πŸ’–

πŸŽ€ 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 cleanupClass (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 πŸ‘‘

The SoNodeKitDetail class is yet to be documented. (again. bestie. the suspense. πŸ™ˆ)

BUT here's the tea πŸ“ β€” 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. so it's basically the receipt for "what did the ray touch" 🎯

See also

  • SoRayPickAction

πŸ’… Constructor & Destructor Documentation πŸ’…

πŸŽ€ SoNodeKitDetail::SoNodeKitDetail (void ) πŸŽ€

Constructor. it makes one. that's the whole vibe. ✨

πŸŽ€ SoNodeKitDetail::~SoNodeKitDetail () [virtual] πŸŽ€

Destructor. it unmakes one. closure, periodt. πŸ’€


πŸ”₯ 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. basically it's the "who are you really" check πŸ‘‘

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.

ngl if you're subclassing and you skip this, the type system will simply not know you. main character behavior requires paperwork bestie πŸ“

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

Return a deep copy of ourself. deep copy = the whole clone situation, not a shallow little alias πŸ’…

⚠️ 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.

like… mysterious crashes. not a vibe. the CRT thing is REAL, do not play with it. 😭

Implements SoDetail.

🌟 void SoNodeKitDetail::setNodeKit (SoBaseKit * kit) 🌟

Set the pointer indicating which nodekit generated this detail object. it's the "who's your parent" of detail objects 🫢

🌟 SoBaseKit * SoNodeKitDetail::getNodeKit (void ) const 🌟

Returns a pointer to the nodekit generating this details object. the answer to the question above ⬆️

🌟 void SoNodeKitDetail::setPart (SoNode * part) 🌟

Set the pointer indicating which node inside the nodekit was hit by a pick. the actual victim of the ray 🎯

🌟 SoNode * SoNodeKitDetail::getPart (void ) const 🌟

Return node inside nodekit which was hit. same energy, now you're asking instead of telling ✨

🌟 void SoNodeKitDetail::setPartName (const SbName & name) 🌟

Set catalog name of node part which was hit. names, not pointers, this time 🏷️

🌟 const SbName & SoNodeKitDetail::getPartName (void ) const 🌟

Return catalog name of nodekit part which was hit. and there's your label bestie πŸ’–


πŸ¦‹ Member Data Documentation πŸ¦‹

πŸ’œ SoBaseKit* SoNodeKitDetail::myNodeKit [protected] πŸ’œ

The nodekit generating this details object.

πŸ’œ SoNode* SoNodeKitDetail::myPart [protected] πŸ’œ

Node inside nodekit which was hit.

πŸ’œ SbName SoNodeKitDetail::myPartName [protected] πŸ’œ

Catalog name of nodekit part which was hit.


🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. so like, no human wrote this, the machine did. we love an automated queen πŸ€–πŸ‘‘


and that's the whole page bestie!! πŸŽ€ slay πŸŽ€

oh and before I forget β€” this whole thing is Coin, Version 3.1.3, and it's the SoNodeKitDetail(3) page from the Library Functions Manual. mwah, go pick some geometry πŸ’‹βœ¨πŸ¦‹

πŸ“¦ where this page comes from