Alembic 1.8.11

Loading...
Searching...
No Matches
OGroup.h
1//-*****************************************************************************
2//
3// Copyright (c) 2013,
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 Industrial Light & Magic nor the names of
19// its contributors may be used to endorse or promote products derived
20// from this software without specific prior written permission.
21//
22// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33//
34//-*****************************************************************************
35
36#ifndef Alembic_Ogawa_OGroup_h
37#define Alembic_Ogawa_OGroup_h
38
39#include <Alembic/Util/Export.h>
40#include <Alembic/Ogawa/Foundation.h>
41#include <Alembic/Ogawa/OStream.h>
42#include <Alembic/Ogawa/OData.h>
43
44 namespace Alembic {
45 namespace Ogawa {
46 namespace ALEMBIC_VERSION_NS {
47
48 class OGroup;
49 typedef Alembic::Util::shared_ptr< OGroup > OGroupPtr;
50
51 class ALEMBIC_EXPORT OGroup
52 : public Alembic::Util::enable_shared_from_this< OGroup >
53{
54 public:
55 ~OGroup();
56
57 // create a group and add it as a child to this group
58 OGroupPtr addGroup();
59
60 // write the data stream and add it as a child to this group
61 ODataPtr addData(Alembic::Util::uint64_t iSize, const void * iData);
62
63 // write data streams from multiple sources as one continuous data stream
64 // and add it as a child to this group
65 ODataPtr addData(Alembic::Util::uint64_t iNumData,
66 const Alembic::Util::uint64_t * iSizes,
67 const void ** iDatas);
68
69 // write a data stream but DON'T add it as a child to this group
70 // If ODataPtr isn't added to this or any other group, you will
71 // end up abandoning it within the file and waste disk space.
72 ODataPtr createData(Alembic::Util::uint64_t iSize, const void * iData);
73
74 // write data streams as one continuous data stream but DON'T add it as a
75 // child to this group.
76 // If ODataPtr isn't added to this or any other group, you will
77 // end up abandoning it within the file and waste disk space.
78 ODataPtr createData(Alembic::Util::uint64_t iNumData,
79 const Alembic::Util::uint64_t * iSizes,
80 const void ** iDatas);
81
82 // reference existing data
83 void addData(ODataPtr iData);
84
85 // reference an existing group
86 void addGroup(OGroupPtr iGroup);
87
88 // convenience function for adding a default NULL group
89 void addEmptyGroup();
90
91 // convenience function for adding empty data
92 void addEmptyData();
93
94 // can no longer add any more children, we can still update them
95 // via the replace calls though
96 void freeze();
97
98 bool isFrozen();
99
100 Alembic::Util::uint64_t getNumChildren() const;
101
102 bool isChildGroup(Alembic::Util::uint64_t iIndex) const;
103
104 bool isChildData(Alembic::Util::uint64_t iIndex) const;
105
106 bool isChildEmptyGroup(Alembic::Util::uint64_t iIndex) const;
107
108 bool isChildEmptyData(Alembic::Util::uint64_t iIndex) const;
109
110 void replaceData(Alembic::Util::uint64_t iIndex, ODataPtr iData);
111
112 // currently I'm going to leave this out, because a bad implementation
113 // could cause all sorts of subtle race conditions when unfrozen children
114 // are suddenly frozen. It may also not be necessary (you can still
115 // reference an existing group)
116 // if this is necessary, an easy compromise might be that iGroup HAS to
117 // be frozen, much like how replaceData deals with something implicitly
118 // frozen
119 //void replaceGroup(Alembic::Util::uint64_t iIndex, OGroupPtr iGroup);
120
121 private:
122 friend class OArchive;
123 OGroup(OStreamPtr iStream);
124
125 OGroup(OGroupPtr iParent, Alembic::Util::uint64_t iIndex);
126
127 class PrivateData;
128 Alembic::Util::unique_ptr< PrivateData > mData;
129};
130
131} // End namespace ALEMBIC_VERSION_NS
132
133 using namespace ALEMBIC_VERSION_NS;
134
135} // End namespace Ogawa
136
137} // End namespace Alembic
138
139#endif
Alembic::Ogawa::ALEMBIC_VERSION_NS::OGroup::PrivateData
Definition OGroup.cpp:49
Alembic::Ogawa::ALEMBIC_VERSION_NS::OGroup
Definition OGroup.h:53
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39