SoTransformVec3f(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoTransformVec3f(3) — ok bestie, we're learning C++ 💖

This one's from the Library Functions Manual, section 3 (iykyk, section 3 = library calls). Buckle up, because this class is genuinely so cute and also extremely niche and I love that for it. ✨

🌸 NAME 🌸

SoTransformVec3f — the class that transforms 3D vectors by a matrix. That's it. That's the whole job. It eats vectors, applies a matrix, spits out transformed stuff. 🦋

✨ SYNOPSIS ✨

#include <Inventor/engines/SoTransformVec3f.h>

It inherits SoEngine. So it's an engine, bestie, not a node. Important distinction, don't mix them up or the compiler will simply end you. 💀

💅 Public Member Functions 💅

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

🫶 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 (void)

🌈 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 🎀

  • SoMFVec3f vector
  • SoMFMatrix matrix
  • SoEngineOutput point
  • SoEngineOutput direction
  • SoEngineOutput normalDirection

🔒 Protected Member Functions 🔒

  • virtual ~SoTransformVec3f (void)

🔒 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

🧚 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 Attributes inherited from SoFieldContainer — SbBool isBuiltIn

👑 Detailed Description 👑

The SoTransformVec3f class transforms 3D vectors by a matrix. No cap, that's genuinely the entire personality. 💖

💜 Constructor & Destructor Documentation 💜

SoTransformVec3f::SoTransformVec3f (void )

The default constructor. It just... exists. Builds the thing. Slay. ✨

SoTransformVec3f::~SoTransformVec3f (void ) [protected], [virtual]

Destructor is protected because explicit destruction of engines is not allowed. Bestie, you do not get to delete this yourself. The library handles it. Do not fight the library. 😭

🔥 Member Function Documentation 🔥

SoType SoTransformVec3f::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is what powers run-time type checking and "downward" casting. It's giving detective energy, but for types. 🕵️

Usage example:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. 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.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

const SoFieldData * SoTransformVec3f::getFieldData (void ) const [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, it returns NULL. Simple as that, no notes. 🎀

Reimplemented from SoFieldContainer.

const SoEngineOutputData * SoTransformVec3f::getOutputData (void ) const [virtual]

Ok so, heads up: this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. So like... you probably don't need this one, bestie. It's backstage. 🎭

Implements SoEngine.

🌈 Member Data Documentation 🌈

SoMFVec3f SoTransformVec3f::vector

Set of 3D vector inputs to transform. These are the little guys going in. 🦋

SoMFMatrix SoTransformVec3f::matrix

Set of transformation matrices to use on the vectors. The math that does the transforming. Iconic behaviour, honestly. 💅

SoEngineOutput SoTransformVec3f::point

(SoMFVec3f) Transformed points. Out they come, all glowed up. ✨

SoEngineOutput SoTransformVec3f::direction

(SoMFVec3f) Transformed vector directions. Directions got the glow-up too. 🧭

SoEngineOutput SoTransformVec3f::normalDirection

(SoMFVec3f) Normalized transformed vector directions. Same as above but normalized. The extra step. The main character moment. 👑

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. So nobody hand-wrote this and yet here we are, emotionally attached. 😭

And that's the whole page, bestie! This came out of Coin, Version 3.1.3 — mwah, ily, go transform some vectors responsibly. 🫶✨🎀

📦 where this page comes from