vrshoot

annotate libs/assimp/FBXProperties.h @ 0:b2f14e535253

initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
rev   line source
nuclear@0 1 /*
nuclear@0 2 Open Asset Import Library (assimp)
nuclear@0 3 ----------------------------------------------------------------------
nuclear@0 4
nuclear@0 5 Copyright (c) 2006-2012, assimp team
nuclear@0 6 All rights reserved.
nuclear@0 7
nuclear@0 8 Redistribution and use of this software in source and binary forms,
nuclear@0 9 with or without modification, are permitted provided that the
nuclear@0 10 following conditions are met:
nuclear@0 11
nuclear@0 12 * Redistributions of source code must retain the above
nuclear@0 13 copyright notice, this list of conditions and the
nuclear@0 14 following disclaimer.
nuclear@0 15
nuclear@0 16 * Redistributions in binary form must reproduce the above
nuclear@0 17 copyright notice, this list of conditions and the
nuclear@0 18 following disclaimer in the documentation and/or other
nuclear@0 19 materials provided with the distribution.
nuclear@0 20
nuclear@0 21 * Neither the name of the assimp team, nor the names of its
nuclear@0 22 contributors may be used to endorse or promote products
nuclear@0 23 derived from this software without specific prior
nuclear@0 24 written permission of the assimp team.
nuclear@0 25
nuclear@0 26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0 27 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0 28 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0 29 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0 30 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0 31 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0 32 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0 33 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0 34 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0 35 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0 36 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0 37
nuclear@0 38 ----------------------------------------------------------------------
nuclear@0 39 */
nuclear@0 40
nuclear@0 41 /** @file FBXProperties.h
nuclear@0 42 * @brief FBX dynamic properties
nuclear@0 43 */
nuclear@0 44 #ifndef INCLUDED_AI_FBX_PROPERTIES_H
nuclear@0 45 #define INCLUDED_AI_FBX_PROPERTIES_H
nuclear@0 46
nuclear@0 47 #include <map>
nuclear@0 48 #include <string>
nuclear@0 49
nuclear@0 50 namespace Assimp {
nuclear@0 51 namespace FBX {
nuclear@0 52
nuclear@0 53 class Element;
nuclear@0 54
nuclear@0 55
nuclear@0 56 /** Represents a dynamic property. Type info added by deriving classes,
nuclear@0 57 * see #TypedProperty.
nuclear@0 58 Example:
nuclear@0 59 @verbatim
nuclear@0 60 P: "ShininessExponent", "double", "Number", "",0.5
nuclear@0 61 @endvebatim
nuclear@0 62
nuclear@0 63 */
nuclear@0 64 class Property
nuclear@0 65 {
nuclear@0 66 protected:
nuclear@0 67
nuclear@0 68 Property();
nuclear@0 69
nuclear@0 70 public:
nuclear@0 71
nuclear@0 72 virtual ~Property();
nuclear@0 73
nuclear@0 74 public:
nuclear@0 75
nuclear@0 76 template <typename T>
nuclear@0 77 const T* As() const {
nuclear@0 78 return dynamic_cast<const T*>(this);
nuclear@0 79 }
nuclear@0 80 };
nuclear@0 81
nuclear@0 82
nuclear@0 83 template<typename T>
nuclear@0 84 class TypedProperty : public Property
nuclear@0 85 {
nuclear@0 86 public:
nuclear@0 87
nuclear@0 88 TypedProperty(const T& value)
nuclear@0 89 : value(value)
nuclear@0 90 {
nuclear@0 91 }
nuclear@0 92
nuclear@0 93 public:
nuclear@0 94
nuclear@0 95 const T& Value() const {
nuclear@0 96 return value;
nuclear@0 97 }
nuclear@0 98
nuclear@0 99 private:
nuclear@0 100 T value;
nuclear@0 101 };
nuclear@0 102
nuclear@0 103
nuclear@0 104 typedef std::fbx_unordered_map<std::string,const Property*> PropertyMap;
nuclear@0 105 typedef std::fbx_unordered_map<std::string,const Element*> LazyPropertyMap;
nuclear@0 106
nuclear@0 107 /** Represents a property table as can be found in the newer FBX files (Properties60, Properties70)*/
nuclear@0 108 class PropertyTable
nuclear@0 109 {
nuclear@0 110 public:
nuclear@0 111
nuclear@0 112 // in-memory property table with no source element
nuclear@0 113 PropertyTable();
nuclear@0 114
nuclear@0 115 PropertyTable(const Element& element, boost::shared_ptr<const PropertyTable> templateProps);
nuclear@0 116 ~PropertyTable();
nuclear@0 117
nuclear@0 118 public:
nuclear@0 119
nuclear@0 120 const Property* Get(const std::string& name) const;
nuclear@0 121
nuclear@0 122 // PropertyTable's need not be coupled with FBX elements so this can be NULL
nuclear@0 123 const Element* GetElement() const {
nuclear@0 124 return element;
nuclear@0 125 }
nuclear@0 126
nuclear@0 127 const PropertyTable* TemplateProps() const {
nuclear@0 128 return templateProps.get();
nuclear@0 129 }
nuclear@0 130
nuclear@0 131 private:
nuclear@0 132
nuclear@0 133 LazyPropertyMap lazyProps;
nuclear@0 134 mutable PropertyMap props;
nuclear@0 135 const boost::shared_ptr<const PropertyTable> templateProps;
nuclear@0 136 const Element* const element;
nuclear@0 137 };
nuclear@0 138
nuclear@0 139
nuclear@0 140 // ------------------------------------------------------------------------------------------------
nuclear@0 141 template <typename T>
nuclear@0 142 inline T PropertyGet(const PropertyTable& in, const std::string& name,
nuclear@0 143 const T& defaultValue,
nuclear@0 144 bool ignoreTemplate = false)
nuclear@0 145 {
nuclear@0 146 const Property* const prop = in.Get(name);
nuclear@0 147 if(!prop) {
nuclear@0 148 return defaultValue;
nuclear@0 149 }
nuclear@0 150
nuclear@0 151 // strong typing, no need to be lenient
nuclear@0 152 const TypedProperty<T>* const tprop = prop->As< TypedProperty<T> >();
nuclear@0 153 if(!tprop) {
nuclear@0 154 return defaultValue;
nuclear@0 155 }
nuclear@0 156
nuclear@0 157 return tprop->Value();
nuclear@0 158 }
nuclear@0 159
nuclear@0 160
nuclear@0 161 // ------------------------------------------------------------------------------------------------
nuclear@0 162 template <typename T>
nuclear@0 163 inline T PropertyGet(const PropertyTable& in, const std::string& name,
nuclear@0 164 bool& result,
nuclear@0 165 bool ignoreTemplate = false)
nuclear@0 166 {
nuclear@0 167 const Property* const prop = in.Get(name);
nuclear@0 168 if(!prop) {
nuclear@0 169 result = false;
nuclear@0 170 return T();
nuclear@0 171 }
nuclear@0 172
nuclear@0 173 // strong typing, no need to be lenient
nuclear@0 174 const TypedProperty<T>* const tprop = prop->As< TypedProperty<T> >();
nuclear@0 175 if(!tprop) {
nuclear@0 176 result = false;
nuclear@0 177 return T();
nuclear@0 178 }
nuclear@0 179
nuclear@0 180 result = true;
nuclear@0 181 return tprop->Value();
nuclear@0 182 }
nuclear@0 183
nuclear@0 184
nuclear@0 185 } //! FBX
nuclear@0 186 } //! Assimp
nuclear@0 187
nuclear@0 188 #endif //