SOTRANSENDER(3iv)

💖 SoTranSender(3IV) — bestie's guide to sending database changes for transcription 💖

okay so. welcome to the SoTranSender(3IV) page, you're gonna slay this, i promise. it's in the <Inventor/misc/SoTranscribe.h> header, it's giving very much "messenger of the Inventor world", and honestly? iconic. 🦋

✨ NAME ✨

SoTranSender — sends database changes for transcription 🎀

basically it's the one who packages up ur database glow-up and ships it off. no cap.

🌸 INHERITS FROM 🌸

SoTranSender

yep, it inherits from itself, it's that self-confident. main character energy only. 💅

✨ SYNOPSIS ✨

#include <Inventor/misc/SoTranscribe.h>

   Methods from class SoTranSender:

                  SoTranSender(SoOutput *output)
                  ~SoTranSender()
SoOutput *        getOutput() const
void              insert(SoNode *node)
void              insert(SoNode *node, SoNode *parent, int n)
void              remove(SoNode *parent, int n)
void              replace(SoNode *parent, int n, SoNode *newNode)
void              modify(SoNode *node)
void              prepareToSend()

🦋 DESCRIPTION 🦋

so this class is for transcribing Inventor data. and before u ask — transcription is literally just the process of packaging up changes to a database and yeeting them over a "wire" to another database. it's a whole delivery service, and SoTranSender is the driver. 🚚✨

SoTranSender lives on the sending side of transcription. it takes all ur changes to an Inventor database and packages them into a file or a memory area — whatever the SoOutput instance says it is. it only supports a limited set of changes to a database, and each change gets stored as a command in the transcription area. then at the other end, SoTranReceiver shows up to interpret all those transcribed commands. it's a two-girl operation, fr fr. 💖

💅 METHODS 💅

• SoTranSender(SoOutput *output) — the constructor, bestie. it takes a pointer to an SoOutput instance, and that instance decides what the transcription area actually is (a file? a memory area? that's on them). 🎀
• ~SoTranSender() — destructor. it's the goodbye era. 🥀
• SoOutput *getOutput() const — hands u back a pointer to the current SoOutput instance. simple, clean, obsessed. ✨
• void insert(SoNode *node) — adds an INSERT command to the transcription area. the given node gets added as the last child of the root node on the receiving end. last child privilege, we love to see it. 👑
• void insert(SoNode *node, SoNode *parent, int n) — also adds an INSERT command to the transcription area, but this time the node gets added as the nth child of the given parent node on the receiving end. and if the parent node is NULL? then the node just gets added to the receiving end's root node instead. flexible queen. 🌈
• void remove(SoNode *parent, int n) — adds a REMOVE command to the transcription area. the nth child of the given parent node (which is non-NULL, no exceptions bestie) gets removed on the receiving end. it's giving farewell tour. 😭
• void replace(SoNode *parent, int n, SoNode *newNode) — adds a REPLACE command to the transcription area. the nth child of the given parent node (again, non-NULL, don't play) gets replaced with newNode on the receiving end. out with the old, in with the new. glow-up initiated. 🔥
• void modify(SoNode *node) — adds a MODIFY command to the transcription area. it updates the field data for the given node to the new contents.

⚠️ okay important: this changes only field data. children of groups are not affected, and neither is any non-field instance data. so don't come for me when ur group children are still sitting there unchanged. that's just how it is. 💀

• void prepareToSend() — prepares an SoTranSender instance for transcription, making sure the transcription area is complete and all packaged to go. 🎁

🚨 and this part is not optional: this must be called before the transcription can be performed. like, no prepareToSend(), no transcription. periodt.

⭐ SEE ALSO ⭐

• SoOutput
• SoTranReceiver

go read those too, they're part of the lore. 📚

and that's the whole page, bestie!! mwah 💋 this was SoTranSender(3IV)() from the SoTranSender(3IV) manual — same title, same version, same date, just way more fun. now go transcribe something and be iconic about it. 🫶✨🎀