b624e13681
- Fixed bug with FBX so we can import material values from the document for PBR when using StingRay (not Arnold *yet*) - Adds more explicit errors and makes things simpler to read. Has more sanity checks to be sure things are working correctly - Lazy Properties fixed items not loading due to capital letter errors in FBX parser - Added debug tools to the materials so you know explicitly what material mapping is assigned to a texture and where it came from. (enable verbose printing to use this) - Fix broken material mappings and debug entries properly - Fix make embedded images properly detected - Spam less errors for unsupported shading models with materials. Future plans: - Arnold materials need converted to PBR model, if possible.
244 lines
9.6 KiB
C++
244 lines
9.6 KiB
C++
/*************************************************************************/
|
|
/* FBXProperties.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/*************************************************************************/
|
|
|
|
/*
|
|
Open Asset Import Library (assimp)
|
|
----------------------------------------------------------------------
|
|
|
|
Copyright (c) 2006-2019, assimp team
|
|
|
|
|
|
All rights reserved.
|
|
|
|
Redistribution and use of this software in source and binary forms,
|
|
with or without modification, are permitted provided that the
|
|
following conditions are met:
|
|
|
|
* Redistributions of source code must retain the above
|
|
copyright notice, this list of conditions and the
|
|
following disclaimer.
|
|
|
|
* Redistributions in binary form must reproduce the above
|
|
copyright notice, this list of conditions and the
|
|
following disclaimer in the documentation and/or other
|
|
materials provided with the distribution.
|
|
|
|
* Neither the name of the assimp team, nor the names of its
|
|
contributors may be used to endorse or promote products
|
|
derived from this software without specific prior
|
|
written permission of the assimp team.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
----------------------------------------------------------------------
|
|
*/
|
|
|
|
/** @file FBXProperties.cpp
|
|
* @brief Implementation of the FBX dynamic properties system
|
|
*/
|
|
|
|
#include "FBXProperties.h"
|
|
#include "FBXDocumentUtil.h"
|
|
#include "FBXParser.h"
|
|
#include "FBXTokenizer.h"
|
|
|
|
namespace FBXDocParser {
|
|
|
|
using namespace Util;
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
Property::Property() {
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
Property::~Property() {
|
|
}
|
|
|
|
namespace {
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
// read a typed property out of a FBX element. The return value is NULL if the property cannot be read.
|
|
PropertyPtr ReadTypedProperty(const ElementPtr element) {
|
|
//ai_assert(element.KeyToken().StringContents() == "P");
|
|
|
|
const TokenList &tok = element->Tokens();
|
|
//ai_assert(tok.size() >= 5);
|
|
|
|
const std::string &s = ParseTokenAsString(tok[1]);
|
|
const char *const cs = s.c_str();
|
|
if (!strcmp(cs, "KString")) {
|
|
return new TypedProperty<std::string>(ParseTokenAsString(tok[4]));
|
|
} else if (!strcmp(cs, "bool") || !strcmp(cs, "Bool")) {
|
|
return new TypedProperty<bool>(ParseTokenAsInt(tok[4]) != 0);
|
|
} else if (!strcmp(cs, "int") || !strcmp(cs, "Int") || !strcmp(cs, "enum") || !strcmp(cs, "Enum")) {
|
|
return new TypedProperty<int>(ParseTokenAsInt(tok[4]));
|
|
} else if (!strcmp(cs, "ULongLong")) {
|
|
return new TypedProperty<uint64_t>(ParseTokenAsID(tok[4]));
|
|
} else if (!strcmp(cs, "KTime")) {
|
|
return new TypedProperty<int64_t>(ParseTokenAsInt64(tok[4]));
|
|
} else if (!strcmp(cs, "Vector3D") ||
|
|
!strcmp(cs, "ColorRGB") ||
|
|
!strcmp(cs, "Vector") ||
|
|
!strcmp(cs, "Color") ||
|
|
!strcmp(cs, "Lcl Translation") ||
|
|
!strcmp(cs, "Lcl Rotation") ||
|
|
!strcmp(cs, "Lcl Scaling")) {
|
|
return new TypedProperty<Vector3>(Vector3(
|
|
ParseTokenAsFloat(tok[4]),
|
|
ParseTokenAsFloat(tok[5]),
|
|
ParseTokenAsFloat(tok[6])));
|
|
} else if (!strcmp(cs, "double") || !strcmp(cs, "Number") || !strcmp(cs, "Float") || !strcmp(cs, "float") || !strcmp(cs, "FieldOfView") || !strcmp(cs, "UnitScaleFactor")) {
|
|
return new TypedProperty<float>(ParseTokenAsFloat(tok[4]));
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
// peek into an element and check if it contains a FBX property, if so return its name.
|
|
std::string PeekPropertyName(const Element &element) {
|
|
//ai_assert(element.KeyToken().StringContents() == "P");
|
|
const TokenList &tok = element.Tokens();
|
|
if (tok.size() < 4) {
|
|
return "";
|
|
}
|
|
|
|
return ParseTokenAsString(tok[0]);
|
|
}
|
|
|
|
} // namespace
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
PropertyTable::PropertyTable() :
|
|
templateProps(), element() {
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
PropertyTable::PropertyTable(const ElementPtr element, const PropertyTable *templateProps) :
|
|
templateProps(templateProps), element(element) {
|
|
const ScopePtr scope = GetRequiredScope(element);
|
|
ERR_FAIL_COND(!scope);
|
|
for (const ElementMap::value_type &v : scope->Elements()) {
|
|
if (v.first != "P") {
|
|
DOMWarning("expected only P elements in property table", v.second);
|
|
continue;
|
|
}
|
|
|
|
const std::string &name = PeekPropertyName(*v.second);
|
|
if (!name.length()) {
|
|
DOMWarning("could not read property name", v.second);
|
|
continue;
|
|
}
|
|
|
|
LazyPropertyMap::const_iterator it = lazyProps.find(name);
|
|
|
|
if (it != lazyProps.end()) {
|
|
DOMWarning("duplicate property name, will hide previous value: " + name, v.second);
|
|
continue;
|
|
}
|
|
|
|
if (it->second == nullptr) {
|
|
print_error("skipped invalid element insertion for " + String(name.c_str()));
|
|
continue;
|
|
}
|
|
|
|
//print_verbose("storing lazy property: " + String(name.c_str()));
|
|
|
|
// since the above checks for duplicates we can be sure to insert the only match here.
|
|
lazyProps[name] = v.second;
|
|
}
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
PropertyTable::~PropertyTable() {
|
|
for (PropertyMap::value_type &v : props) {
|
|
delete v.second;
|
|
}
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
PropertyPtr PropertyTable::Get(const std::string &name) const {
|
|
|
|
// check if loaded already - return it.
|
|
PropertyMap::const_iterator loaded_property_element = props.find(name);
|
|
if (loaded_property_element != props.end()) {
|
|
//print_verbose("Returning conversion for lazy property: " + String(loaded_property_element->first.c_str()));
|
|
return loaded_property_element->second;
|
|
}
|
|
|
|
// now load it since we don't have a match
|
|
LazyPropertyMap::const_iterator unloadedProperty = lazyProps.find(name);
|
|
if (unloadedProperty != lazyProps.end()) {
|
|
PropertyPtr loaded_property = ReadTypedProperty(unloadedProperty->second);
|
|
ERR_FAIL_COND_V_MSG(!loaded_property, nullptr, "[fbx][serious] unable to load typed property");
|
|
|
|
//print_verbose("loaded property successfully: " + String(name.c_str()));
|
|
props.insert(std::make_pair(name, loaded_property));
|
|
return loaded_property;
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
DirectPropertyMap PropertyTable::GetUnparsedProperties() const {
|
|
DirectPropertyMap result;
|
|
|
|
// Loop through all the lazy properties (which is all the properties)
|
|
for (const LazyPropertyMap::value_type &element : lazyProps) {
|
|
|
|
// Skip parsed properties
|
|
if (props.end() != props.find(element.first)) continue;
|
|
|
|
// Read the element's value.
|
|
// Wrap the naked pointer (since the call site is required to acquire ownership)
|
|
// std::unique_ptr from C++11 would be preferred both as a wrapper and a return value.
|
|
Property *prop = ReadTypedProperty(element.second);
|
|
|
|
// Element could not be read. Skip it.
|
|
if (!prop) continue;
|
|
|
|
// Add to result
|
|
result[element.first] = prop;
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
} // namespace FBXDocParser
|