Spinning Topp Logo BlackTopp Studios
inc
asset.cpp
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _resourceasset_cpp
41 #define _resourceasset_cpp
42 
43 #include "Resource/asset.h"
44 #include "Resource/resourceutilities.h"
46 
47 #include "exception.h"
48 
49 namespace Mezzanine
50 {
51  namespace Resource
52  {
54  { }
55 
57  { }
58 
59  ///////////////////////////////////////////////////////////////////////////////
60  // Loading Methods
61 
62  void Asset::LoadAsset(const String& FileName, const String& GroupName)
63  {
65  if( ResourceMan == NULL ) {
66  MEZZ_EXCEPTION(ExceptionBase::INVALID_STATE_EXCEPTION,"Attempting to perform IO with AssetGroups when the resource system has not been created/initialized.");
67  }
68  // We should fetch the stream via the singleton pointer here, however may need to rethink how this is approached for large files or slow IO where loading may need to be split up between multiple frames.
69  MEZZ_EXCEPTION(ExceptionBase::NOT_IMPLEMENTED_EXCEPTION,"Loading via asset groups is not supported yet.");
70  }
71 
72  ///////////////////////////////////////////////////////////////////////////////
73  // Saving Methods
74 
75  void Asset::SaveAsset(const String& FileName, const String& GroupName)
76  {
78  if( ResourceMan == NULL ) {
79  MEZZ_EXCEPTION(ExceptionBase::INVALID_STATE_EXCEPTION,"Attempting to perform IO with AssetGroups when the resource system has not been created/initialized.");
80  }
81  // This is awaiting the addition of write directories to asset groups.
82  MEZZ_EXCEPTION(ExceptionBase::NOT_IMPLEMENTED_EXCEPTION,"Saving via asset groups is not supported yet.");
83  }
84 
85  ///////////////////////////////////////////////////////////////////////////////
86  // Internal Loading Methods
87 
88  void Asset::_LoadAsset(const String& FilePath, const String& FileName)
89  { this->_LoadAsset(Resource::CombinePathAndFileName(FilePath,FileName)); }
90 
91  ///////////////////////////////////////////////////////////////////////////////
92  // Internal Saving Methods
93 
94  void Asset::_SaveAsset(const String& FilePath, const String& FileName)
95  { this->_SaveAsset(Resource::CombinePathAndFileName(FilePath,FileName)); }
96  }//Resource
97 }//Mezzanine
98 
99 #endif
virtual void _SaveAsset(const String &File)=0
Workaround method to save an asset to the filesystem.
virtual ~Asset()
Class destructor.
Definition: asset.cpp:56
#define MEZZ_EXCEPTION(num, desc)
An easy way to throw exceptions with rich information.
Definition: exception.h:3048
Thrown when we just have not coded a thing yet, but we knew what the API should look like...
Definition: exception.h:117
String CombinePathAndFileName(const String &FilePath, const String &FileName)
Convenience method to verify the necessary system separator is present when concatenating.
This implements the exception hiearchy for Mezzanine.
virtual void _LoadAsset(const String &File)=0
Workaround method to load an asset from the filesystem.
static ResourceManager * GetSingletonPtr()
Fetches a pointer to the singleton.
Definition: singleton.h:97
This is the manager responsible for the loading and unloading of files.
The defintion of the Resource Manager.
Thrown when the available information should have worked but failed for unknown reasons.
Definition: exception.h:113
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
Asset()
Class constructor.
Definition: asset.cpp:53
virtual void LoadAsset(std::istream *Stream)=0
Loads an asset from an input stream.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
virtual void SaveAsset(std::ostream *Stream)=0
Saves an asset to an output stream.