HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ArchiveWriter.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2009-2012,
4 // Sony Pictures Imageworks Inc. and
5 // Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
6 //
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are
11 // met:
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above
15 // copyright notice, this list of conditions and the following disclaimer
16 // in the documentation and/or other materials provided with the
17 // distribution.
18 // * Neither the name of Sony Pictures Imageworks, nor
19 // Industrial Light & Magic, nor the names of their contributors may be used
20 // to endorse or promote products derived from this software without specific
21 // prior written permission.
22 //
23 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 //
35 //-*****************************************************************************
36 
37 #ifndef _Alembic_AbcCoreAbstract_ArchiveWriter_h_
38 #define _Alembic_AbcCoreAbstract_ArchiveWriter_h_
39 
40 #include <Alembic/Util/Export.h>
44 
45 namespace Alembic {
46 namespace AbcCoreAbstract {
47 namespace ALEMBIC_VERSION_NS {
48 
49 //-*****************************************************************************
50 //! In order for an implementation to concretely provide a starting point
51 //! for using the abstract API, a single "explicitly linked" function to
52 //! start from is necessary. That function will return, in the case of writing,
53 //! an ArchiveWriterPtr. This typedef provides a signature that such a function
54 //! should adhere to. This idiom is a workaround for the lack of virtual
55 //! constructors in C++, and to avoid creating another class (such as
56 //! "Implementation" or something similar)
57 namespace IllustrationOnly {
59 {
60  // Create an archive writer with the given file name and meta data.
61  ArchiveWriterPtr operator()( const std::string &iFileName,
62  const MetaData &iMetaData );
63 };
64 } // End namespace IllustrationOnly
65 
66 //-*****************************************************************************
67 //! The Archive is "the file". It has a single object, it's top object.
68 //! It has no properties, but does have metadata.
71 {
72 protected:
74  : m_compressionHint( -1 ) {}
75 
76 public:
77  //! Virtual destructor
78  //! ...
79  virtual ~ArchiveWriter();
80 
81  //-*************************************************************************
82  // NEW FUNCTIONS
83  //-*************************************************************************
84 
85  //! Return the archive (file) name. This is the name of the file
86  //! which the archive writer is associated with.
87  virtual const std::string &getName() const = 0;
88 
89  //! The meta data of the archive is the same as the meta data
90  //! of the top-level object writer.
91  virtual const MetaData &getMetaData() const = 0;
92 
93  //! Get the top object writer.
94  //! Archives always have this single top-level object created
95  //! automatically.
96  virtual ObjectWriterPtr getTop() = 0;
97 
98  //! Get the compression applied to array properties.
99  //! Implementations are free to disregard this.
100  int8_t getCompressionHint() const { return m_compressionHint; }
101 
102  //! Set the compression applied to array properties.
103  //! Implementations are free to disregard this.
104  //! -1 means off, 0 means "litte", where 9 means "alot"
105  void setCompressionHint( int8_t iCh )
106  {
107  m_compressionHint = iCh < -1 ? -1 :
108  ( iCh > 9 ? 9 : iCh );
109  }
110 
111  //! Return self
112  //! May sometimes be spoofed.
113  virtual ArchiveWriterPtr asArchivePtr() = 0;
114 
115  //! Adds the TimeSampling to the Archive TimeSampling pool.
116  //! If the TimeSampling already exists in the pool, the index for the match
117  //! should be returned.
118  //! index 0 is automatically reserved for uniform time sampling with a start
119  //! time of 0 and time per cycle of 1 (aka identity sampling)
120  virtual uint32_t addTimeSampling( const TimeSampling & iTs ) = 0;
121 
122  //! Returns the TimeSampling at a given index.
123  //! index 0 is automatically reserved for uniform time sampling with a start
124  //! time of 0 and time per cycle of 1 (aka identity sampling)
125  virtual TimeSamplingPtr getTimeSampling( uint32_t iIndex ) = 0;
126 
127  //! Returns the total number of TimeSamplingPtrs in the Archive
128  //! TimeSampling pool.
129  virtual uint32_t getNumTimeSamplings() = 0;
130 
131  //! Returns the maximum number of samples written for the TimeSampling at
132  //! the given index. If an illegal iIndex is specified, INDEX_UNKNOWN
133  //! will be returned.
134  virtual index_t getMaxNumSamplesForTimeSamplingIndex( uint32_t iIndex ) = 0;
135 
136  //! Sets the maximum number of samples written for the TimeSampling at
137  //! the given index. You normally don't need to call this as the
138  //! properties will call it at the appropriate time.
139  virtual void setMaxNumSamplesForTimeSamplingIndex( uint32_t iIndex,
140  index_t iMaxIndex ) = 0;
141 
142 private:
143  int8_t m_compressionHint;
144 };
145 
146 } // End namespace ALEMBIC_VERSION_NS
147 
148 using namespace ALEMBIC_VERSION_NS;
149 
150 } // End namespace AbcCoreAbstract
151 } // End namespace Alembic
152 
153 #endif
154 
Alembic::Util::shared_ptr< ObjectWriter > ObjectWriterPtr
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::Util::shared_ptr< ArchiveWriter > ArchiveWriterPtr
Smart Ptrs to Writers.
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104