simObjectMemento.h

Engine/source/console/simObjectMemento.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _CONSOLE_SIMOBJECTMEMENTO_H_
25#define _CONSOLE_SIMOBJECTMEMENTO_H_
26
27#ifndef _SIM_H_
28#include "console/sim.h"
29#endif
30
31
32/// This simple class is used to store an SimObject and 
33/// its state so it can be recreated at a later time.
34///
35/// The success of restoring the object completely depends
36/// on the results from SimObject::write().
37class SimObjectMemento
38{
39protected:
40
41   /// The captured object state.
42   UTF8 *mState;
43
44   /// The captured object's name.
45   String mObjectName;
46   bool mIsDatablock;
47
48public:
49
50   SimObjectMemento();
51   virtual ~SimObjectMemento();
52
53   /// Returns true if we have recorded state.
54   bool hasState() const { return mState; }
55
56   ///
57   void save( SimObject *object );
58
59   ///
60   SimObject *restore() const;
61
62};
63
64
65#endif // _CONSOLE_SIMOBJECTMEMENTO_H_
66