SoCubeDetail(3)

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

πŸ’– SoCubeDetail β€” like, the manual, but make it make sense πŸ’–

okay bestie, welcome to SoCubeDetail(3) from the Library Functions Manual ✨ this is a Coin library page, and it's genuinely not that deep β€” we're just learning how to peek at which face of a cube got hit. iconic. let's go 🫢


✨ NAME ✨

SoCubeDetail β€” the class that's holding all the receipts about the different parts of a SoCube shape. πŸ’…


🌸 SYNOPSIS 🌸

#include <Inventor/details/SoCubeDetail.h>

Inherits SoDetail. (yes, it's giving nepo baby, but like, in a good way πŸ‘‘)

πŸŽ€ Public Member Functions

virtual SoType getTypeId (void) const
SoCubeDetail (void)
virtual ~SoCubeDetail ()
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 SoCubeDetail class contains information about the parts of a SoCube shape. literally what it says on the tin, no cap.

So here's the tea πŸ“: instances of this class are what you use to stash info about hit points on cone geometry after pick operations, and to stash info that gets returned to tessellation callbacks. (yes, it says cone β€” that's the original wording, we don't question the ancestors πŸ™ˆ)

The part indices are ordered from 0 to 5 as [ front, back, left, right, top, bottom ]. six sides, six numbers, very demure, very mindful. πŸ’…

See also

  • SoCube
  • SoRayPickAction
  • SoCallbackAction

πŸ› οΈ Constructor & Destructor Documentation πŸ› οΈ

SoCubeDetail::SoCubeDetail (void )

Constructor. ✨ it constructs. that's the whole vibe.

SoCubeDetail::~SoCubeDetail () [virtual]

Destructor. πŸ’€ it destructs. goodbye queen 🫢


⭐ Member Function Documentation ⭐

SoType SoCubeDetail::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.


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

Return a deep copy of ourself. (self-care!! copy your whole self, not just the aesthetic πŸ’…)

⚠️ okay this part is serious, bestie, listen up: 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. 😭 not the mysterious crashes. be careful out there fr fr.

Implements SoDetail.


void SoCubeDetail::setPart (const int partarg)

Set the part of a cube which was selected. A cube has of course six different conceptual parts β€” it's sides. πŸ”₯


int SoCubeDetail::getPart (void ) const

Returns selected cube part. πŸ‘‘


πŸ”’ Member Data Documentation πŸ”’

int SoCubeDetail::part [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. like, it's backstage, you don't have a pass, don't worry about it πŸ’…


πŸ–‹οΈ Author πŸ–‹οΈ

Generated automatically by Doxygen for Coin from the source code. (the robots wrote it, we just added the sparkle ✨)


and that's the whole page, bestie!! 🌈 this one's from Coin, Version 3.1.3, page SoCubeDetail(3) β€” go forth and pick your cubes responsibly πŸ’–πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from