Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / collada / ExtraHandler.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file \ingroup collada
18  */
19
20 #include <string>
21 #include <map>
22 #include <vector>
23 #include <algorithm> // sort()
24
25 #include "COLLADASaxFWLIExtraDataCallbackHandler.h"
26 #include "COLLADASaxFWLFilePartLoader.h"
27 #include "COLLADASWInstanceController.h"
28
29 #include "DocumentImporter.h"
30 #include "AnimationImporter.h"
31
32 /** \brief Handler class for \<extra\> data, through which different
33  * profiles can be handled
34  */
35 class ExtraHandler : public COLLADASaxFWL::IExtraDataCallbackHandler
36 {
37 public:
38         /** Constructor. */
39         ExtraHandler(DocumentImporter *dimp, AnimationImporter *aimp);
40
41         /** Destructor. */
42         virtual ~ExtraHandler();
43
44         /** Handle the beginning of an element. */
45         bool elementBegin( const char* elementName, const char** attributes);
46
47         /** Handle the end of an element. */
48         bool elementEnd(const char* elementName );
49
50         /** Receive the data in text format. */
51         bool textData(const char* text, size_t textLength);
52
53         /** Method to ask, if the current callback handler want to read the data of the given extra element. */
54         bool parseElement (
55                 const char* profileName,
56                 const unsigned long& elementHash,
57                 const COLLADAFW::UniqueId& uniqueId,
58                 COLLADAFW::Object* object);
59
60         /** For backwards compatibility with older OpenCollada, new version added object parameter */
61         bool parseElement (
62                 const char* profileName,
63                 const unsigned long& elementHash,
64                 const COLLADAFW::UniqueId& uniqueId);
65 private:
66         /** Disable default copy constructor. */
67         ExtraHandler(const ExtraHandler& pre);
68         /** Disable default assignment operator. */
69         const ExtraHandler& operator= ( const ExtraHandler& pre );
70
71         /** Handle to DocumentImporter for interface to extra element data saving. */
72         DocumentImporter* dimp;
73         AnimationImporter* aimp;
74         /** Holds Id of element for which <extra> XML elements are handled. */
75         COLLADAFW::UniqueId currentUid;
76         ExtraTags* currentExtraTags;
77         std::string currentElement;
78 };