SoLineDetail(3)

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

πŸ’– SoLineDetail(3) πŸ’–

okay bestie, welcome to the SoLineDetail page from the Coin library β€” this one's a <Library Functions Manual> moment and honestly it's giving "small class, big feelings". Let's get into it πŸ¦‹


✨ NAME ✨

SoLineDetail β€” the class that exists purely to store detailed 3D line information. that's it, that's the whole job, and it does it gorgeously πŸ’…


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

🌈 Additional Inherited Members

Protected Member Functions inherited from SoDetail

SoDetail (void)

πŸ’œ Detailed Description πŸ’œ

So the tea is: SoLineDetail is the class for storing detailed 3D line information. that's literally its whole personality, and it ate.

Instances of this class get used, among other things, for storing information about lines after pick operations, and for storing information that gets returned to tessellation callbacks. so like… it's the little note-passing go-between, and we love her for it 🫢

See also

  • SoRayPickAction, SoPickedPoint, SoCallbackAction

🧚 Constructor & Destructor Documentation 🧚

SoLineDetail::SoLineDetail (void )

The default constructor, and no cap: it sets up an empty, non-valid detail specification. so she's born a blank slate, iconique ✨

SoLineDetail::~SoLineDetail () [virtual]

The destructor. bye bestie πŸ‘‹


πŸ‘‘ Member Function Documentation πŸ‘‘

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

Returns the type identification of a detail derived from a class inheriting SoDetail. This is what 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 the application programmers out there wanting to extend the library with brand new detail classes: this method needs to be overridden in all subclasses, fr fr. it's 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.

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

Return a deep copy of ourself. she's cloning herself, main character energy only πŸ’…

⚠️ heads up: 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. not the vibe. πŸ’€

Implements SoDetail.

const SoPointDetail * SoLineDetail::getPoint0 (void ) const

Returns SoPointDetail describing the line start point.

const SoPointDetail * SoLineDetail::getPoint1 (void ) const

Returns SoPointDetail describing the line end point.

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 the 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 the 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()

void SoLineDetail::incLineIndex (void )

A convenience method for library client code β€” when you're setting up a SoLineDetail instance and you want to use the line index as a counter. ✨

void SoLineDetail::incPartIndex (void )

A convenience method for library client code β€” when you're setting up a SoLineDetail instance and you want to use the part index as a counter. ✨


🫢 Author 🫢

Generated automatically by Doxygen for Coin from the source code. yes bestie, the docs wrote themselves, we're just vibing here 😭


and that's the whole page!! Coin, Version 3.1.3, and yeah the header says SoLineDetail(3) which is exactly where we started. mwah πŸ’‹ go forth and detail your lines, you got this πŸŽ€

πŸ“¦ where this page comes from