Alembic: AbcCoreAbstract/ArchiveWriter.h Source File

Alembic 1.8.11

Loading...
Searching...
No Matches
ArchiveWriter.h
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>
41#include <Alembic/AbcCoreAbstract/Foundation.h>
42#include <Alembic/AbcCoreAbstract/MetaData.h>
43#include <Alembic/AbcCoreAbstract/ForwardDeclarations.h>
44
45namespace Alembic {
46namespace AbcCoreAbstract {
47namespace ALEMBIC_VERSION_NS {
48
49//-*****************************************************************************
57namespace IllustrationOnly {
58 struct ALEMBIC_EXPORT ArchiveWriterConstructor
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//-*****************************************************************************
69 class ALEMBIC_EXPORT ArchiveWriter
70 : private Alembic::Util::noncopyable
71{
72protected:
73 ArchiveWriter()
74 : m_compressionHint( -1 ) {}
75
76public:
79 virtual ~ArchiveWriter();
80
81 //-*************************************************************************
82 // NEW FUNCTIONS
83 //-*************************************************************************
84
87 virtual const std::string &getName() const = 0;
88
91 virtual const MetaData &getMetaData() const = 0;
92
96 virtual ObjectWriterPtr getTop() = 0;
97
100 int8_t getCompressionHint() const { return m_compressionHint; }
101
105 void setCompressionHint( int8_t iCh )
106 {
107 m_compressionHint = iCh < -1 ? -1 :
108 ( iCh > 9 ? 9 : iCh );
109 }
110
113 virtual ArchiveWriterPtr asArchivePtr() = 0;
114
120 virtual uint32_t addTimeSampling( const TimeSampling & iTs ) = 0;
121
125 virtual TimeSamplingPtr getTimeSampling( uint32_t iIndex ) = 0;
126
129 virtual uint32_t getNumTimeSamplings() = 0;
130
134 virtual index_t getMaxNumSamplesForTimeSamplingIndex( uint32_t iIndex ) = 0;
135
139 virtual void setMaxNumSamplesForTimeSamplingIndex( uint32_t iIndex,
140 index_t iMaxIndex ) = 0;
141
142private:
143 int8_t m_compressionHint;
144};
145
146} // End namespace ALEMBIC_VERSION_NS
147
148using namespace ALEMBIC_VERSION_NS;
149
150} // End namespace AbcCoreAbstract
151} // End namespace Alembic
152
153#endif
154
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getTop
virtual ObjectWriterPtr getTop()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getName
virtual const std::string & getName() const =0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::addTimeSampling
virtual uint32_t addTimeSampling(const TimeSampling &iTs)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::setCompressionHint
void setCompressionHint(int8_t iCh)
Definition ArchiveWriter.h:105
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getMetaData
virtual const MetaData & getMetaData() const =0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::setMaxNumSamplesForTimeSamplingIndex
virtual void setMaxNumSamplesForTimeSamplingIndex(uint32_t iIndex, index_t iMaxIndex)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getCompressionHint
int8_t getCompressionHint() const
Definition ArchiveWriter.h:100
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getMaxNumSamplesForTimeSamplingIndex
virtual index_t getMaxNumSamplesForTimeSamplingIndex(uint32_t iIndex)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::asArchivePtr
virtual ArchiveWriterPtr asArchivePtr()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getNumTimeSamplings
virtual uint32_t getNumTimeSamplings()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getTimeSampling
virtual TimeSamplingPtr getTimeSampling(uint32_t iIndex)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::MetaData
Definition MetaData.h:60
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling
Definition TimeSampling.h:58
Alembic::Util::ALEMBIC_VERSION_NS::noncopyable
Definition Foundation.h:98
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::IllustrationOnly
Definition ArchiveReader.h:59
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::IllustrationOnly::ArchiveWriterConstructor
Definition ArchiveWriter.h:59