Torque3D Documentation / _generateds / VSceneObjectEvent.h

VSceneObjectEvent.h

Engine/source/Verve/Extension/SceneObject/VSceneObjectEvent.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_VSCENEOBJECTEVENT_H_
25#define _VT_VSCENEOBJECTEVENT_H_
26
27#ifndef _VT_VEVENT_H_
28#include "Verve/Core/VTrack.h"
29#endif
30
31#ifndef _VT_VSCENEOBJECTGROUP_H_
32#include "Verve/Extension/SceneObject/VSceneObjectGroup.h"
33#endif
34
35//-----------------------------------------------------------------------------
36
37class VSceneObjectEvent : public VEvent
38{
39    typedef VEvent Parent;
40
41public:
42
43    VSceneObjectEvent( void );
44
45    // Reference Methods.
46
47    VTorque::SceneObjectType   *getSceneObject( void );
48    template <class T> inline bool getSceneObject( T *&pSceneObject )
49    {
50        // Reference Scene Object.
51        pSceneObject = dynamic_cast<T*>( getSceneObject() );
52
53        // Valid?
54        return ( pSceneObject != NULL );
55    }
56
57    // Console Declaration.
58
59    DECLARE_CONOBJECT( VSceneObjectEvent );
60};
61
62//-----------------------------------------------------------------------------
63
64#endif // _VT_VSCENEOBJECTEVENT_H_
65