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_AbcCoreAbstract_BasePropertyWriter_h 38 #define Alembic_AbcCoreAbstract_BasePropertyWriter_h 39 40 #include <Alembic/Util/Export.h> 41 #include <Alembic/AbcCoreAbstract/Foundation.h> 42 #include <Alembic/AbcCoreAbstract/ForwardDeclarations.h> 43 #include <Alembic/AbcCoreAbstract/PropertyHeader.h> 44 45 namespace Alembic { 46 namespace AbcCoreAbstract { 47 namespace ALEMBIC_VERSION_NS { 48 49 //-***************************************************************************** 50 //! The BasePropertyWriter is the base class for all properties, 51 //! from Simple (which encompasses Scalar and Array properties) to 52 //! Compound. The functions here establish the things which all properties 53 //! have in common - name, metaData, propertyType, as well as 54 //! upcasting capabilities. We don't want to rely on dynamic_cast - it's 55 //! slow and potentially has problems across DSO interfaces. 56 class ALEMBIC_EXPORT BasePropertyWriter 57 : private Alembic::Util::noncopyable 58 { 59 public: 60 //! Virtual destructor 61 //! ... 62 virtual ~BasePropertyWriter(); 63 64 //-************************************************************************* 65 // NEW FUNCTIONS 66 //-************************************************************************* 67 68 //! Properties are created with a collection of metadata that is stored 69 //! in a lightweight structure called PropertyHeader. 70 //! This returns a constant reference to the PropertyHeader which 71 //! was given upon creation. 72 virtual const PropertyHeader & getHeader() const = 0; 73 74 //! All properties have a name, which is unique amongst its siblings 75 //! in the compund property they all live in. This is the name that 76 //! was given when the property was created, and is part of the property 77 //! header. getName()78 const std::string &getName() const 79 { return getHeader().getName(); } 80 81 //! There are three types of abstract properties. 82 //! They are Scalar, Array, and Compound properties. This function 83 //! returns an enum PropertyType which indicates which property 84 //! type is returned. This is simply a convenience function which 85 //! returns data from the PropertyHeader. getPropertyType()86 PropertyType getPropertyType() const 87 { return getHeader().getPropertyType(); } 88 89 //! Convenience to return whether the property is scalar. 90 //! Same as getPropertyType() == kScalarProperty isScalar()91 bool isScalar() const { return getPropertyType() == kScalarProperty; } 92 93 //! Convenience to return whether the property is array. 94 //! Same as getPropertyType() == kArrayProperty isArray()95 bool isArray() const { return getPropertyType() == kArrayProperty; } 96 97 //! Convenience to return whether the property is compound. 98 //! Same as getPropertyType() == kCompoundProperty isCompound()99 bool isCompound() const { return getPropertyType() == kCompoundProperty; } 100 101 //! Convenience to return whether the property is simple (non-compound) 102 //! Same as getPropertyType() != kCompoundProperty isSimple()103 bool isSimple() const { return !isCompound(); } 104 105 //! All properties have MetaData. This just returns the 106 //! MetaData portion of the header that was used in creation. getMetaData()107 const MetaData &getMetaData() const 108 { return getHeader().getMetaData(); } 109 110 //! Non-compound properties have a DataType. It is an error 111 //! to call this function for CompoundProperties, and an exception will 112 //! be thrown. This is a convenience function which just returns the 113 //! DataType from the header that was used in creation. getDataType()114 const DataType &getDataType() const 115 { return getHeader().getDataType(); } 116 117 //! Non-compound properties have a TimeSampling. It is an error 118 //! to call this function for CompoundProperties, and an exception will 119 //! be thrown. This is a convenience function which just returns the 120 //! TimeSamplingType from the header that was used in creation. getTimeSampling()121 TimeSamplingPtr getTimeSampling() const 122 { return getHeader().getTimeSampling(); } 123 124 //! All properties have an object that owns them, and in order to 125 //! ensure the object stays alive as long as the properties do, they 126 //! retain a shared pointer to their object. 127 virtual ObjectWriterPtr getObject() = 0; 128 129 //! Most properties live in a compound property. (Except for 130 //! the top-compound property in any object) 131 //! This returns a pointer to the parent compound property. 132 virtual CompoundPropertyWriterPtr getParent() = 0; 133 134 //! Up-cast this base property to a ScalarProperty, if such an 135 //! upcast is valid. This can be checked with the \ref isScalar() 136 //! function. If the upcast is not valid, an empty pointer will 137 //! be returned. This default implementation returns an empty 138 //! pointer. 139 virtual ScalarPropertyWriterPtr asScalarPtr(); 140 141 //! Up-cast this base property to an ArrayProperty, if such an 142 //! upcast is valid. This can be checked with the \ref isArray() 143 //! function. If the upcast is not valid, an empty pointer will 144 //! be returned. This default implementation returns an empty 145 //! pointer. 146 virtual ArrayPropertyWriterPtr asArrayPtr(); 147 148 //! Up-cast this base property to a CompoundProperty, if such an 149 //! upcast is valid. This can be checked with the \ref isCompound() 150 //! function. If the upcast is not valid, an empty pointer will 151 //! be returned. This default implementation returns an empty 152 //! pointer. 153 virtual CompoundPropertyWriterPtr asCompoundPtr(); 154 }; 155 156 } // End namespace ALEMBIC_VERSION_NS 157 158 using namespace ALEMBIC_VERSION_NS; 159 160 } // End namespace AbcCoreAbstract 161 } // End namespace Alembic 162 163 #endif 164