SoLineDetail(3)

💖 SoLineDetail(3) — Library Functions Manual 💖

okay bestie, gather round, because today we're talking about SoLineDetail from the Coin library, and honestly? she's giving "quietly holding the entire 3D line situation together" energy. This is a section 3 manpage (library functions, iykyk) and we're gonna go through every single crumb of it. no skimming. we eat the whole plate. 🍓

---

✨ NAME ✨

SoLineDetail — the class that's literally just here to store detailed 3D line info. that's it. that's her job. and she does it flawlessly. 💅

---

✨ SYNOPSIS ✨

#include <Inventor/details/SoLineDetail.h>

Inherits SoDetail.

🌸 Public Member Functions 🌸

virtual SoType getTypeId (void) const
SoLineDetail (void)
virtual ~SoLineDetail ()
virtual SoDetail * copy (void) const
const SoPointDetail * getPoint0 (void) const
const SoPointDetail * getPoint1 (void) const
int getLineIndex (void) const
int getPartIndex (void) const
void setPoint0 (const SoPointDetail *const detail)
void setPoint1 (const SoPointDetail *const detail)
void setLineIndex (const int idx)
void setPartIndex (const int idx)
void incLineIndex (void)
void incPartIndex (void)

💜 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)

🎀 Additional Inherited Members 🎀

Protected Member Functions inherited from SoDetail

SoDetail (void)

---

✨ Detailed Description ✨

okay so. the SoLineDetail class is for storing detailed 3D line information. that's the whole vibe. 🌈

Instances of this class get used, among other things, for storing info about lines after pick operations, and for storing info that gets returned to tessellation callbacks. so like, she's the backstage pass holder. she knows things. 👑

See also SoRayPickAction, SoPickedPoint, SoCallbackAction

---

🧚 Constructor & Destructor Documentation 🧚

SoLineDetail::SoLineDetail (void )

Default constructor. sets up an empty, non-valid detail specification. (yes bestie, "non-valid" — she starts out with nothing, like your notes app before finals week. 😭)

Referenced by copy(), and getTypeId().

SoLineDetail::~SoLineDetail () [virtual]

Destructor. she's leaving, say bye. 👋

---

💅 Member Function Documentation 💅

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

Returns the type identification of a detail derived from a class inheriting SoDetail. This gets 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 SoLineDetail().

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

Return a deep copy of ourself. like a clone but with more paperwork. 🫶

⚠️ bestie, listen to me very carefully: 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. mysterious crashes. no cap. that's the scary part. 💀

Implements SoDetail.

References copy(), and SoLineDetail().

Referenced by copy().

const SoPointDetail * SoLineDetail::getPoint0 (void ) const

Returns SoPointDetail describing the line start point. where the line begins, queen of origins. ✨

const SoPointDetail * SoLineDetail::getPoint1 (void ) const

Returns SoPointDetail describing the line end point. the other end. the destination. the "we made it" moment. 🌟

int SoLineDetail::getLineIndex (void ) const

Returns the index of this line within the lineset node it is part of.

int SoLineDetail::getPartIndex (void ) const

Returns the index of this line within the complex shape node it is part of.

void SoLineDetail::setPoint0 (const SoPointDetail *const detail)

Stores information about line's start point. Used internally from library client code setting up a SoLineDetail instance.

See also getPoint0()

void SoLineDetail::setPoint1 (const SoPointDetail *const detail)

Stores information about line's end point. Used internally from library client code setting up a SoLineDetail instance.

See also getPoint1()

void SoLineDetail::setLineIndex (const int idx)

Used internally from library client code setting up a SoLineDetail instance.

See also getLineIndex()

void SoLineDetail::setPartIndex (const int idx)

Used internally from library client code setting up a SoLineDetail instance.

See also getPartIndex()

Referenced by SoLineSet::generatePrimitives().

void SoLineDetail::incLineIndex (void )

Convenience method for library client code when setting up a SoLineDetail instance to use the line index as a counter. she counts, okay? don't judge. 🔢

Referenced by SoLineSet::generatePrimitives(), and SoVRMLIndexedLineSet::generatePrimitives().

void SoLineDetail::incPartIndex (void )

Convenience method for library client code when setting up a SoLineDetail instance to use the part index as a counter.

Referenced by SoLineSet::generatePrimitives(), and SoVRMLIndexedLineSet::generatePrimitives().

---

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. (not a human author, just Doxygen doing her little robot thing. slay. 🤖✨)

---

and that's the whole page, bestie!! 🎀 Coin, Version 2.5.0, documented as SoLineDetail(3). go forth and store your detailed 3D line information with confidence. mwah. 💋💖