DDD_PluginMgr.h

Go to the documentation of this file.

/*! \file DDD_PluginMgr.h
  
  \brief Class for managing converter and asset plugins and adding them to the respective factories

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef DDD_PLUGIN_MGR_H
#define DDD_PLUGIN_MGR_H

#include "DDD_Include.h"
#include "DDD_StringList.h"
#include <string>

namespace disti
{

class DDD_EXPORT DDD_PluginMgr 
{
private:
    /** Constructor.  Private because the Singleton pattern is being used
      */
    DDD_PluginMgr();

    /** Destructor.  Private because the Singleton pattern is being used
      */
    ~DDD_PluginMgr();

public:

    /** Public interface to the singleton 
      * \return Returns a pointer to the singleton instance 
      */
    static DDD_PluginMgr& Instance();

    /** Traverses the given path and adds any assets in the path to the asset factory
      * This functionality is used in the editor to allow the editor to present a list
      * of available asset types 
      * \param assetsPath  The path containing assets to add to the factory
      * \return True if assets were added to the factory
      */
    bool LoadAssets(const std::string& assetsPath);

    /** Traverses the given path and adds any converters in the path to the converter factory
      * This functionality is used in the editor to allow the editor to present a list
      * of available converter types.  It is also needed at runtime to make converter plugins available
      * \param convertersPath  The path containing converters to add to the factory
      * \return True if converters were added to the factory
      */
    bool LoadConverters(const std::string& convertersPath);

    /** \return Returns the list of asset types that have been added to the Asset Factory
      */
    DDD_StringList LoadedAssets();

    /** \return Returns the list of converter types that have been added to the Converter Factory
      */
    DDD_StringList LoadedConverters();
};

}   // end namespace disti


#endif