Sends database changes for transcription. More...

#include <Inventor/misc/SoTranscribe.h>

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

	~SoTranSender ()
	Destructor. More...

SoOutput *	getOutput () const
	Returns pointer to current SoOutput instance. More...

void	insert (SoNode *node)
	Adds an INSERT command to the transcription area. More...

void	insert (SoNode node, SoNode parent, int n)
	Adds an INSERT command to the transcription area. More...

void	remove (SoNode *parent, int n)
	Adds a REMOVE command to the transcription area. More...

void	replace (SoNode parent, int n, SoNode newNode)
	Adds a REPLACE command to the transcription area. More...

void	modify (SoNode *node)
	Adds a MODIFY command to the transcription area. More...

void	prepareToSend ()
	Prepares a SoTranSender instance for transcription, making sure the transcription area is complete and all packaged to go. More...

Friends
class	SoTranReceiver

Detailed 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.

See Also

: SoOutput, SoTranReceiver

Definition at line 97 of file SoTranscribe.h.

Constructor & Destructor Documentation

◆ SoTranSender()

SoTranSender::SoTranSender ( SoOutput * output )

◆ ~SoTranSender()

SoTranSender::~SoTranSender ( )

inline

Definition at line 105 of file SoTranscribe.h.

Member Function Documentation

◆ getOutput()

SoOutput* SoTranSender::getOutput ( ) const

inline

Definition at line 108 of file SoTranscribe.h.

◆ insert() [1/2]

void SoTranSender::insert ( SoNode * node )

The given node will be added as the last child of the root node on the receiving end.

◆ insert() [2/2]

void SoTranSender::insert	(	SoNode *	node,
		SoNode *	parent,
		int	n
	)

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.

◆ modify()

void SoTranSender::modify ( SoNode * node )

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.

◆ prepareToSend()

void SoTranSender::prepareToSend ( )

This must be called before the transcription can be performed.

◆ remove()

void SoTranSender::remove	(	SoNode *	parent,
		int	n
	)

The nth child of the given (non-NULL) parent node on the receiving end will be removed.

◆ replace()

void SoTranSender::replace	(	SoNode *	parent,
		int	n,
		SoNode *	newNode
	)

The nth child of the given (non-NULL) parent node on the receiving end will be replaced with newNode.

Friends And Related Function Documentation

◆ SoTranReceiver

friend class SoTranReceiver

friend

Definition at line 148 of file SoTranscribe.h.

The documentation for this class was generated from the following file:

/home/jenkins/workspaces/mevislab/3.7.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/misc/SoTranscribe.h

Public Member Functions

Friends