tamlChildren.h

Engine/source/persistence/taml/tamlChildren.h
Classes:

class
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_CHILDREN_H_
25#define _TAML_CHILDREN_H_
26
27#ifndef _TORQUE_TYPES_H_
28#include "platform/types.h"
29#endif
30
31//-----------------------------------------------------------------------------
32
33class SimObject;
34
35//-----------------------------------------------------------------------------
36
37class TamlChildren
38{
39public:
40    /// Called when Taml attempts to compile a list of children.
41    virtual U32 getTamlChildCount( void ) const = 0;
42
43    /// Called when Taml attempts to compile a list of children.
44    virtual SimObject* getTamlChild( const U32 childIndex ) const = 0;
45
46    /// Called when Taml attempts to populate an objects children during a read.
47    virtual void addTamlChild( SimObject* pSimObject ) = 0;
48};
49
50#endif // _TAML_CHILDREN_H_
51