vrshoot

annotate libs/assimp/FBXImportSettings.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 FBXImportSettings.h
nuclear@0 42 * @brief FBX importer runtime configuration
nuclear@0 43 */
nuclear@0 44 #ifndef INCLUDED_AI_FBX_IMPORTSETTINGS_H
nuclear@0 45 #define INCLUDED_AI_FBX_IMPORTSETTINGS_H
nuclear@0 46
nuclear@0 47 namespace Assimp {
nuclear@0 48 namespace FBX {
nuclear@0 49
nuclear@0 50 /** FBX import settings, parts of which are publicly accessible via their corresponding AI_CONFIG constants */
nuclear@0 51 struct ImportSettings
nuclear@0 52 {
nuclear@0 53 ImportSettings()
nuclear@0 54 : strictMode(true)
nuclear@0 55 , readAllLayers(true)
nuclear@0 56 , readAllMaterials()
nuclear@0 57 , readMaterials(true)
nuclear@0 58 , readCameras(true)
nuclear@0 59 , readLights(true)
nuclear@0 60 , readAnimations(true)
nuclear@0 61 , readWeights(true)
nuclear@0 62 , preservePivots(true)
nuclear@0 63 , optimizeEmptyAnimationCurves(true)
nuclear@0 64 {}
nuclear@0 65
nuclear@0 66
nuclear@0 67 /** enable strict mode:
nuclear@0 68 * - only accept fbx 2012, 2013 files
nuclear@0 69 * - on the slightest error, give up.
nuclear@0 70 *
nuclear@0 71 * Basically, strict mode means that the fbx file will actually
nuclear@0 72 * be validated. Strict mode is off by default. */
nuclear@0 73 bool strictMode;
nuclear@0 74
nuclear@0 75 /** specifies whether all geometry layers are read and scanned for
nuclear@0 76 * usable data channels. The FBX spec indicates that many readers
nuclear@0 77 * will only read the first channel and that this is in some way
nuclear@0 78 * the recommended way- in reality, however, it happens a lot that
nuclear@0 79 * vertex data is spread among multiple layers. The default
nuclear@0 80 * value for this option is true.*/
nuclear@0 81 bool readAllLayers;
nuclear@0 82
nuclear@0 83 /** specifies whether all materials are read, or only those that
nuclear@0 84 * are referenced by at least one mesh. Reading all materials
nuclear@0 85 * may make FBX reading a lot slower since all objects
nuclear@0 86 * need to be processed .
nuclear@0 87 * This bit is ignored unless readMaterials=true*/
nuclear@0 88 bool readAllMaterials;
nuclear@0 89
nuclear@0 90
nuclear@0 91 /** import materials (true) or skip them and assign a default
nuclear@0 92 * material. The default value is true.*/
nuclear@0 93 bool readMaterials;
nuclear@0 94
nuclear@0 95 /** import cameras? Default value is true.*/
nuclear@0 96 bool readCameras;
nuclear@0 97
nuclear@0 98 /** import light sources? Default value is true.*/
nuclear@0 99 bool readLights;
nuclear@0 100
nuclear@0 101 /** import animations (i.e. animation curves, the node
nuclear@0 102 * skeleton is always imported). Default value is true. */
nuclear@0 103 bool readAnimations;
nuclear@0 104
nuclear@0 105 /** read bones (vertex weights and deform info).
nuclear@0 106 * Default value is true. */
nuclear@0 107 bool readWeights;
nuclear@0 108
nuclear@0 109 /** preserve transformation pivots and offsets. Since these can
nuclear@0 110 * not directly be represented in assimp, additional dummy
nuclear@0 111 * nodes will be generated. Note that settings this to false
nuclear@0 112 * can make animation import a lot slower. The default value
nuclear@0 113 * is true.
nuclear@0 114 *
nuclear@0 115 * The naming scheme for the generated nodes is:
nuclear@0 116 * <OriginalName>_$AssimpFbx$_<TransformName>
nuclear@0 117 *
nuclear@0 118 * where <TransformName> is one of
nuclear@0 119 * RotationPivot
nuclear@0 120 * RotationOffset
nuclear@0 121 * PreRotation
nuclear@0 122 * PostRotation
nuclear@0 123 * ScalingPivot
nuclear@0 124 * ScalingOffset
nuclear@0 125 * Translation
nuclear@0 126 * Scaling
nuclear@0 127 * Rotation
nuclear@0 128 **/
nuclear@0 129 bool preservePivots;
nuclear@0 130
nuclear@0 131 /** do not import animation curves that specify a constant
nuclear@0 132 * values matching the corresponding node transformation.
nuclear@0 133 * The default value is true. */
nuclear@0 134 bool optimizeEmptyAnimationCurves;
nuclear@0 135 };
nuclear@0 136
nuclear@0 137
nuclear@0 138 } // !FBX
nuclear@0 139 } // !Assimp
nuclear@0 140
nuclear@0 141 #endif
nuclear@0 142