sc::MoleculeColorizer(3)

💖 sc::MoleculeColorizer 💖

okay bestie, welcome to the Library Functions Manual entry for sc::MoleculeColorizer — yes it's a class, yes it's a whole vibe, and yes we're gonna get through every single member function together, no skips, no shortcuts. 🫶

---

✨ NAME ✨

sc::MoleculeColorizer — the abstract girlie that decides how your molecule gets its lil colors painted on. 🎨💅

---

🌈 SYNOPSIS 🌈

Inherits sc::DescribedClass.

Also, and this is the family tree moment, it's inherited by these three:

• sc::AtomProximityColorizer
• sc::DensityColorizer
• sc::GradDensityColorizer

so like, she's the mother of a whole little dynasty. 👑

---

💜 Public Member Functions 💜

• MoleculeColorizer(const Ref< Molecule > &) — build one of these from a reference to a Molecule, that's the whole assignment bestie.
• MoleculeColorizer(const Ref< KeyVal > &) — or build it from a reference to a KeyVal, whichever fits the situation, we're flexible like that. ✨
• virtual void colorize(const Ref< RenderedPolygons > &)=0 — the big one. This is pure virtual, meaning it has no body here and the derived classes must implement it themselves. It takes a reference to RenderedPolygons. So if you came here looking for the actual coloring logic, it's not in this class, it's in the children. ikykyk. 😭

---

🌸 Public Member Functions inherited from sc::DescribedClass 🌸

• DescribedClass(const DescribedClass &) — the copy constructor, doing copy constructor things.
• DescribedClass & operator=(const DescribedClass &) — assignment operator, same energy.
• ClassDesc * class_desc() const throw() — "This returns the unique pointer to the ClassDesc corresponding to the given type_info object." fr fr, it hands you the unique pointer to the ClassDesc for that type_info.
• const char * class_name() const — "Return the name of the object's exact type." Exactly what it says, the exact type, no rounding. 💅
• int class_version() const — "Return the version of the class." the class's version number, queen behavior.
• virtual void print(std::ostream &=ExEnv::out0()) const — "Print the object." and note that default argument, it streams to ExEnv::out0() unless you say otherwise. 🎀

---

🦋 Public Member Functions inherited from sc::RefCount 🦋

• int lock_ptr() const — "Lock this object."
• int unlock_ptr() const — "Unlock this object."
• void use_locks(bool inVal) — "start and stop using locks on this object"
• refcount_t nreference() const — "Return the reference count."
• refcount_t reference() — "Increment the reference count and return the new count."
• refcount_t dereference() — "Decrement the reference count and return the new count."
• int managed() const — the first managed(), just chillin' with no description attached.
• void unmanage() — "Turn off the reference counting mechanism for this object." she said no more counting, periodt.
• int managed() const — and here's managed() again, this time with lore: "Return 1 if the object is managed. Otherwise return 0." 🫡

yeah bestie, managed() const shows up twice in the source listing with two different notes. That's not me being messy, that's just how it's written. Keeping it 💯 accurate.

---

🧚 Public Member Functions inherited from sc::Identity 🧚

• Identifier identifier() — "Return the Identifier for this argument." it gives you the Identifier, simple as. ⭐

---

🍓 Protected Attributes 🍓

• Ref< Molecule > mol_ — the protected member holding a reference to a Molecule. That trailing underscore? iconic. That's the whole note.

---

👑 Additional Inherited Members 👑

🌟 Protected Member Functions inherited from sc::RefCount 🌟

• RefCount(const RefCount &) — copy constructor for RefCount, protected, so only the family gets to touch it.
• RefCount & operator=(const RefCount &) — and the matching assignment operator, also protected.

---

💀 Author 💀

"Generated automatically by Doxygen for MPQC from the source code."

which basically means a robot wrote this and I'm just here to make it cute. 🫶✨

---

and that's the whole page, bestie!! no notes, we ate, every single function accounted for. 💖

sc::MoleculeColorizer(3) — brought to you by MPQC, Version 2.3.1. mwah, take care of her, she's abstract and she needs her subclasses. 🎀💜🦋