Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoWriteAction.h
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : Paul S. Strauss (MMM yyyy)
25**=======================================================================*/
26/*=======================================================================
27 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
28 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
29 *** ***
30 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
31 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
32 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
33 *** ***
34 *** RESTRICTED RIGHTS LEGEND ***
35 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
36 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
37 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
38 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
39 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
40 *** ***
41 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
42 *** BORDEAUX, FRANCE ***
43 *** ALL RIGHTS RESERVED ***
44**=======================================================================*/
45/*=======================================================================
46** Modified by : VSG (MMM YYYY)
47**=======================================================================*/
48
49
50#ifndef _SO_WRITE_ACTION_
51#define _SO_WRITE_ACTION_
52
53#include <Inventor/actions/SoAction.h>
54#include <Inventor/actions/SoSubAction.h>
55#include <Inventor/SoOutput.h>
56
111class SoWriteAction : public SoAction {
112
113 SO_ACTION_HEADER(SoWriteAction);
114
115 public:
120
125
126 // Destructor
127#ifndef HIDDEN_FROM_DOC
128 virtual ~SoWriteAction();
129#endif // HIDDEN_FROM_DOC
130
134 SoOutput * getOutput() const { return output; }
135
136 private:
137 static void initClass();
138 static void exitClass();
139
140 // Continues write action on a graph or path
141 void continueToApply(SoNode *node);
142 void continueToApply(SoPath *path);
143
152 static bool writeFile(const SbString& outputFilename, SoNode* scenegraph, const bool binaryFormat=false, const bool compressedFormat=false);
153
154 private:
155 // Initiates action on graph
156 virtual void beginTraversal(SoNode *node);
157
158 // Override method to return FALSE, since this action applies
159 // itself to each path separately, so it doesn't need the extra
160 // overhead of compacting the list.
161 virtual SbBool shouldCompactPathLists() const;
162
163 private:
164 SoOutput *output; // Output info
165 SbBool createdOutput; // TRUE if output created by action
166 SbBool continuing; // TRUE only if continueToApply()
167 // was used to apply action
168 SbBool doOneStage; // TRUE if only supposed to do 1 stage
169 SbPList savedLists; // Path lists saved for later apply
170
171 // Performs traversal on a path list, which is a little tricker
172 void traversePathList(SoNode *node);
173};
174
175#endif /* _SO_WRITE_ACTION_ */
176
List of generic (void *) pointers.
Definition SbPList.h:77
Class for smart character strings.
Definition SbString.h:202
Abstract base class for all actions.
Definition SoAction.h:132
Abstract base class for all database nodes.
Definition SoNode.h:145
Used to write Open Inventor data files.
Definition SoOutput.h:186
Path that points to a list of hierarchical nodes.
Definition SoPath.h:187
Writes a scene graph to a file.
SoWriteAction()
Constructor.
SoWriteAction(SoOutput *out)
Constructor that takes an SoOutput to use for output.
SoOutput * getOutput() const
Returns reference to SoOutput instance in action.
int SbBool
Boolean type.
Definition SbBase.h:87