sotransender(3iv) [debian man page]

SoTranSender(3IV)()													       SoTranSender(3IV)()

NAME

       SoTranSender -- sends database changes for transcription

INHERITS FROM

       SoTranSender

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

       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 tran-
       scription area. The SoTranReceiver class can be used at the other end to interpret the transcribed commands.

METHODS

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

			 ~SoTranSender()
	  Destructor.

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

     void		 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		 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  receiv-
	  ing end. A NULL parent node causes the node to be added to the receiving end's root node.

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

     void		 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		 prepareToSend()
	  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

															       SoTranSender(3IV)()

SoLightPath(3)							       Coin							    SoLightPath(3)

NAME

       SoLightPath -

       The SoLightPath class is a light version of SoPath.

       SoLightPath can be used if you only need a temporary path, and don't want the overhead that comes with an SoPath (ref, unref, auditing
       etc).

SYNOPSIS

       #include <Inventor/misc/SoLightPath.h>

   Public Member Functions
       SoLightPath (SoNode *node, const int approxlength)
       SoLightPath (const int approxlength)
       ~SoLightPath ()
       void setHead (SoNode *const node)
       void append (const int childindex)
       void push (const int childindex)
       void pop (void)
       void setTail (const int childindex)
       SoNode * getTail (void) const
       SoNode * getHead (void) const
       SoNode * getNode (const int index) const
       int getIndex (const int index) const
       int getFullLength () const
       void truncate (const int startindex)
       void makeTempPath (SoTempPath *path) const

Detailed Description
       The SoLightPath class is a light version of SoPath.

       SoLightPath can be used if you only need a temporary path, and don't want the overhead that comes with an SoPath (ref, unref, auditing
       etc).

       It is your responsibility to make sure the path is valid before using it.

Constructor &; Destructor Documentation
   SoLightPath::SoLightPath (SoNode *headnodeptr, const intapproxlength)
       A constructor. Supply the head node and the approximate length of the path.

   SoLightPath::SoLightPath (const intapproxlength)
       A constructor. Supply the appriximate length of the path.

   SoLightPath::~SoLightPath ()
       Destructor.

Member Function Documentation
   void SoLightPath::setHead (SoNode *constnode)
       Sets head of path. Truncates path to length 1.

   void SoLightPath::append (const intchildindex)
       Appends a childindex to the path.

   void SoLightPath::push (const intchildindex)
       Same as append().

   void SoLightPath::pop (void)
       Pops off the last child.

   void SoLightPath::setTail (const intchildindex)
       Sets the tail of the path.

   SoNode * SoLightPath::getTail (void) const
       Returns the tail node of the path. Uses getNode().

   SoNode * SoLightPath::getHead (void) const
       Returns the head node.

   SoNode * SoLightPath::getNode (const intindex) const
       Returns the indexth node in path.

   int SoLightPath::getIndex (const intindex) const
       Returns the child index of the indexth node in the path.

   int SoLightPath::getFullLength (void) const
       Returns the length of the path.

   void SoLightPath::truncate (const intstartindex)
       Truncates the path from startindex.

   void SoLightPath::makeTempPath (SoTempPath *path) const
       Updates path to be the same path as this path.

Author
       Generated automatically by Doxygen for Coin from the source code.

Version 3.1.3							  Wed May 23 2012						    SoLightPath(3)