Commit Graph

144 Commits

Author SHA1 Message Date
Kim Kulling 6aac7a2458
Fix: Fix typo in doc
- closes https://github.com/assimp/assimp/issues/4973
2023-02-21 21:34:49 +01:00
Kim Kulling be2eaac5a7 IMP: Reorganize doc 2022-09-18 19:31:48 +02:00
Kim Kulling 0ef830d2b1
Update version in doxy-config 2022-03-12 16:57:27 +01:00
IOhannes m zmölnig 3b8126d26a Fix spelling mistake 2021-10-08 08:48:01 +02:00
Krishty 758116b083 removed trailing spaces and tabs from source and text
This commit ignores the “contrib” folder in order to prevent merge conflicts in dependencies, should these be updated via git.
2021-07-29 13:28:51 +02:00
Kim Kulling d554b4950d Add hpp to dxygen filter 2021-07-22 20:48:25 +02:00
Kim Kulling aa8628abef Disable html and enable xml 2021-07-21 20:38:58 +02:00
Kim Kulling e13ce4b624 Fix version, remove deprecated doc files, fix some path errors 2021-07-21 09:46:23 +02:00
Tobias Rittig 0643786288
Add PBRT to exportable file formats list
As of #3580 assimp can export to the newest version of the PBRT renderer. This was not listed here.
2021-04-19 15:27:59 +02:00
Malcolm Tyrrell b7c789da67 Stop concatenating std::strings. Use formatter. 2020-08-18 17:35:08 +01:00
Kim Kulling 28b65c84b0
Create fileformats.md
Optimize the readabilaty of the frontpage.
2020-06-29 09:52:36 +02:00
Aaron Franke 1529f9518f
Make file formatting comply with POSIX and Unix standards
UTF-8, LF, no BOM, and newlines at the end of files
2020-03-21 02:34:12 -04:00
Marc-Antoine Lortie edfaaed56f Removed uneeded expression in else() and endif() constructs.
The following changes were tested against building with a master copy.

For a more detailed report, please read the followings below:

The flags that were checked were the ones checked by default + the following:

ASSIMP_BUILD_ASSIMP_VIEW
ASSIMP_BUILD_SAMPLES

The list of compilable projects in Visual Studio were the following:

- assimp
- assimp_cmd
- assimp_simpleogl
- assimp_simpletextureddirectx11
- assimp_simpletexturedogl
- assimp_viewer
- INSTALL
- IrrXML
- uninstall
- unit
- UpdateAssimpLibsDebugSymbolsAndDLLs
- ZERO_CHECK
- zlib
- zlibstatic

The solution that was generated with the new changes comprised the same number of projects as the one from the master, unmodified. All projects except UpdateAssimpLibsDebugSymbolsAndDLLs were built without any error. All tests were run.

UpdateAssimpLibsDebugSymbolsAndDLLs could not be built because of the reasons explained in issue #3004.
2020-02-23 07:09:35 -05:00
Marc-Antoine Lortie 4e7e47bd43 Updated copyright dates.
Changed copyright end year to 2020 in every reference "Copyright (c) 2006-XXXX, assimp team".

Changed copyright end year to 2020 in every reference "Copyright (c) 2006-XXXX, ASSIMP Development Team".

Changed copyright end year to 2020 in LICENCE.rtf.

Changed copyright end year in CMakeFiles.txt files and any other places referencing Assimp with a copyright start and end year.
2020-01-20 08:53:12 -05:00
Kim Kulling 93e8a1054f Add short documentation. 2019-03-13 22:07:03 +01:00
Kim Kulling 4b4f18fb31 Dox: remove parts about boost support - already replaced by c++11. 2018-11-19 21:46:02 +01:00
Alexandre Avenel 2998830d4a Fix typos on documentation using codespell 2018-05-13 15:33:51 +02:00
Kim Kulling 483541ee25
Merge branch 'master' into isue_1621 2018-04-06 20:54:01 +02:00
Kim Kulling 183224f045 closes https://github.com/assimp/assimp/issues/1621: add file check for dxf file without extensions. 2018-04-06 20:51:07 +02:00
Daniel Löber ef2343506b Expand the current description about loading of embedded textures 2018-03-16 11:17:28 +01:00
Kim Kulling 1fbfe6736e
Update dox.h
Update installation guide for linux and python.
2018-02-03 11:52:40 +01:00
Kim Kulling 45e4a513de add cmake doc to doxygen-docu. 2018-02-03 11:07:40 +01:00
Kim Kulling 01e4d07c1e closes https://github.com/assimp/assimp/issues/1583: update doc. 2018-02-03 09:42:07 +01:00
Kim Kulling d360532667
Merge branch 'master' into document_material_reflectivity 2018-01-12 14:57:04 +01:00
Manuel Freiberger 33ddbf9aa0
Correct matrix layout documentation
Actually, both OpenGL and DirectX specify a matrix layout where the base vectors and the translational
part is consecutive in memory.
OpenGL uses post-multiplication of column-vectors and stores the matrix in column-major storage format:

    | X1  Y1  Z1  T1 |  | a |
    | X2  Y2  Z2  T2 |  | b |
    | X3  Y3  Z3  T3 |  | c |
    |  0   0   0   1 |  | 1 |

DirectX on the other hand uses row-major storage format but also pre-multiplication of
row-vectors

    | a b c 1 | | X1  X2  X3  0 |
                | Y1  Y2  Y3  0 |
                | Z1  Z2  Z3  0 |
                | T1  T2  T3  1 |

So a matrix is stored the same way in both frameworks and both times the translational part is consecutive,
which is not the format that Assimp uses.
2018-01-11 20:58:47 +01:00
Tommy 909c0a820a Document AI_MATKEY_REFLECTIVITY and AI_MATKEY_COLOR_REFLECTIVE. 2018-01-10 19:22:56 +01:00
Manuel Freiberger 8fe2ba31a9
Clarify the matrix layout
The columns of the matrix are the images of the standard base vectors rather than the base vectors themselves. Added some 
description of the row-major storage format.
2018-01-09 23:46:36 +01:00
Manuel Freiberger e5e67ffd83
Fix typos and ease description of coordinate frame 2018-01-09 19:50:07 +01:00
Kim Kulling 406a06705e
Update Doxyfile.in
Update version
2017-12-11 13:21:35 +01:00
Unknown 12dbbd4ce9 Misc. typos
Some are doxy comments, some are just trivial source comment typos. 
Found using `codespell -q 3 --skip="./contrib" -I ../assimp-whitelist.txt`
whereby whitelist contained:
```
childs
iff
lod
nto
ot
whitespaces
```
2017-11-09 17:19:26 -05:00
Kim Kulling f43586305c closes https://github.com/assimp/assimp/issues/1533: put irrXML onto exclucde list for doxygen run. 2017-11-05 18:24:39 +01:00
Squareys 4e1ea6ecd7 docs: Explain texture paths for embedded textures 2017-05-19 13:32:04 +02:00
Squareys efeeb6a827 docs: Update logging docs 2017-05-19 13:32:04 +02:00
Squareys aab36ca723 docs: Update copyright notice in preamble 2017-05-19 13:32:04 +02:00
Helio Chissini de Castro 1ba843118b - Fix documentation install process. It's nonsense second BUILD_DOCS
check on doc/CMakeLists since is already checked on main CMakeLists.
At same time, Doxygen becomes required as no documentation can be built
without it.
Output directory now uses the user defined HTML_OUTPUT instead of
forced dir.
- Added included GNUInstallDirs on same UNIX check, avoiding duplication
of checks
2017-04-25 14:35:07 +02:00
Helio Chissini de Castro e4f05064df Enable doxygen been properly used from cmake build and install.
Current documentation lacks a proper directory handling and switch for
Unix like systems.
The option BUILD_DOCS are added as disable by default, even so the
Doxyfile file is generated for a manual build.

Option HTML_OUTPUT are made cached to be properly replaced, as usually
done by some Linux distributions

Microsoft CHM option is enabled if MSVC is detected.
2017-04-18 17:01:16 +02:00
Kim Kulling fac2f4d2f2 add missing doc. 2017-04-07 17:50:13 +02:00
Kim Kulling 53af3a5f95 add missing doc. 2017-04-07 17:49:59 +02:00
Kim Kulling 74b89e13f6 add missing doc. 2017-04-07 17:49:43 +02:00
Kim Kulling 0c43688108 add doc. 2017-04-07 17:49:26 +02:00
Kim Kulling c4b5dc4275 add missing image. 2017-04-07 17:49:03 +02:00
Kim Kulling 0fc5c9417c export doc.# with '#' will be ignored, and an empty message aborts the commit. 2017-04-07 17:48:18 +02:00
Kim Kulling 38fab5ae8e doc updatedoc update 2017-04-07 17:46:53 +02:00
Kim Kulling 0b060d6738 Renaming doc. 2016-09-17 10:20:03 +02:00
Kim Kulling a29f562241 Doc: add uml-diagrams for import and export. 2016-09-17 10:07:14 +02:00
Kim Kulling 8f808f0e2e Doc: fix redundant doc. 2016-09-05 00:27:59 +02:00
Kim Kulling 8ba10cf26a Closes https://github.com/assimp/assimp/issues/966: add missing doc for
assimp_cmd.
2016-08-09 13:42:33 +02:00
Waldir Pimenta a9ebac6b54 fix long option name for --om
to match the actual code in tools/assimp_cmd/Main.cpp
2016-08-08 11:46:41 +01:00
Waldir Pimenta a98e524fe2 dox_cmd.h: fix typo 'dumb' --> 'dump' 2016-08-05 19:54:58 +01:00
mensinda 5dacda0a08 replaced boost smart pointers with c++11 smart pointers 2016-04-05 23:23:53 +02:00