HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ArrayPropertyWriter.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2009-2011,
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_ArrayPropertyWriter_h_
38 #define _Alembic_AbcCoreAbstract_ArrayPropertyWriter_h_
39 
40 #include <Alembic/Util/Export.h>
44 
45 namespace Alembic {
46 namespace AbcCoreAbstract {
47 namespace ALEMBIC_VERSION_NS {
48 
49 //-*****************************************************************************
50 //! An Array Property is a Rank N (usually 1-3) property which has a
51 //! multidimensional array of identically typed values for each
52 //! sample. This is distinguished from a Simple Property, which has a
53 //! single element per sample, and requires less sophisticated
54 //! resource management.
56  : public BasePropertyWriter
57 {
58 public:
59  //! Virtual destructor
60  //! ...
61  virtual ~ArrayPropertyWriter();
62 
63  //-*************************************************************************
64  // NEW FUNCTIONS
65  //-*************************************************************************
66 
67  //! Sets a sample
68  //!
69  //! This takes a read-only ArraySample by const reference. The class
70  //! will make an internal copy (or the functional equivalent of ),
71  //! and will not use that memory block outside the scope of this
72  //! function call.
73  //!
74  //! Arrays of std::string and std::wstring are assumed to be
75  //! treated just like regular data elements.
76  virtual void setSample( const ArraySample & iSamp ) = 0;
77 
78  //! Set the next sample to equal the previous sample.
79  //! An important feature!
80  virtual void setFromPreviousSample() = 0;
81 
82  //! Return the number of samples that have been written so far.
83  //! This changes as samples are written.
84  virtual size_t getNumSamples() = 0;
85 
86  //! Changes the TimeSampling used by this property.
87  //! If the TimeSampling is changed to Acyclic and the number of samples
88  //! currently set is more than the number of times provided in the Acyclic
89  //! TimeSampling, an exception will be thrown.
90  virtual void setTimeSamplingIndex( uint32_t iIndex ) = 0;
91 };
92 
93 } // End namespace ALEMBIC_VERSION_NS
94 
95 using namespace ALEMBIC_VERSION_NS;
96 
97 } // End namespace AbcCoreAbstract
98 } // End namespace Alembic
99 
100 #endif
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104