izrik/fbxsharp

A pure C# library for loading FBX files

FbxSharp

A pure C# library for loading FBX files

Description

FbxSharp was deliberately patterned after Autodesk’s FBX SDK, though written entirely in C# rather than C++. In general, the classes of FbxSharp match corresponding ones in the SDK, with the difference of not having the “Fbx” prefix on the name of the class. But of course, there are plenty of special cases. ;) Anyways, if you’re familiar with using the SDK, you should be able to figure out FbxSharp without any difficulty.

FbxSharp doesn't handle binary files yet, so you have to convert them to ascii. Also, it's only been only tested against file format version 2013.3, so convert to that while you're at it.

There's an example of how to use the library here: https://github.com/izrik/ChamberLib.FbxSharp/blob/master/FbxModelImporter.cs#L41

Future work will go towards implementing the rest of the api, implementing other versions of the api, and supporting additional file formats.

SDK Interface Versions Implemented:

• 2020.0.1
• 2019.5
• 2019.2
• 2019.0
• 2018.1.1
• 2018.0
• 2017.1
• 2017.0
• 2016.1.2
• 2016.1
• 2016
• 2015
• 2014.2.1
• 2014.1
• 2013.3

File Versions Supported:

[ ]	Version ID	x.y	SDK version(s)	Notes

• [ ]|7700|7.7|2020, 2019.5|

• [ ]|7600|7.6|

• [ ]|7500|7.5|2016.1.2 through 2019.2|

• [ ]|7400|7.4|2014, 2015

• [X]|7300|7.3|2013.3

• [ ]|7200|7.2|

• [ ]|7100|7.1|

• [ ]|7099|||Compatible with 7.1, and taken as such

• [ ]|7000|||Compatible with 7.1, and taken as such

• [ ]|6100|6.1|

• [ ]|6000|6.0|

• [ ]|5800|5.8|

• [ ]|5000|5.0|

• [ ]|4050|4.5|

• [ ]|4001|4.01|

• [ ]|4000|4.0|

• [ ]|3001|3.01|

• [ ]|3000|3.0|

• [ ]|2001|2.01|

• [ ]|2000|2.0|

• Ascii

• Binary

fbxsharp's Issues

Contribution guidelines

CONTRIBUTORS.md or CONTRIBUTING.md file with general guidelines for development. Should include necessary steps to get a dev machine ready to work (i.e. install .NET/mono; nuget and nunit command-line programs). Should include instructions for building the code. Should include checklist to be completed before releases are cut.

Extract a visitor pattern class from ObjectPrinter

The Collector class implements the Visitor Pattern. The ObjectPrinter class also does, in a way. Extract the commonalities into a class or something that we can re-use.

ObjectPrinter.quote should produce escape sequences for unprintable/non-ascii characters

Travis release failure - FbxPrint not in build output

Travis builds the FbxSharpBuild.sln solution. The release.sh script expects the FbxPrint.exe tool to be present. However, the FbxPrint project file is not included in the solution, so it doesn't get built, so nuget can't package it up when releasing.

Automated style checks

Probably gendarme

Docs

Basic intro stuff:
Explain how to load a model

see also izrik/ChamberLib#5

Make ObjectPrinter/FbxPrint work off of command-line parameters

Currently, the filename to be opened is hard-coded. That should be taken from command-line parameters. Also, any options or flags to change how the objects are collected or printed should be settable from the command-line. NCommander may be useful here.

release 0.9

Numbers parsing

Number.cs fails on string input: "0.000000000000000".
It says, that the "The string cannot be interpreted as a snumber" and throws ArgumentException, but there is actually a number in given string. Following lines in Number.cs:

public struct Number
    {
        public Number(string str)
        {
            if (string.IsNullOrWhiteSpace(str)) throw new ArgumentNullException("s");

            StringRepresentation = str;

            double d;
            if (double.TryParse(str, out d))
                AsDouble = d;
            else
                AsDouble = null;

            long l;
            if (long.TryParse(str, out l))
                AsLong = l;
            else
                AsLong = null;

            if (!AsLong.HasValue && !AsDouble.HasValue)
            {
                throw new ArgumentException("The string cannot be interpreted as a snumber", "str");
            }
        }

ObjectPrinter.quote should escape double-quote characters and backslashes

Recent changes broke travis release process

Travis is trying to run nuget-pack-push.sh which has been renamed to release.sh. Change the travis config to run the right script. Commit 0fcbcdb is what broke it.

Rename ObjectPrinter to FbxPrint

Replace all TODO's in the code with github issues

Calculate code coverage

Must be easily runnable from the command line
Must run on Linux
Would prefer it were easily downloaded via nuget

Possible tool: https://github.com/inorton/XR.Baboon
Possible tool: https://github.com/gaillard/SharpCover

See also:
http://stackoverflow.com/questions/32118808/code-coverage-on-xamarin-studio
https://coveralls.zendesk.com/hc/en-us/articles/203488029
https://www.nuget.org/packages/coveralls.io
https://github.com/csmacnz/coveralls.net

Use attributes to indicate which classes, methods, etc are from the SDK and which aren't

Maybe also an attribute for things that are originally in the SDK, but can't be expressed the same way in C# as in C++.

ObjectPrinter should allow callers to specify a TextWriter, rather than only using Console

Load binary files

FbxSharp currently can only load ascii files. This means that a binary file must be converted to ascii before it can be opened. Some fbx exporters only output binary files. In order to better support those cases, FbxSharp should be able to load binary files as well.

Parameterize FbxVisitor

Collector uses FbxVisitor to traverse the object graph. This works well enough, but we have to store the collected objects in an instance field. That makes re-using a Collector cumbersome. If we could pass additional parameters to the Visit and Accept* methods, we wouldn't need the instance field.

FbxExporter Wrapper

I noticed the FbxExporter wrapper class is missing from this project, unless I'm mistaken. Are there plans to include this in future commits?

Unit conversions

Some 3d modelling programs export fbx files in unexpected ways. FbxSharp should be able to convert scenes from one system of units/axes to another.

http://help.autodesk.com/view/FBX/2015/ENU/?guid=__files_GUID_CC93340E_C4A1_49EE_B048_E898F856CFBF_htm
http://help.autodesk.com/view/FBX/2015/ENU/?guid=__cpp_ref_class_fbx_system_unit_html

InvalidOperationException on Object's empty values

Given FBX Object

Model: "Model::Camera Switcher", "CameraSwitcher" {
		Version: 232
		MultiLayer: 0
		MultiTake: 1
		CameraIndexName:
	}

Parser.cs fails with InvalidOperationException (method ReadObject())on the line with CameraIndexName: , because the value is missing.
In this case should the FBX be considered invalid or the behavior of the parser is invalid and should somehow be corrected?

Test DisconnectAllSrcObject<T> and DisconnectAllDstObject<T> failure modes

what are the failure modes?
if a single src/dst object fails to be disconnected, that fails the whole thing, right?
but if a single src/dst object fails to be disconnected, does that stop the process of disconnecting objects after it?
if so, what is the order in which the objects are considered?

Classes in C# should have exactly the same names as their C++ counterparts