Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   31559 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

							     SoTranSender(3IV)

NAME
     SoTranSender (SoTranSender) - sends database changes for transcription

INHERITS FROM
     SoTranSender

SYNOPSIS
     #include <Inventor_c/misc/SoTranscribe.h>

	  Functions from class SoTranSender:

     SoTranSender *	 SoTranSenderCreate(SoOutput *output)
     void		 SoTranSenderDelete(SoTranSender *this)
     SoOutput *		 SoTranSenderGetOutput(const SoTranSender *this)
     void		 SoTranSenderInsert(SoTranSender *this, SoNode *node)
     void		 SoTranSenderInsertUnder(SoTranSender *this, SoNode
			      *node, SoNode *parent, int n)
     void		 SoTranSenderRemove(SoTranSender *this, SoNode
			      *parent, int n)
     void		 SoTranSenderReplace(SoTranSender *this, SoNode
			      *parent, int n, SoNode *newNode)
     void		 SoTranSenderModify(SoTranSender *this, SoNode *node)
     void		 SoTranSenderPrepareToSend(SoTranSender *this)

DESCRIPTION
     This class is used for transcribing Inventor data. Transcription is the
     process of packaging changes to a database and sending them over a "wire"
     to another database.

     The SoTranSender class is used on the sending side of transcription. It
     packages up changes to a Inventor database into a file or memory area
     defined by an SoOutput instance. It supports a limited set of changes to
     a database; each change is stored as a command in the transcription area.
     The SoTranReceiver class can be used at the other end to interpret the
     transcribed commands.

FUNCTIONS
     SoTranSender *	 SoTranSenderCreate(SoOutput *output)
	  The constructor takes a pointer to an SoOutput instance that
	  determines what the transcription area is (file or memory).

     void		 SoTranSenderDelete(SoTranSender *this)
	  Destructor.

     SoOutput *		 SoTranSenderGetOutput(const SoTranSender *this)
	  Returns pointer to current SoOutput instance.

     void		 SoTranSenderInsert(SoTranSender *this, SoNode *node)
	  Adds an INSERT command to the transcription area. The given node
	  will be added as the last child of the root node on the receiving
	  end.

Page 1

SoTranSender(3IV)

     void		 SoTranSenderInsertUnder(SoTranSender *this, SoNode
			      *node, SoNode *parent, int n)
	  Adds an INSERT command to the transcription area. The given node
	  will be added as the nth child of the given parent node on the
	  receiving end. A NULL parent node causes the node to be added to the
	  receiving end's root node.

     void		 SoTranSenderRemove(SoTranSender *this, SoNode
			      *parent, int n)
	  Adds a REMOVE command to the transcription area. The nth child of
	  the given (non-NULL) parent node on the receiving end will be
	  removed.

     void		 SoTranSenderReplace(SoTranSender *this, SoNode
			      *parent, int n, SoNode *newNode)
	  Adds a REPLACE command to the transcription area. The nth child of
	  the given (non-NULL) parent node on the receiving end will be
	  replaced with newNode.

     void		 SoTranSenderModify(SoTranSender *this, SoNode *node)
	  Adds a MODIFY command to the transcription area. Updates the field
	  data for the given node to the new contents. Note that this changes
	  only field data; children of groups are not affected, nor is any
	  non-field instance data.

     void		 SoTranSenderPrepareToSend(SoTranSender *this)
	  Prepares a SoTranSender instance for transcription, making sure the
	  transcription area is complete and all packaged to go. This must be
	  called before the transcription can be performed.

SEE ALSO
     SoOutput, SoTranReceiver

Page 2

Vote for polarhome