tamlCallbacks.h

Engine/source/persistence/taml/tamlCallbacks.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2013 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 _TAML_CALLBACKS_H_
25#define _TAML_CALLBACKS_H_
26
27//-----------------------------------------------------------------------------
28
29class TamlCustomNodes;
30class SimObject;
31
32//-----------------------------------------------------------------------------
33
34class TamlCallbacks
35{
36    friend class Taml;
37
38private:
39    /// Called prior to Taml writing the object.
40    virtual void onTamlPreWrite( void ) = 0;
41
42    /// Called after Taml has finished writing the object.
43    virtual void onTamlPostWrite( void ) = 0;
44
45    /// Called prior to Taml reading the object.
46    virtual void onTamlPreRead( void ) = 0;
47
48    /// Called after Taml has finished reading the object.
49    /// The custom properties is additionally passed here for object who want to process it at the end of reading.
50    virtual void onTamlPostRead( const TamlCustomNodes& customNodes ) = 0;
51
52    /// Called after Taml has finished reading the object and has added the object to any parent.
53    virtual void onTamlAddParent( SimObject* pParentObject ) = 0;
54
55    /// Called during the writing of the object to allow custom properties to be written.
56    virtual void onTamlCustomWrite( TamlCustomNodes& customNodes ) = 0;
57
58    /// Called during the reading of the object to allow custom properties to be read.
59    virtual void onTamlCustomRead( const TamlCustomNodes& customNodes ) = 0;
60};
61
62#endif // _TAML_CALLBACKS_H_
63