Alembic Version 1.1

ObjectWriter.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_ObjectWriter_h
38#define Alembic_AbcCoreAbstract_ObjectWriter_h
39
40#include <Alembic/Util/Export.h>
41#include <Alembic/AbcCoreAbstract/Foundation.h>
42#include <Alembic/AbcCoreAbstract/ForwardDeclarations.h>
43#include <Alembic/AbcCoreAbstract/ObjectHeader.h>
44
45 namespace Alembic {
46 namespace AbcCoreAbstract {
47 namespace ALEMBIC_VERSION_NS {
48
49//-*****************************************************************************
55 class ALEMBIC_EXPORT ObjectWriter
56 : private Alembic::Util::noncopyable
57{
58 public:
61 virtual ~ObjectWriter();
62
63 //-*************************************************************************
64 // NEW FUNCTIONS
65 //-*************************************************************************
66
71 virtual const ObjectHeader & getHeader() const = 0;
72
77 const std::string &getName() const
78 { return getHeader().getName(); }
79
83 const std::string &getFullName() const
84 { return getHeader().getFullName(); }
85
95 const MetaData &getMetaData() const
96 { return getHeader().getMetaData(); }
97
110 virtual ArchiveWriterPtr getArchive() = 0;
111
121 virtual ObjectWriterPtr getParent() = 0;
122
127 virtual CompoundPropertyWriterPtr getProperties() = 0;
128
129 //-*************************************************************************
130 // CHILDREN
131 //-*************************************************************************
132
137 virtual size_t getNumChildren() = 0;
138
142 virtual const ObjectHeader & getChildHeader( size_t i ) = 0;
143
151 virtual const ObjectHeader *
152 getChildHeader( const std::string &iName ) = 0;
153
165 ObjectWriterPtr getChild( size_t i );
166
170 virtual ObjectWriterPtr getChild( const std::string &iName ) = 0;
171
176 virtual ObjectWriterPtr createChild( const ObjectHeader &iHeader ) = 0;
177
180 virtual ObjectWriterPtr asObjectPtr() = 0;
181};
182
183} // End namespace ALEMBIC_VERSION_NS
184
185 using namespace ALEMBIC_VERSION_NS;
186
187} // End namespace AbcCoreAbstract
188} // End namespace Alembic
189
190#endif
191
Foundation.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition: Export.h:51
ForwardDeclarations.h
ObjectHeader.h
ALEMBIC_VERSION_NS
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::MetaData
Definition: MetaData.h:60
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectHeader
Definition: ObjectHeader.h:52
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter
Definition: ObjectWriter.h:57
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getChildHeader
virtual const ObjectHeader * getChildHeader(const std::string &iName)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getName
const std::string & getName() const
Definition: ObjectWriter.h:77
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getProperties
virtual CompoundPropertyWriterPtr getProperties()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getFullName
const std::string & getFullName() const
Definition: ObjectWriter.h:83
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getParent
virtual ObjectWriterPtr getParent()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::createChild
virtual ObjectWriterPtr createChild(const ObjectHeader &iHeader)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::asObjectPtr
virtual ObjectWriterPtr asObjectPtr()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getMetaData
const MetaData & getMetaData() const
Definition: ObjectWriter.h:95
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getNumChildren
virtual size_t getNumChildren()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getChildHeader
virtual const ObjectHeader & getChildHeader(size_t i)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getHeader
virtual const ObjectHeader & getHeader() const =0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getArchive
virtual ArchiveWriterPtr getArchive()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::~ObjectWriter
virtual ~ObjectWriter()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getChild
virtual ObjectWriterPtr getChild(const std::string &iName)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriter::getChild
ObjectWriterPtr getChild(size_t i)
Alembic::Util::ALEMBIC_VERSION_NS::noncopyable
Definition: Foundation.h:115
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriterPtr
Alembic::Util::shared_ptr< ArchiveWriter > ArchiveWriterPtr
Smart Ptrs to Writers.
Definition: ForwardDeclarations.h:81
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriterPtr
Alembic::Util::shared_ptr< CompoundPropertyWriter > CompoundPropertyWriterPtr
Definition: ForwardDeclarations.h:83
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriterPtr
Alembic::Util::shared_ptr< ObjectWriter > ObjectWriterPtr
Definition: ForwardDeclarations.h:82
Alembic
Alembic namespace ...
Definition: ArchiveInfo.h:46