HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
IGroup.h
Go to the documentation of this file.
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_IGroup_h_
37 #define _Alembic_Ogawa_IGroup_h_
38 
39 #include <Alembic/Util/Export.h>
41 #include <Alembic/Ogawa/IStreams.h>
42 #include <Alembic/Ogawa/IData.h>
43 
44 namespace Alembic {
45 namespace Ogawa {
46 namespace ALEMBIC_VERSION_NS {
47 
48 class IGroup;
49 typedef Alembic::Util::shared_ptr< IGroup > IGroupPtr;
50 
52 {
53 public:
54  ~IGroup();
55 
56  IGroupPtr getGroup(Alembic::Util::uint64_t iIndex, bool iLight,
57  std::size_t iThreadIndex);
58 
59  IDataPtr getData(Alembic::Util::uint64_t iIndex, std::size_t iThreadIndex);
60 
61  Alembic::Util::uint64_t getNumChildren() const;
62 
63  bool isChildGroup(Alembic::Util::uint64_t iIndex) const;
64  bool isChildData(Alembic::Util::uint64_t iIndex) const;
65 
66  bool isEmptyChildGroup(Alembic::Util::uint64_t iIndex) const;
67  bool isEmptyChildData(Alembic::Util::uint64_t iIndex) const;
68 
69  bool isLight() const;
70 
71 private:
72  friend class IArchive;
73  IGroup(IStreamsPtr iStreams, Alembic::Util::uint64_t iPos, bool iLight,
74  std::size_t iThreadIndex);
75 
76  class PrivateData;
77  Alembic::Util::unique_ptr< PrivateData > mData;
78 };
79 
80 } // End namespace ALEMBIC_VERSION_NS
81 
82 using namespace ALEMBIC_VERSION_NS;
83 
84 } // End namespace Ogawa
85 
86 } // End namespace Alembic
87 
88 #endif
Alembic::Util::shared_ptr< IData > IDataPtr
Definition: IData.h:71
Alembic::Util::shared_ptr< IStreams > IStreamsPtr
Definition: IStreams.h:73
#define ALEMBIC_EXPORT
Definition: Export.h:51
Alembic::Util::shared_ptr< IGroup > IGroupPtr
Definition: IGroup.h:48
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104