VCameraGroup.h

Engine/source/Verve/Extension/Camera/VCameraGroup.h
Classes:

class
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_VCAMERAGROUP_H_
25#define _VT_VCAMERAGROUP_H_
26
27#ifndef _VT_VSCENEOBJECTGROUP_H_
28#include "Verve/Extension/SceneObject/VSceneObjectGroup.h"
29#endif
30
31#ifndef _VT_VCONTROLLER_H
32#include "Verve/Core/VController.h"
33#endif
34
35//-----------------------------------------------------------------------------
36
37class VCameraGroup;
38
39//-----------------------------------------------------------------------------
40
41class VCameraGroup : public VSceneObjectGroup
42{
43    typedef VSceneObjectGroup Parent;
44
45public:
46
47    enum eCameraEventType
48    {
49        k_EventActivate,
50        k_EventDeactivate,
51    };
52
53    typedef Signal<bool( const eCameraEventType & )> CameraEventSignal;
54    typedef Signal<void( VCameraGroup* )>            CameraChangeSignal;
55
56protected:
57
58    static VCameraGroup         *mActiveGroup;
59    static CameraChangeSignal    mCameraChangeSignal;
60
61    CameraEventSignal            mCameraEventSignal;
62
63public:
64
65    VCameraGroup( void );
66
67    // Tree Methods.
68
69    void                   onAttach( void );
70    void                   onDetach( void );
71
72    // Controller Methods.
73
74    bool                   onControllerEvent( VController::eControllerEventType pEvent );
75
76    // Camera Methods.
77
78    inline bool            isActive( void ) { return ( bool )( this == getActiveGroup() ); };
79    inline VCameraGroup   *getActiveGroup( void ) { return mActiveGroup; };
80
81    void                   setActive( void );
82
83    static void            clearActiveGroup( void );
84    static void            setActiveGroup( VCameraGroup *pCameraGroup );
85
86    // Signal Methods.
87
88    static inline CameraChangeSignal   &getCameraChangeSignal( void ) { return mCameraChangeSignal; };
89    inline CameraEventSignal           &getCameraEventSignal( void ) { return mCameraEventSignal; };
90
91    // Console Declaration.
92
93    DECLARE_CONOBJECT( VCameraGroup );
94};
95
96//-----------------------------------------------------------------------------
97
98#endif // _VT_VCAMERAGROUP_H_
99