SbClip(3)

💖 SbClip(3) — the polygon clipper bestie 💖

okay so you found the SbClip page in the Library Functions Manual, and honestly? you're about to have a great time. this is the class that clips polygons for you and it's giving main character energy. let's go ✨

---

🌸 NAME 🌸

SbClip — the SbClip class is a generic polygon clipper class. periodt.

---

✨ SYNOPSIS ✨

#include <include/Inventor/base/SbClip.h>

🎀 Public Member Functions

SbClip (SbClipCallback *callback=NULL, void *userdata=NULL)
void addVertex (const SbVec3f &v, void *vdata=NULL)
void reset (void)
void clip (const SbPlane &plane)
int getNumVertices (void) const
void getVertex (const int idx, SbVec3f &v, void **vdata=NULL) const
void * getVertexData (const int idx) const

---

🦋 Detailed Description 🦋

so, the tea: the SbClip class is a generic polygon clipper class. 💅

here's the whole flow, no cap. you use it by first adding all vertices in the polygon, and then clipping against any number of planes. that's it. that's the vibe.

now, if you need to carry extra info per vertex (think texture coordinates, you know the drill), you should supply a callback in the constructor, and then a pointer to your vertex structure in addVertex(). 🫶

and here's the part where it gets iconic: for every new vertex created, the callback is called with the line being clipped — including the pointers to your vertex structures AND the position of the new (clipped against some plane) vertex. so then you create a new vertex structure, calculate your data (like a fresh new texture coordinate 🍓) and return a pointer to this structure. that's your whole job. slay.

⚠️ heads up bestie: be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. so don't come looking for it there, she's not home. 💀

Since

Coin 2.0 ⭐

---

👑 Constructor & Destructor Documentation 👑

SbClip::SbClip (SbClipCallback * callback = NULL, void * userdata = NULL)

a constructor. supply a callback if you need to handle additional data per vertex. that's the whole thing, iykyk. 💖

---

🌈 Member Function Documentation 🌈

void SbClip::addVertex (const SbVec3f & v, void * vdata = NULL)

adds a polygon vertex. vdata could be a pointer to your vertex structure. easy. 🌸

void SbClip::reset (void )

resets the clipper. you should call this before adding any vertices when reusing an SbClip instance — like, do it, don't skip it. 🙈

void SbClip::clip (const SbPlane & plane)

clip polygon against plane. ngl this might change the number of vertices in the polygon, so don't be shocked.

for each time a new vertex is created, the callback supplied in the constructor (if != NULL) is called with the line being clipped and the new vertex calculated. the callback should return a new void pointer to be stored by the clipper. that's the deal. 🔥

int SbClip::getNumVertices (void ) const

returns the number of vertices in the polygon. 💫

See also

SbClip::getVertex()

void SbClip::getVertex (const int idx, SbVec3f & v, void ** vdata = NULL) const

returns the vertex at index idx. 🎯

See also

SbClip::getNumVertices()

void * SbClip::getVertexData (const int idx) const

return the vertex data at index idx. that's it, go off. 💜

---

💜 Author 💜

generated automatically by Doxygen for Coin from the source code. (not a human, just a robot doing its little thing 🤖✨)

---

and that's the page, bestie!! 🫶 this was Coin, Version 3.1.3, and yeah — SbClip(3), we love her, we stan, bye!! 🎀💖🦋