SoCylinderDetail(3)

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

✨ NAME ✨

okay so bestie, welcome to SoCylinderDetail πŸ’– β€” it's a class from the Library Functions Manual (section 3, the C++ library girlies πŸŽ€), and it holds all the tea about the different parts of a SoCylinder shape. literally its whole job. iconic.


🌸 SYNOPSIS 🌸

#include <Inventor/details/SoCylinderDetail.h>

Inherits SoDetail. yes she's a nepo baby, and we love that for her πŸ’…

πŸ’œ Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoCylinderDetail (void)
  • virtual ~SoCylinderDetail ()
  • virtual SoDetail * copy (void) const
  • void setPart (const int part)
  • int getPart (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

  • int part

🧚 Additional Inherited Members

πŸ“ Protected Member Functions inherited from SoDetail

  • SoDetail (void)

πŸ’– Detailed Description πŸ’–

The SoCylinderDetail class contains information about the parts of a SoCylinder shape. no cap.

So like, instances of this class are what you use for storing information about hit points on cylinder geometry after pick operations, and for storing information that gets returned to tessellation callbacks. she's the little receipt for "which bit of the cylinder did you just touch" 🫢

See also

  • SoCylinder
  • SoRayPickAction
  • SoCallbackAction

πŸ‘‘ Constructor & Destructor Documentation πŸ‘‘

SoCylinderDetail::SoCylinderDetail (void )

Constructor. she's born πŸ’«

SoCylinderDetail::~SoCylinderDetail () [virtual]

Destructor. she's leaving, periodt 😭


πŸ”₯ Member Function Documentation πŸ”₯

SoType SoCylinderDetail::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. it's the "who are you really" moment πŸ’…

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. slay.

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

Return a deep copy of ourself. twin where have you been πŸͺž

🚨 okay listen up bestie, this part is serious. 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. πŸ’€ do NOT skip this one.

Implements SoDetail.

void SoCylinderDetail::setPart (const int partarg)

Set the part of a cylinder which was selected. A cylinder has three different conceptual parts: SoCylinder::SIDES, SoCylinder::TOP or SoCylinder::BOTTOM. pick your fighter ⭐

int SoCylinderDetail::getPart (void ) const

Returns selected cylinder part. the reveal 🎁


🧁 Member Data Documentation 🧁

int SoCylinderDetail::part [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (translation: stay in your lane, it's giving private business πŸ™ˆ)


πŸ’« Author πŸ’«

Generated automatically by Doxygen for Coin from the source code. the robots wrote it, not me 🫑


🌈 and that's the whole page bestie!! this was Coin, Version 3.1.3, page SoCylinderDetail(3) of the Library Functions Manual. go forth and pick cylinders responsibly πŸ’–βœ¨πŸŽ€
πŸ“¦ where this page comes from