SoTranSender Class Reference
[General]

Sends database changes for transcription. More...

#include <Inventor/misc/SoTranscribe.h>

List of all members.

Public Member Functions
	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 ()
Friends
class	SoTranReceiver

---

Detailed Description

Sends database changes for transcription.

This class is used for transcribing Open 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 an Open 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

---

Constructor & Destructor Documentation

SoTranSender::SoTranSender

(

SoOutput *

output

)

Constructor.

Parameters:

output

Determines what the transcription area is (file or memory).

SoTranSender::~SoTranSender

(

)

[inline]

Destructor.

---

Member Function Documentation

SoOutput* SoTranSender::getOutput

(

)

const [inline]

Returns:

The current SoOutput instance.

void SoTranSender::insert	(	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 SoTranSender::insert

(

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.

void SoTranSender::modify

(

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 SoTranSender::prepareToSend

(

)

Prepares an 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.

void SoTranSender::remove	(	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 SoTranSender::replace	(	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 .

---

Friends And Related Function Documentation

friend class SoTranReceiver [friend]

---

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

• Inventor/misc/SoTranscribe.h