Cortex  10.0.0-a4
ROP_SceneCacheWriter.h
1 //
3 // Copyright (c) 2013-2014, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IECOREHOUDINI_ROPSCENECACHEWRITER_H
36 #define IECOREHOUDINI_ROPSCENECACHEWRITER_H
37 
38 #include "ROP/ROP_Node.h"
39 
40 #include "IECore/SceneInterface.h"
41 
42 #include "IECoreHoudini/SceneCacheNode.h"
43 
44 namespace IECoreHoudini
45 {
46 
48 class ROP_SceneCacheWriter : public ROP_Node
49 {
50  public :
51 
52  ROP_SceneCacheWriter( OP_Network *net, const char *name, OP_Operator *op );
53  virtual ~ROP_SceneCacheWriter();
54 
55  static const char *typeName;
56 
57  static PRM_Name pFile;
58  static PRM_Name pRootObject;
59  static PRM_Name pForceObjects;
60 
61  static PRM_Default fileDefault;
62  static PRM_Default rootObjectDefault;
63  static PRM_SpareData forceObjectsSpareData;
64 
65  static OP_Node *create( OP_Network *net, const char *name, OP_Operator *op );
66  static OP_TemplatePair *buildParameters();
67 
68  protected :
69 
70  virtual int startRender( int nframes, fpreal s, fpreal e );
71  virtual ROP_RENDER_CODE renderFrame( fpreal time, UT_Interrupt *boss );
72  virtual ROP_RENDER_CODE endRender();
73 
74  virtual bool updateParmsFlags();
75 
78  virtual ROP_RENDER_CODE doWrite( const IECore::SceneInterface *liveScene, IECore::SceneInterface *outScene, double time, UT_Interrupt *progress );
79 
80  private :
81 
82  static const IECore::SceneInterface::Name &changingHierarchyAttribute;
83 
84  bool linked( const std::string &file ) const;
85 
86  enum Mode
87  {
88  NaturalLink = 0,
89  ForcedLink,
90  NaturalExpand,
91  ForcedExpand
92  };
93 
94  IECoreHoudini::LiveScenePtr m_liveHoudiniScene;
95  IECore::ConstSceneInterfacePtr m_liveScene;
96  IECore::SceneInterfacePtr m_outScene;
97  UT_StringMMPattern *m_forceFilter;
98 
99  double m_startTime;
100  double m_endTime;
101 
102 };
103 
104 } // namespace IECoreHoudini
105 
106 #endif // IECOREHOUDINI_ROPSCENECACHEWRITER_H
The IECoreHoudini namespace holds all the functionality of libIECoreHoudini.
Definition: CoreHoudini.h:51
Definition: SceneInterface.h:69
Definition: InternedString.h:55
virtual ROP_RENDER_CODE doWrite(const IECore::SceneInterface *liveScene, IECore::SceneInterface *outScene, double time, UT_Interrupt *progress)
Class for writing SceneCache files based on an existing Houdini hierarchy.
Definition: ROP_SceneCacheWriter.h:48