HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Util.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2016,
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_AbcCoreLayer_Util_h
38 #define Alembic_AbcCoreLayer_Util_h
39 
42 #include <Alembic/Util/Export.h>
43 
44 namespace Alembic {
45 namespace AbcCoreLayer {
46 namespace ALEMBIC_VERSION_NS {
47 
48 // Convience functions for marking prune and replace on MetaData to be used
49 // with layering.
50 
51 //! Used to mark that an Alembic object or property is meant to be pruned
52 //! when read via AbcCoreLayer. Pruning an object or compound property will
53 //! also removes all of their children.
55  Alembic::AbcCoreAbstract::MetaData & oMetaData, bool shouldPrune );
56 
57 //! Used to mark that an Alembic object or property is meant to be replaced
58 //! when read via AbcCoreLayer. Replacing an object or compound property will
59 //! also replace all of the children encountered so far. Since pruning is more
60 //! destructive it trumps replace.
62  Alembic::AbcCoreAbstract::MetaData & oMetaData, bool shouldReplace );
63 
64 } // End namespace ALEMBIC_VERSION_NS
65 
66 using namespace ALEMBIC_VERSION_NS;
67 
68 } // End namespace AbcCoreLayer
69 } // End namespace Alembic
70 
71 #endif //_Alembic_AbcCoreLayer_Util_h_
ALEMBIC_EXPORT void SetPrune(Alembic::AbcCoreAbstract::MetaData &oMetaData, bool shouldPrune)
ALEMBIC_EXPORT void SetReplace(Alembic::AbcCoreAbstract::MetaData &oMetaData, bool shouldReplace)
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105