.TH "SoWriteAction" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoWriteAction \- The \fBSoWriteAction\fP class writes a scene graph to file\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/actions/SoWriteAction\&.h>\fP
.PP
Inherits \fBSoAction\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoWriteAction\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoWriteAction\fP (\fBSoOutput\fP *\fBout\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoWriteAction\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoOutput\fP * \fBgetOutput\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBcontinueToApply\fP (\fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBvoid\fP \fBcontinueToApply\fP (\fBSoPath\fP *path)"
.br
.in -1c

Public Member Functions inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoAction\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBapply\fP (\fBSoNode\fP *root)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBapply\fP (\fBSoPath\fP *path)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBapply\fP (\fBconst\fP \fBSoPathList\fP &\fBpathlist\fP, SbBool \fBobeysrules\fP=FALSE)"
.br
.ti -1c
.RI "\fBvoid\fP \fBapply\fP (\fBSoAction\fP *\fBbeingApplied\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBinvalidateState\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBAppliedCode\fP \fBgetWhatAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetNodeAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoPath\fP * \fBgetPathAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSoPathList\fP * \fBgetPathListAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSoPathList\fP * \fBgetOriginalPathListAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisLastPathListAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBPathCode\fP \fBgetPathCode\fP (int &\fBnumindices\fP, \fBconst\fP int *&indices)"
.br
.ti -1c
.RI "\fBvoid\fP \fBtraverse\fP (\fBSoNode\fP *\fBconst\fP node)"
.br
.ti -1c
.RI "SbBool \fBhasTerminated\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSoPath\fP * \fBgetCurPath\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoState\fP * \fBgetState\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBPathCode\fP \fBgetCurPathCode\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBgetCurPathTail\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBusePathCode\fP (int &\fBnumindices\fP, \fBconst\fP int *&indices)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpushCurPath\fP (\fBconst\fP int \fBchildindex\fP, \fBSoNode\fP *node=\fBNULL\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpopCurPath\fP (\fBconst\fP \fBPathCode\fP \fBprevpathcode\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpushCurPath\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpopPushCurPath\fP (\fBconst\fP int \fBchildindex\fP, \fBSoNode\fP *node=\fBNULL\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpopCurPath\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBswitchToPathTraversal\fP (\fBSoPath\fP *path)"
.br
.ti -1c
.RI "\fBvoid\fP \fBswitchToNodeTraversal\fP (\fBSoNode\fP *node)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddMethod\fP (\fBconst\fP \fBSoType\fP type, SoActionMethod method)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBenableElement\fP (\fBconst\fP \fBSoType\fP type, \fBconst\fP int \fBstackindex\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBnullAction\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP \fBSoEnabledElementsList\fP & \fBgetEnabledElements\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBbeginTraversal\fP (\fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBshouldCompactPathLists\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Protected Member Functions inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "\fBSoAction\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBendTraversal\fP (\fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetTerminated\fP (\fBconst\fP SbBool \fBflag\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBshouldCompactPathList\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoEnabledElementsList\fP * \fBgetClassEnabledElements\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoActionMethodList\fP * \fBgetClassActionMethods\fP (\fBvoid\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoEnabledElementsList\fP * \fBgetClassEnabledElements\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoActionMethodList\fP * \fBgetClassActionMethods\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Additional Inherited Members"


Public Types inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "enum \fBAppliedCode\fP { \fBNODE\fP = 0, \fBPATH\fP = 1, \fBPATH_LIST\fP = 2 }"
.br
.ti -1c
.RI "enum \fBPathCode\fP { \fBNO_PATH\fP = 0, \fBIN_PATH\fP = 1, \fBBELOW_PATH\fP = 2, \fBOFF_PATH\fP = 3 }"
.br
.in -1c

Protected Attributes inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "\fBSoState\fP * \fBstate\fP"
.br
.ti -1c
.RI "\fBSoActionMethodList\fP * \fBtraversalMethods\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoWriteAction\fP class writes a scene graph to file\&. 

When applied to a scene, this action writes its contents to the stream contained within an \fBSoOutput\fP instance\&. This can be a file, a memory buffer or a system file handle like \fCstdout\fP, for instance\&.
.PP
\fIAll\fP information considered part of the scene graph should be written out, including not only nodes, but also the nodes' field values, global fields (at least those with connections inside the scene the action is applied to), engines in the scene, paths, etc\&.
.PP
The scene is written in the Open Inventor file format\&. Files in this format can be parsed into their scene graph structures by using the \fBSoDB::readAll()\fP method (\fBSoDB\fP also contains a few other import methods you can use)\&.
.PP
Here's a complete, standalone usage example which shows how to write a scene graph to a memory buffer:
.PP
.PP
.nf
#include <Inventor/SoDB\&.h>
#include <Inventor/actions/SoWriteAction\&.h>
#include <Inventor/nodes/SoCone\&.h>
#include <Inventor/nodes/SoSeparator\&.h>

static char * buffer;
static size_t buffer_size = 0;

static void *
buffer_realloc(void * bufptr, size_t size)
{
  buffer = (char *)realloc(bufptr, size);
  buffer_size = size;
  return buffer;
}

static SbString
buffer_writeaction(SoNode * root)
{
  SoOutput out;
  buffer = (char *)malloc(1024);
  buffer_size = 1024;
  out\&.setBuffer(buffer, buffer_size, buffer_realloc);

  SoWriteAction wa(&out);
  wa\&.apply(root);

  SbString s(buffer);
  free(buffer);
  return s;
}

int
main(int argc, char ** argv)
{
  SoDB::init();

  SoSeparator * root = new SoSeparator;
  root\->ref();

  root\->addChild(new SoCone);

  SbString s = buffer_writeaction(root);
  (void)fprintf(stdout, "%s\\n", s\&.getString());

  root\->unref();
  return 0;
}
.fi
.PP
.PP
\fBSee also\fP
.RS 4
\fBSoOutput\fP 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoWriteAction::SoWriteAction (\fBvoid\fP)"
Default constructor\&. Output will be written to \fCstdout\fP in ASCII format\&. 
.SS "SoWriteAction::SoWriteAction (\fBSoOutput\fP * out)"
Constructor\&. Output will be written via the \fIout\fP object\&. 
.SS "SoWriteAction::~SoWriteAction (\fBvoid\fP)\fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoWriteAction::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoAction\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Implements \fBSoAction\fP\&.
.SS "\fBSoType\fP SoWriteAction::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBvoid\fP SoWriteAction::addMethod (\fBconst\fP \fBSoType\fP type, SoActionMethod method)\fC [static]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 
.SS "\fBvoid\fP SoWriteAction::enableElement (\fBconst\fP \fBSoType\fP type, \fBconst\fP int stackindex)\fC [static]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 
.SS "\fBconst\fP \fBSoEnabledElementsList\fP & SoWriteAction::getEnabledElements (\fBvoid\fP) const\fC [protected]\fP, \fC [virtual]\fP"
Returns list of enabled elements\&. 
.br
 
.PP
Reimplemented from \fBSoAction\fP\&.
.SS "\fBSoEnabledElementsList\fP * SoWriteAction::getClassEnabledElements (\fBvoid\fP)\fC [static]\fP, \fC [protected]\fP"
Returns list of enabled elements for this class\&. The enabledElements and methods variables are protected in the original OIV API\&. This is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs\&. This function is an extension for Coin, and it is not available in the original SGI Open Inventor \fBv2\&.1\fP API\&.
.br
 
.br
 
.SS "\fBSoActionMethodList\fP * SoWriteAction::getClassActionMethods (\fBvoid\fP)\fC [static]\fP, \fC [protected]\fP"
Returns list of action methods for this class\&. The enabledElements and methods variables are protected in the original OIV API\&. This is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs\&. This function is an extension for Coin, and it is not available in the original SGI Open Inventor \fBv2\&.1\fP API\&.
.br
 
.br
 
.SS "\fBvoid\fP SoWriteAction::initClass (\fBvoid\fP)\fC [static]\fP"
Initializes the runtime type system for this class, and sets up the enabled elements and action method list\&.   
.SS "\fBSoOutput\fP * SoWriteAction::getOutput (\fBvoid\fP) const"
Returns a pointer to the \fBSoOutput\fP object we're using when writing the scene graph\&. 
.SS "\fBvoid\fP SoWriteAction::continueToApply (\fBSoNode\fP * node)"
Applies the write method to the subgraph starting at \fInode\fP with the current \fBSoOutput\fP instance, without resetting any of the internal state of the action instance\&.
.PP
This should normally be for internal use only\&. 
.SS "\fBvoid\fP SoWriteAction::continueToApply (\fBSoPath\fP * path)"
Applies the write method to \fIpath\fP with the current \fBSoOutput\fP instance, without resetting any of the internal state of the action instance\&.
.PP
This should normally be for internal use only\&. 
.SS "\fBvoid\fP SoWriteAction::beginTraversal (\fBSoNode\fP * node)\fC [protected]\fP, \fC [virtual]\fP"
This virtual method is called from \fBSoAction::apply()\fP, and is the entry point for the actual scene graph traversal\&.
.PP
It can be overridden to initialize the action at traversal start, for specific initializations in the action subclasses inheriting \fBSoAction\fP\&.
.PP
Default method just calls \fBtraverse()\fP, which any overridden implementation of the method must do too (or call \fBSoAction::beginTraversal()\fP) to trigger the scene graph traversal\&. 
.PP
Reimplemented from \fBSoAction\fP\&.
.SS "SbBool SoWriteAction::shouldCompactPathLists (\fBvoid\fP) const\fC [protected]\fP, \fC [virtual]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Compact path lists are not implemented in Coin (yet), but if they are, \fBSoWriteAction\fP should return \fCFALSE\fP here -- it would only be extra overhead for the \fBSoWriteAction\fP to have path lists compacted before traversal\&.
.PP
Seems like a silly optimization to me, though\&.\&. :^/ 20000306 mortene\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.