summaryrefslogtreecommitdiff
path: root/indra/llcharacter/llkeyframemotionparam.h
blob: c906a25ceb4b12988f7ed371e301c0c2a439320a (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
/**
 * @file llkeyframemotionparam.h
 * @brief Implementation of LLKeframeMotionParam class.
 *
 * $LicenseInfo:firstyear=2002&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, 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_LLKEYFRAMEMOTIONPARAM_H
#define LL_LLKEYFRAMEMOTIONPARAM_H

//-----------------------------------------------------------------------------
// Header files
//-----------------------------------------------------------------------------

#include <string>

#include "llmotion.h"
#include "lljointstate.h"
#include "v3math.h"
#include "llquaternion.h"
#include "llkeyframemotion.h"

//-----------------------------------------------------------------------------
// class LLKeyframeMotionParam
//-----------------------------------------------------------------------------
class LLKeyframeMotionParam :
    public LLMotion
{
public:
    // Constructor
    LLKeyframeMotionParam(const LLUUID &id);

    // Destructor
    virtual ~LLKeyframeMotionParam();

public:
    //-------------------------------------------------------------------------
    // functions to support MotionController and MotionRegistry
    //-------------------------------------------------------------------------

    // static constructor
    // all subclasses must implement such a function and register it
    static LLMotion *create(const LLUUID &id) { return new LLKeyframeMotionParam(id); }

public:
    //-------------------------------------------------------------------------
    // animation callbacks to be implemented by subclasses
    //-------------------------------------------------------------------------

    // motions must specify whether or not they loop
    virtual BOOL getLoop() {
        return TRUE;
    }

    // motions must report their total duration
    virtual F32 getDuration() {
        return mDuration;
    }

    // motions must report their "ease in" duration
    virtual F32 getEaseInDuration() {
        return mEaseInDuration;
    }

    // motions must report their "ease out" duration.
    virtual F32 getEaseOutDuration() {
        return mEaseOutDuration;
    }

    // motions must report their priority
    virtual LLJoint::JointPriority getPriority() {
        return mPriority;
    }

    virtual LLMotionBlendType getBlendType() { return NORMAL_BLEND; }

    // called to determine when a motion should be activated/deactivated based on avatar pixel coverage
    virtual F32 getMinPixelArea() { return MIN_REQUIRED_PIXEL_AREA_KEYFRAME; }

    // run-time (post constructor) initialization,
    // called after parameters have been set
    // must return true to indicate success and be available for activation
    virtual LLMotionInitStatus onInitialize(LLCharacter *character);

    // called when a motion is activated
    // must return TRUE to indicate success, or else
    // it will be deactivated
    virtual BOOL onActivate();

    // called per time step
    // must return TRUE while it is active, and
    // must return FALSE when the motion is completed.
    virtual BOOL onUpdate(F32 time, U8* joint_mask);

    // called when a motion is deactivated
    virtual void onDeactivate();

    virtual LLPose* getPose() { return mPoseBlender.getBlendedPose();}

protected:
    //-------------------------------------------------------------------------
    // new functions defined by this subclass
    //-------------------------------------------------------------------------
    struct ParameterizedMotion
    {
        ParameterizedMotion(LLMotion* motion, F32 param) : mMotion(motion), mParam(param) {}
        LLMotion* mMotion;
        F32 mParam;
    };

    // add a motion and associated parameter triplet
    BOOL addKeyframeMotion(char *name, const LLUUID &id, char *param, F32 value);

    // set default motion for LOD and retrieving blend constants
    void setDefaultKeyframeMotion(char *);

    BOOL loadMotions();

protected:
    //-------------------------------------------------------------------------
    // Member Data
    //-------------------------------------------------------------------------

    struct compare_motions
    {
        bool operator() (const ParameterizedMotion& a, const ParameterizedMotion& b) const
        {
            if (a.mParam != b.mParam)
                return (a.mParam < b.mParam);
            else
                return a.mMotion < b.mMotion;
        }
    };

    typedef std::set < ParameterizedMotion, compare_motions > motion_list_t;
    typedef std::map <std::string, motion_list_t > motion_map_t;
    motion_map_t        mParameterizedMotions;
    LLMotion*           mDefaultKeyframeMotion;
    LLCharacter*        mCharacter;
    LLPoseBlender       mPoseBlender;

    F32                 mEaseInDuration;
    F32                 mEaseOutDuration;
    F32                 mDuration;
    LLJoint::JointPriority  mPriority;

    LLUUID              mTransactionID;
};

#endif // LL_LLKEYFRAMEMOTIONPARAM_H