SoComposeVec3f(3)

📦 version 3.1.3, in fedora 43, fedora 44

🎀 NAME 🎀

Okay bestie, say hi to SoComposeVec3f(3) — the SoComposeVec3f class is literally the one that composes 3D vectors from floats. That's it, that's the job. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/engines/SoCompose.h>

It inherits SoEngine. Iconic lineage, no cap. 👑

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • virtual const SoFieldData * getFieldData (void) const
  • virtual const SoEngineOutputData * getOutputData (void) const

💫 Public Member Functions inherited from SoEngine 💫

  • void evaluateWrapper (void)
  • virtual int getOutputs (SoEngineOutputList &l) const
  • SoEngineOutput * getOutput (const SbName &outputname) const
  • SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const
  • SbBool isNotifying (void) const
  • virtual void notify (SoNotList *nl)
  • SoEngine * copy (void) const
  • virtual SoFieldContainer * copyThroughConnection (void) const
  • SbBool shouldCopy (void) const
  • virtual void writeInstance (SoOutput *out)

🦋 Public Member Functions inherited from SoFieldContainer 🦋

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
  • SbBool set (const char *const fielddata)
  • void get (SbString &fielddata)
  • virtual int getFields (SoFieldList &l) const
  • virtual int getAllFields (SoFieldList &l) const
  • virtual SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (const SbName &name) const
  • SbBool getFieldName (const SoField *const field, SbName &name) const
  • SbBool enableNotify (const SbBool flag)
  • SbBool isNotifyEnabled (void) const
  • SbBool set (const char *fielddata, SoInput *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn (void) const
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

🌈 Public Member Functions inherited from SoBase 🌈

  • void ref (void) const
  • void unref (void) const
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const
  • void touch (void)
  • SbBool isOfType (SoType type) const
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • virtual void startNotify (void)
  • void addAuditor (void *const auditor, const SoNotRec::Type type)
  • void removeAuditor (void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void)
  • static void * createInstance (void)
  • static void initClass ()

💜 Static Public Member Functions inherited from SoEngine 💜

  • static void initClass (void)
  • static void initClasses (void)
  • static SoType getClassTypeId (void)
  • static SoEngine * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoEngineList &el)

🍓 Static Public Member Functions inherited from SoFieldContainer 🍓

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void cleanupClass (void)
  • static void initCopyDict (void)
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
  • static void copyDone (void)

🧚 Static Public Member Functions inherited from SoBase 🧚

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

👑 Public Attributes 👑

  • SoMFFloat x
  • SoMFFloat y
  • SoMFFloat z
  • SoEngineOutput vector

🔥 Static Protected Member Functions 🔥

  • static const SoFieldData ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

🫶 Static Protected Member Functions inherited from SoEngine 🫶

  • static const SoFieldData ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

💀 Static Protected Member Functions inherited from SoBase 💀

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

💖 Additional Inherited Members 💖

🌸 Protected Types inherited from SoBase 🌸

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

✨ Protected Member Functions inherited from SoEngine ✨

  • SoEngine (void)
  • virtual ~SoEngine (void)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void inputChanged (SoField *which)
  • void writeOutputTypes (SoOutput *out)

🎀 Protected Member Functions inherited from SoFieldContainer 🎀

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

🦋 Protected Member Functions inherited from SoBase 🦋

  • SoBase (void)
  • virtual ~SoBase ()
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const

🌈 Protected Attributes inherited from SoFieldContainer 🌈

  • SbBool isBuiltIn

🌟 Detailed Description 🌟

Okay so real talk: the SoComposeVec3f class is used to compose 3D vectors from floats. That's the whole plot. It takes floats in, it gives you a vector out. Slay. 💅✨

💅 Member Function Documentation 💅

🫧 SoType SoComposeVec3f::getTypeId (void ) const [virtual] 🫧

This one hands you back the type identification of any object derived from a class that inherits SoBase. What's it for? Run-time type checking, and "downward" casting. Yes bestie, the quotes around "downward" are in the original, we keep them. 😌

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

Now listen, for you application programmers out there who want to extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. No skipping, that's mandatory. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

Want more info on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. 💜

Implements SoBase.

🫧 const SoFieldData * SoComposeVec3f::getFieldData (void ) const [virtual] 🫧

Returns a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. That's it. 🤷‍♀️

Reimplemented from SoFieldContainer.

🫧 const SoEngineOutputData * SoComposeVec3f::getOutputData (void ) const [virtual] 🫧

Heads up: this API member is considered internal to the library, because it is not likely to be of interest to the application programmer. So like, it's giving backstage pass energy. 🎟️

Implements SoEngine.

🍓 Member Data Documentation 🍓

SoMFFloat SoComposeVec3f::x

First coordinates of the output vectors. ✨

SoMFFloat SoComposeVec3f::y

Second coordinates of the output vectors. ✨

SoMFFloat SoComposeVec3f::z

Third coordinates of the output vectors. ✨

SoEngineOutput SoComposeVec3f::vector

(SoMFVec3f) 3D vectors. The main character of this whole class, fr fr. 🌈

💌 Author 💌

Generated automatically by Doxygen for Coin from the source code. Not a human, not a vibe, just Doxygen doing its lil thing. 🤖

And that's a wrap, bestie!! 🎀 This whole page is Coin, Version 3.1.3, and it's the SoComposeVec3f(3) manual page — go forth and compose those vectors, you absolute icon. 💖✨🦋

📦 where this page comes from