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_AbcCoreHDF5_SprImpl_h
38 #define Alembic_AbcCoreHDF5_SprImpl_h
39 
40 #include <Alembic/AbcCoreHDF5/Foundation.h>
41 #include <Alembic/AbcCoreHDF5/SimplePrImpl.h>
42 
43 namespace Alembic {
44 namespace AbcCoreHDF5 {
45 namespace ALEMBIC_VERSION_NS {
46 
47 //-*****************************************************************************
48 // The Scalar Property Reader fills up bytes corresponding to memory for
49 // a single scalar sample at a particular index.
50 class SprImpl
51     : public SimplePrImpl<AbcA::ScalarPropertyReader,
52                           SprImpl,
53                           void*>
54     , public Alembic::Util::enable_shared_from_this<SprImpl>
55 {
56 public:
SprImpl(AbcA::CompoundPropertyReaderPtr iParent,H5Node & iParentGroup,PropertyHeaderPtr iHeader,uint32_t iNumSamples,uint32_t iFirstChangedIndex,uint32_t iLastChangedIndex)57     SprImpl( AbcA::CompoundPropertyReaderPtr iParent,
58              H5Node & iParentGroup,
59              PropertyHeaderPtr iHeader,
60              uint32_t iNumSamples,
61              uint32_t iFirstChangedIndex,
62              uint32_t iLastChangedIndex )
63       : SimplePrImpl<AbcA::ScalarPropertyReader, SprImpl, void*>
64         ( iParent, iParentGroup, iHeader, iNumSamples, iFirstChangedIndex,
65           iLastChangedIndex )
66     {
67         if ( m_header->getPropertyType() != AbcA::kScalarProperty )
68         {
69             ABCA_THROW( "Attempted to create a ScalarPropertyReader from a "
70                         "non-scalar property type" );
71         }
72     }
73 
74     virtual AbcA::ScalarPropertyReaderPtr asScalarPtr();
75 
76 protected:
77     friend class SimplePrImpl<AbcA::ScalarPropertyReader,
78                               SprImpl,
79                               void*>;
80 
81     // This function is called by SimplePrImpl to provide the actual
82     // property reading.
83     // It will dispatch its work out to different read utils, based
84     // on the type of the property.
85     void readSample( hid_t iGroup,
86                      const std::string &iSampleName,
87                      index_t iSampleIndex,
88                      void *oSampleBytes );
89 
90     //-*************************************************************************
91     // This function is called by SimplePrImpl, scalar props do not have keys.
readKey(hid_t iGroup,const std::string & iSampleName,AbcA::ArraySampleKey & oSamplePtr)92     bool readKey( hid_t iGroup,
93                   const std::string &iSampleName,
94                   AbcA::ArraySampleKey & oSamplePtr ) { return false; }
95 
96 };
97 
98 } // End namespace ALEMBIC_VERSION_NS
99 
100 using namespace ALEMBIC_VERSION_NS;
101 
102 } // End namespace AbcCoreHDF5
103 } // End namespace Alembic
104 
105 #endif
106