HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
IScalarProperty.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 #ifndef Alembic_Abc_IScalarProperty_h
37 #define Alembic_Abc_IScalarProperty_h
38 
39 #include <Alembic/Util/Export.h>
40 #include <Alembic/Abc/Foundation.h>
41 #include <Alembic/Abc/Base.h>
42 #include <Alembic/Abc/Argument.h>
46 
47 namespace Alembic {
48 namespace Abc {
49 namespace ALEMBIC_VERSION_NS {
50 
51 //-*****************************************************************************
53  : public IBasePropertyT<AbcA::ScalarPropertyReaderPtr>
54 {
55 public:
56  //! By convention we always define this_type in Abc classes
57  //! Used by unspecified-bool-type conversion below
59 
60  //-*************************************************************************
61  // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
62  //-*************************************************************************
63 
64  //! The default constructor creates an empty IScalarProperty function set.
65  //! ...
67 
68  //! This constructor creates a new scalar property reader.
69  //! The first argument is the parent ICompundProperty, from which the error
70  //! handler policy for inheritance is also derived. The remaining optional
71  //! arguments can be used to override the ErrorHandlerPolicy, and that's it.
72  IScalarProperty( const ICompoundProperty & iParent,
73  const std::string &iName,
74 
75  const Argument &iArg0 = Argument() );
76 
77  //! This attaches an IScalarProperty wrapper around an existing
78  //! ScalarPropertyReaderPtr, with an optional error handling policy.
80  //! The pointer
81  //! ...
83 
84  //! Optional error handling policy
85  //! ...
86  const Argument &iArg0 = Argument() )
88  GetErrorHandlerPolicy( iPtr, iArg0 ) )
89  {}
90 
91  // Deprecated in favor of the constructor above
94  WrapExistingFlag iWrapFlag,
95  const Argument &iArg0 = Argument() )
97  GetErrorHandlerPolicy( iPtr, iArg0 ) )
98  {}
99 
100  //! Default copy constructor used
101  //! Default assignment operator used.
102 
103  //! Destructor
104  //! ...
105  ~IScalarProperty();
106 
107  //-*************************************************************************
108  // SCALAR PROPERTY READER FUNCTIONALITY
109  //-*************************************************************************
110 
111  //! Return the number of samples contained in the property.
112  //! This can be any number, including zero.
113  //! This returns the number of samples that were written, independently
114  //! of whether or not they were constant.
115  size_t getNumSamples() const;
116 
117  //! Ask if we're constant - no change in value amongst samples,
118  //! regardless of the time sampling.
119  bool isConstant() const;
120 
121  //! Time information.
122  //! This will be valid regardless of TimeSamplingType or number of samples.
123  AbcA::TimeSamplingPtr getTimeSampling() const;
124 
125  //! Get a sample into the address of a datum.
126  //! ...
127  void get( void *oSample,
128  const ISampleSelector &iSS = ISampleSelector() ) const;
129 
130  //! Return the parent compound property, handily wrapped in a
131  //! ICompoundProperty wrapper.
132  ICompoundProperty getParent() const;
133 
134 private:
135  void init( AbcA::CompoundPropertyReaderPtr iParentObject,
136  const std::string &iName,
137 
138  ErrorHandler::Policy iParentPolicy,
139 
140  const Argument &iArg0 );
141 };
142 
143 } // End namespace ALEMBIC_VERSION_NS
144 
145 using namespace ALEMBIC_VERSION_NS;
146 
147 } // End namespace Abc
148 } // End namespace Alembic
149 
150 #endif
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
IScalarProperty(AbcA::ScalarPropertyReaderPtr iPtr, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument())
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::Util::shared_ptr< CompoundPropertyReader > CompoundPropertyReaderPtr
ErrorHandler::Policy GetErrorHandlerPolicy(SOMETHING iSomething, const Argument &iArg0, const Argument &iArg1=Argument(), const Argument &iArg2=Argument(), const Argument &iArg3=Argument())
Definition: Argument.h:242
IScalarProperty(AbcA::ScalarPropertyReaderPtr iPtr, const Argument &iArg0=Argument())
Alembic::Util::shared_ptr< ScalarPropertyReader > ScalarPropertyReaderPtr
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105