sc::AnimatedObject(3)

πŸ“¦
version 2.3.1 Β· 4 versions
, in fedora 43, ubuntu noble

✨ NAME ✨

sc::AnimatedObject β€” ok so this is the sc::AnimatedObject(3) page from the Library Functions Manual, and we are going to get through it together, bestie 🫢


πŸ¦‹ SYNOPSIS πŸ¦‹

Inherits sc::DescribedClass.

Inherited by sc::MolFreqAnimate.

πŸ‘‘ Public Member Functions

  • AnimatedObject (const Ref< KeyVal > &) β€” the constructor, and yes it wants a Ref< KeyVal > reference, no cap.
  • const char * name () const β€” gives you back the name πŸ’…
  • void set_name (const char *name) β€” sets the name, takes a const char *name, that's the whole vibe.
  • virtual int nobject ()=0 β€” pure virtual, so it's on you to implement it, no shortcuts 🫢 (the page itself doesn't say more than that, so I'm not about to make stuff up).
  • virtual Ref< RenderedObject > object (int iobject)=0 β€” also pure virtual, also taking an int iobject, also your problem to fill in ✨

🌸 Public Member Functions inherited from sc::DescribedClass

  • DescribedClass (const DescribedClass &) β€” copy constructor energy.
  • DescribedClass & operator= (const DescribedClass &) β€” the assignment operator, living its best life.
  • ClassDesc * class_desc () const throw () β€” This returns the unique pointer to the ClassDesc corresponding to the given type_info object. πŸ”₯
  • const char * class_name () const β€” Return the name of the object's exact type. literally what it says on the tin.
  • int class_version () const β€” Return the version of the class. πŸ“Œ
  • virtual void print (std::ostream &=ExEnv::out0()) const β€” Print the object. that's it, that's the job.

πŸŽ€ 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 β€” (yes, this one is listed with no description at all, so I'm just gonna hold it up like this πŸ™ˆ)
  • void unmanage () β€” Turn off the reference counting mechanism for this object.
  • int managed () const β€” Return 1 if the object is managed. Otherwise return 0. πŸ’€ (yes bestie, managed () const really does show up twice in this list β€” I'm not merging them, that's not my call to make)

🧚 Public Member Functions inherited from sc::Identity

  • Identifier identifier () β€” Return the Identifier for this argument.

🌈 Protected Attributes 🌈

  • char * name_ β€” that's the one (1) protected attribute, periodt.

πŸ’– Additional Inherited Members πŸ’–

πŸ“ Protected Member Functions inherited from sc::RefCount

  • RefCount (const RefCount &) β€” copy constructor, protected edition.
  • RefCount & operator= (const RefCount &) β€” assignment operator, protected edition.

πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for MPQC from the source code. πŸ€–βœ¨ (so if something reads a little stiff, blame the robot, not me)


ok that's the whole page, every single flag, member, attribute and inheritance chain accounted for, nothing skipped, nothing invented πŸ’―

MPQC, Version 2.3.1 β€” that's the footer, babe. go forth and animate something iconic πŸ‘‘πŸ¦‹πŸ’…

πŸ“¦ where this page comes from