source: GTP/trunk/App/Demos/Geom/OgreStuff/include/OgreUserDefinedObject.h @ 1812

Revision 1812, 4.0 KB checked in by gumbau, 18 years ago (diff)
Line 
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4    (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2005 The OGRE Team
8Also see acknowledgements in Readme.html
9
10This program is free software; you can redistribute it and/or modify it under
11the terms of the GNU Lesser General Public License as published by the Free Software
12Foundation; either version 2 of the License, or (at your option) any later
13version.
14
15This program is distributed in the hope that it will be useful, but WITHOUT
16ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
18
19You should have received a copy of the GNU Lesser General Public License along with
20this program; if not, write to the Free Software Foundation, Inc., 59 Temple
21Place - Suite 330, Boston, MA 02111-1307, USA, or go to
22http://www.gnu.org/copyleft/lesser.txt.
23-----------------------------------------------------------------------------
24*/
25#ifndef __UserDefinedObject_H__
26#define __UserDefinedObject_H__
27
28#include "OgrePrerequisites.h"
29
30namespace Ogre {
31
32
33    /** This class is designed to be subclassed by OGRE users, to allow them to
34        associate their own application objects with MovableObject instances
35        in the engine.
36    @remarks
37        It's always been suggested that an OGRE application would likley comprise
38        a number of game objects which would keep pointers to OGRE objects in order
39        to maintain the link. However, in some cases it would be very useful to be able to
40        navigate directly from an OGRE instance back to a custom application object.
41        This abstract class exists for this purpose; MovableObjects hold a pointer to
42        a UserDefinedObject instance, which application writers subclass in order to
43        include their own attributes. Your game objects themselves may be subclasses of this
44        class, or your subclasses may merely be a link between them.
45    @par
46        Because OGRE never uses instances of this object itself, there is very little
47        definition to this class; the application is expected to add all the detail it wants.
48        However, as a hint, and for debugging purposes, this class does define a 'type id',
49        which it is recommended you use to differentiate between your subclasses,
50        if you have more than one type.
51    */
52    class _OgreExport UserDefinedObject
53    {
54    public:
55        /** Standard constructor. */
56        UserDefinedObject();
57        virtual ~UserDefinedObject() {}
58
59        /** Return a number identifying the type of user defined object.
60        @remarks
61            Can be used to differentiate between different types of object which you attach to
62            OGRE MovableObject instances. Recommend you override this in your classes if you
63            use more than one type of object.
64        @par
65            Alternatively, you can override the getTypeName method and use that instead;
66            that version is a litle more friendly and easier to scope, but obviously
67            slightly less efficient. You choose which you prefer.
68        */
69        virtual long getTypeID(void) const;
70
71        /** Return a string identifying the type of user defined object.
72        @remarks
73            Can be used to differentiate between different types of object which you attach to
74            OGRE MovableObject instances. Recommend you override this in your classes if you
75            use more than one type of object.
76        @par
77            Alternatively, you can override the getTypeID method and use that instead;
78            that version is a litle more efficient, but obviously
79            slightly less easy to read. You choose which you prefer.
80        */
81        virtual const String& getTypeName(void) const;
82       
83    };
84   
85       
86
87}
88
89#endif
Note: See TracBrowser for help on using the repository browser.