SbHeapFuncs(3)

💖 SbHeapFuncs 💖

okay bestie, welcome to SbHeapFuncs(3) — yes it's a Coin page, yes it's a struct, no it's not boring, sit down 🫶

---

✨ NAME ✨

SbHeapFuncs — the SbHeapFuncs struct is used to specify functions on heap elements. that's literally its whole job and it does it slayfully 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/SbHeap.h>

🎀 Public Attributes 🎀

float(* eval_func )(void *)
int(* get_index_func )(void *)
void(* set_index_func )(void *, int)

---

🦋 Detailed Description 🦋

The SbHeapFuncs struct is used to specify functions on heap elements. fr fr that's the vibe — it's the lil plug-in bundle that tells the heap how to look at your elements. no cap. ✨

---

👑 Member Data Documentation 👑

⭐ float(* SbHeapFuncs::eval_func) (void *)

The eval_func member is a pointer to a function that should return a weight-value for a heap element. and listen — smaller elements are extracted first from the heap. so like, lowest weight = first out the door. main character behavior honestly 🍓

⭐ int(* SbHeapFuncs::get_index_func) (void *)

get_index_func is a pointer to a function which should return the element's heap index.

bestie this is the important part so read it twice: if you want to remove an element from the heap (other than the first element), or change the weight for a heap element, you must supply the two index functions. Each element must then store its heap index in its own data structures. like, it's not optional, it's giving mandatory 💀

⭐ void(* SbHeapFuncs::set_index_func) (void *, int)

set_index_func is used to set this index value, and it will be called whenever the element is moved in the heap. so the heap moves your element, this function goes "noted 💅" and updates the index for you. iconic teamwork 🫶

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. yeah the robots wrote the OG version, we just gave it a glow-up ✨

---

aaaand that's the page bestie!! 🌈 Version 4.0.10, dated Thu Jun 25 2026 00:00:00 — that's the Coin energy, that's the date, that's the whole manual page, periodt. go forth and heap responsibly 💖🎀🦋🌸👑