summaryrefslogtreecommitdiff
path: root/indra/llinventory/llsettingsdaycycle.h
blob: ae47a542708eb5f5b5ed90c3fbf586c163dd2919 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/**
* @file llsettingsdaycycle.h
* @author optional
* @brief A base class for asset based settings groups.
*
* $LicenseInfo:2011&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2017, Linden Research, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License only.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*
* Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
* $/LicenseInfo$
*/

#ifndef LL_SETTINGS_DAYCYCLE_H
#define LL_SETTINGS_DAYCYCLE_H

#include "llsettingsbase.h"

class LLSettingsWater;
class LLSettingsSky;

typedef boost::shared_ptr<LLSettingsWater> LLSettingsWaterPtr_t;
typedef boost::shared_ptr<LLSettingsSky> LLSettingsSkyPtr_t;

class LLSettingsDay : public LLSettingsBase
{
public:
    static const std::string    SETTING_DAYLENGTH;
    static const std::string    SETTING_KEYID;
    static const std::string    SETTING_KEYNAME;
    static const std::string    SETTING_KEYKFRAME;
    static const std::string    SETTING_KEYHASH;
    static const std::string    SETTING_TRACKS;
    static const std::string    SETTING_FRAMES;

    static const S64            MINIMUM_DAYLENGTH;
    static const S64            DEFAULT_DAYLENGTH;
    static const S64            MAXIMUM_DAYLENGTH;

    static const S32            MINIMUM_DAYOFFSET;
    static const S32            DEFAULT_DAYOFFSET;
    static const S32            MAXIMUM_DAYOFFSET;

    static const S32            TRACK_WATER;
    static const S32            TRACK_MAX;
    static const S32            FRAME_MAX;

    typedef std::map<F32, LLSettingsBase::ptr_t>    CycleTrack_t;
    typedef std::vector<CycleTrack_t>               CycleList_t;
    typedef boost::shared_ptr<LLSettingsDay>   ptr_t;
    typedef std::vector<S64Seconds>                 TimeList_t;
    typedef std::vector<F32>                        KeyframeList_t;
    typedef std::pair<CycleTrack_t::iterator, CycleTrack_t::iterator> TrackBound_t;

    //---------------------------------------------------------------------
    LLSettingsDay(const LLSD &data);
    virtual ~LLSettingsDay() { };

    void                        initialize();

    virtual ptr_t               buildClone() = 0;
    virtual LLSD                getSettings() const;

    //---------------------------------------------------------------------
    virtual std::string         getSettingType() const { return std::string("daycycle"); }

    // Settings status 
    virtual void                blend(const LLSettingsBase::ptr_t &other, F64 mix);

    static LLSD                 defaults();

    //---------------------------------------------------------------------
    S64Seconds getDayLength() const
    {
        return mDayLength;
    }

    void setDayLength(S64Seconds seconds)
    {
        mDayLength = seconds;
    }

    S64Seconds getDayOffset() const
    {
        return mDayOffset;
    }

    void setDayOffset(S64Seconds seconds)
    {
        mDayOffset = seconds;
    }

    KeyframeList_t              getTrackKeyframes(S32 track);
    TimeList_t                  getTrackTimes(S32 track);

    void                        setWaterAtTime(const LLSettingsWaterPtr_t &water, S64Seconds seconds);
    void                        setWaterAtKeyframe(const LLSettingsWaterPtr_t &water, F32 keyframe);

    void                        setSkyAtTime(const LLSettingsSkyPtr_t &sky, S64Seconds seconds, S32 track);
    void                        setSkyAtKeyframe(const LLSettingsSkyPtr_t &sky, F32 keyframe, S32 track);
        //---------------------------------------------------------------------
    void                        startDayCycle();

    LLSettingsSkyPtr_t          getCurrentSky() const
    {
        return mBlendedSky;
    }

    LLSettingsWaterPtr_t        getCurrentWater() const
    {
        return mBlendedWater;
    }

    virtual LLSettingsSkyPtr_t  getDefaultSky() const = 0;
    virtual LLSettingsWaterPtr_t getDefaultWater() const = 0;

    virtual LLSettingsSkyPtr_t  buildSky(LLSD) const = 0;
    virtual LLSettingsWaterPtr_t buildWater(LLSD) const = 0;

    virtual LLSettingsSkyPtr_t  getNamedSky(const std::string &) const = 0;
    virtual LLSettingsWaterPtr_t getNamedWater(const std::string &) const = 0;

    void    setInitialized(bool value = true) { mInitialized = value; }
    CycleTrack_t &              getCycleTrack(S32 track);
protected:
    LLSettingsDay();

    virtual void                updateSettings();

    virtual validation_list_t   getValidationList() const;

    bool                        mInitialized;

private:
    LLSettingsBlender::ptr_t    mSkyBlender;    // convert to [] for altitudes 
    LLSettingsBlender::ptr_t    mWaterBlender;

    LLSettingsSkyPtr_t          mBlendedSky;
    LLSettingsWaterPtr_t        mBlendedWater;

    CycleList_t                 mDayTracks;

    F64Seconds                  mLastUpdateTime;

    S64Seconds                  mDayLength; 
    S64Seconds                  mDayOffset;

    F32                         secondsToKeyframe(S64Seconds seconds);
    F64Seconds                  keyframeToSeconds(F32 keyframe);

    void                        parseFromLLSD(LLSD &data);

    static CycleTrack_t::iterator   getEntryAtOrBefore(CycleTrack_t &track, F32 keyframe);
    static CycleTrack_t::iterator   getEntryAtOrAfter(CycleTrack_t &track, F32 keyframe);

    TrackBound_t                getBoundingEntries(CycleTrack_t &track, F32 keyframe);
    TrackBound_t                getBoundingEntries(CycleTrack_t &track, F64Seconds time);

    void                        onSkyTransitionDone(S32 track, const LLSettingsBlender::ptr_t &blender);
    void                        onWaterTransitionDone(const LLSettingsBlender::ptr_t &blender);

};

#endif