Torque3D Documentation / _generateds / VSceneObjectGroup.h

VSceneObjectGroup.h

Engine/source/Verve/Extension/SceneObject/VSceneObjectGroup.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Verve
 4// Copyright (C) 2014 - Violent Tulip
 5//
 6// Permission is hereby granted, free of charge, to any person obtaining a copy
 7// of this software and associated documentation files (the "Software"), to
 8// deal in the Software without restriction, including without limitation the
 9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23//-----------------------------------------------------------------------------
24#ifndef _VT_VSCENEOBJECTGROUP_H_
25#define _VT_VSCENEOBJECTGROUP_H_
26
27#ifndef _VT_VGROUP_H_
28#include "Verve/Core/VGroup.h"
29#endif
30
31#ifndef _VT_TORQUE_SCENEOBJECT_H_
32#include "Verve/Torque/TSceneObject.h"
33#endif
34
35//-----------------------------------------------------------------------------
36
37class VSceneObjectGroup : public VGroup
38{
39    typedef VGroup Parent;
40
41public:
42
43    // Reference Members.
44
45    String                      mDataReference;
46    VTorque::SceneObjectType   *mSceneObject;
47
48public:
49
50    VSceneObjectGroup( void );
51
52    static void                         initPersistFields( void );
53
54    // Reference Methods.
55    
56    VTorque::SceneObjectType   *getSceneObject( void );
57    template <class T> inline bool getSceneObject( T *&pSceneObject )
58    {
59        // Reference Scene Object.
60        pSceneObject = dynamic_cast<T*>( getSceneObject() );
61
62        // Valid?
63        return ( pSceneObject != NULL );
64    }
65
66    // Console Declaration.
67
68    DECLARE_CONOBJECT( VSceneObjectGroup );
69};
70
71//-----------------------------------------------------------------------------
72
73#endif // _VT_VSCENEOBJECTGROUP_H_
74