Coin: SbHeapFuncs Struct Reference

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

Public Attributes | List of all members
SbHeapFuncs Struct Reference

The SbHeapFuncs struct is used to specify functions on heap elements. More...

`#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.

## Member Data Documentation

## ◆ eval_func

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. Smaller elements are extracted first from the heap.

## ◆ get_index_func

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

get_index_func is a pointer to a function which should return the element's heap index. 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.

## ◆ set_index_func

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

set_index_func is used to set this index value, and will be called whenever the element is moved in the heap.

The documentation for this struct was generated from the following files:

- SbHeap.h
- SbHeap.cpp