1SoTranSender(3IV)()                                        SoTranSender(3IV)()
2
3
4

NAME

6       SoTranSender — sends database changes for transcription
7

INHERITS FROM

9       SoTranSender
10

SYNOPSIS

12       #include <Inventor/misc/SoTranscribe.h>
13
14          Methods from class SoTranSender:
15
16                         SoTranSender(SoOutput *output)
17                         ~SoTranSender()
18     SoOutput *          getOutput() const
19     void                insert(SoNode *node)
20     void                insert(SoNode *node, SoNode *parent, int n)
21     void                remove(SoNode *parent, int n)
22     void                replace(SoNode *parent, int n, SoNode *newNode)
23     void                modify(SoNode *node)
24     void                prepareToSend()
25
26

DESCRIPTION

28       This class is used for transcribing Inventor data. Transcription is the
29       process of packaging changes to a database  and  sending  them  over  a
30       "wire" to another database.
31
32       The SoTranSender class is used on the sending side of transcription. It
33       packages up changes to a Inventor database into a file or  memory  area
34       defined  by  an SoOutput instance. It supports a limited set of changes
35       to a database; each change is stored as a command in the  transcription
36       area.  The  SoTranReceiver class can be used at the other end to inter‐
37       pret the transcribed commands.
38

METHODS

40                         SoTranSender(SoOutput *output)
41          The constructor takes a pointer to an SoOutput instance that  deter‐
42          mines what the transcription area is (file or memory).
43
44                         ~SoTranSender()
45          Destructor.
46
47     SoOutput *          getOutput() const
48          Returns pointer to current SoOutput instance.
49
50     void                insert(SoNode *node)
51          Adds  an  INSERT  command  to the transcription area. The given node
52          will be added as the last child of the root node  on  the  receiving
53          end.
54
55     void                insert(SoNode *node, SoNode *parent, int n)
56          Adds  an  INSERT  command  to the transcription area. The given node
57          will be added as the nth child of  the  given  parent  node  on  the
58          receiving end. A NULL parent node causes the node to be added to the
59          receiving end's root node.
60
61     void                remove(SoNode *parent, int n)
62          Adds a REMOVE command to the transcription area. The  nth  child  of
63          the  given  (non-NULL)  parent  node  on  the  receiving end will be
64          removed.
65
66     void                replace(SoNode *parent, int n, SoNode *newNode)
67          Adds a REPLACE command to the transcription area. The nth  child  of
68          the  given  (non-NULL)  parent  node  on  the  receiving end will be
69          replaced with newNode.
70
71     void                modify(SoNode *node)
72          Adds a MODIFY command to the transcription area. Updates  the  field
73          data  for the given node to the new contents. Note that this changes
74          only field data; children of groups are not  affected,  nor  is  any
75          non-field instance data.
76
77     void                prepareToSend()
78          Prepares  a SoTranSender instance for transcription, making sure the
79          transcription area is complete and all packaged to go. This must  be
80          called before the transcription can be performed.
81
82

SEE ALSO

84       SoOutput, SoTranReceiver
85
86
87
88
89                                                           SoTranSender(3IV)()
Impressum