/usr/include/collada-dom2.4/dae/daeIOPlugin.h is in libcollada-dom2.4-dp-dev 2.4.4+ds1-2build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | /*
* Copyright 2006 Sony Computer Entertainment Inc.
*
* Licensed under the MIT Open Source License, for details please see license.txt or the website
* http://www.opensource.org/licenses/mit-license.php
*
*/
#ifndef __DAE_IOPLUGIN__
#define __DAE_IOPLUGIN__
#include <string>
#include <vector>
#include <dae/daeTypes.h>
class daeDatabase;
class daeMetaElement;
class daeURI;
class daeDocument;
/**
* The @c daeIOPlugin class provides the input/output plugin interface, which is
* the interface between the COLLADA runtime and the backend storage. A native
* COLLADA XML plugin implementation is provided along with this interface.
*/
class DLLSPEC daeIOPlugin
{
public:
/**
* Destructor
*/
virtual ~daeIOPlugin() {}
/**
* Sets the top meta object.
* Called by @c dae::setIOPlugin() when the IO plugin changes. It passes to this function the
* top meta object, which is the root of a
* hierarchy of @c daeMetaElement objects. This top meta object is capable of creating
* any of the root objects in the DOM tree.
* @param topMeta Top meta object to use to create objects to fill the database.
* @return Returns DAE_OK if successful, otherwise returns a negative value defined in daeError.h.
*/
virtual daeInt setMeta(daeMetaElement *topMeta) = 0;
/** @name Database setup */
//@{
/**
* Sets the database to use.
* All @c daeIOPlugins use the same interface to the @c daeDatabase,
* @c setDatabase() tells the @c daeIOPlugin which @c daeDatabase object it should use
* for storage and queries.
* @param database Database to set.
*/
virtual void setDatabase(daeDatabase* database) = 0;
//@}
/** @name Operations */
//@{
/**
* Imports content into the database from an input.
* The input can be a file, a database or another runtime.
* @param uri the URI of the COLLADA document to load, not all plugins accept all types of URIs,
* check the documentation for the IO plugin you are using.
* @param docBuffer A string containing the text of the document to load. This is an optional attribute
* and should only be used if the document has already been loaded into memory.
* @return Returns DAE_OK if successfully loaded, otherwise returns a negative value defined in daeError.h.
* @see @c DAE::load().
*/
virtual daeInt read(const daeURI& uri, daeString docBuffer) = 0;
/** @name Operations */
//@{
/**
* Writes a specific document to an output.
* @param name URI to write the document to, not all IO plugins support all types of URIs
* check the documentation for the IO plugin you are using.
* @param document Pointer to the document that we're going to write out.
* @param replace True if write should overwrite an existing file. False otherwise.
* @return Returns DAE_OK if success, a negative value defined in daeError.h otherwise.
* @see @c DAE::saveAs()
*/
virtual daeInt write(const daeURI& name, daeDocument *document, daeBool replace) = 0;
//@}
/**
* Returns a list of the URI protocols that this plugin supports.
* @return Returns a daeArray containing the supported protocols.
*/
virtual const std::vector<std::string>& getSupportedProtocols() {
return supportedProtocols;
}
/**
* setOption allows you to set options for this IOPlugin. Which options a plugin supports is
* dependent on the plugin itself. There is currently no list of options that plugins are
* suggested to implement.
* @param option The option to set.
* @param value The value to set the option.
* @return Returns DAE_OK upon success.
*/
virtual daeInt setOption( daeString option, daeString value ) = 0;
/**
* getOption retrieves the value of an option from this IOPlugin. Which options a plugin supports is
* dependent on the plugin itself.
* @param option The option to get.
* @return Returns the string value of the option or NULL if option is not valid.
*/
virtual daeString getOption( daeString option ) = 0;
protected:
// This is an array of the URI protocols supported by this plugin, e.g. "http", "file",
// etc. Each plugin should initialize this variable in the constructor.
std::vector<std::string> supportedProtocols;
};
class DLLSPEC daeIOEmpty : public daeIOPlugin {
public:
virtual daeInt setMeta(daeMetaElement *topMeta) { return DAE_ERROR; }
virtual void setDatabase(daeDatabase* database) { }
virtual daeInt read(const daeURI& uri, daeString docBuffer) { return DAE_ERROR; }
virtual daeInt write(const daeURI& name, daeDocument *document, daeBool replace) { return DAE_ERROR; }
virtual daeInt setOption( daeString option, daeString value ) { return DAE_ERROR; }
virtual daeString getOption( daeString option ) { return ""; }
};
#endif // __DAE_IOPLUGIN__
|