summaryrefslogtreecommitdiff
path: root/indra/newview/llsurfacepatch.h
blob: 94d471b43dfc0c2411a9e72192491aff4fdd7f5f (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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/**
 * @file llsurfacepatch.h
 * @brief LLSurfacePatch class definition
 *
 * $LicenseInfo:firstyear=2001&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_LLSURFACEPATCH_H
#define LL_LLSURFACEPATCH_H

#include "v3math.h"
#include "v3dmath.h"
#include "llpointer.h"

class LLSurface;
class LLVOSurfacePatch;
class LLVector2;
class LLColor4U;
class LLAgent;

// A patch shouldn't know about its visibility since that really depends on the
// camera that is looking (or not looking) at it.  So, anything about a patch
// that is specific to a camera should be in the class below.
class LLPatchVisibilityInfo
{
public:
    LLPatchVisibilityInfo() :
        mbIsVisible(FALSE),
        mDistance(0.f),
        mRenderLevel(0),
        mRenderStride(0) { };
    ~LLPatchVisibilityInfo() { };

    BOOL mbIsVisible;
    F32 mDistance;          // Distance from camera
    S32 mRenderLevel;
    U32 mRenderStride;
};



class LLSurfacePatch
{
public:
    LLSurfacePatch();
    ~LLSurfacePatch();

    void reset(const U32 id);
    void connectNeighbor(LLSurfacePatch *neighborp, const U32 direction);
    void disconnectNeighbor(LLSurface *surfacep);

    void setNeighborPatch(const U32 direction, LLSurfacePatch *neighborp);
    LLSurfacePatch *getNeighborPatch(const U32 direction) const;

    void colorPatch(const U8 r, const U8 g, const U8 b);

    BOOL updateTexture();

    void updateVerticalStats();
    void updateCompositionStats();
    template<bool PBR>
    void updateNormals();

    void updateEastEdge();
    void updateNorthEdge();

    void updateCameraDistanceRegion( const LLVector3 &pos_region);
    void updateVisibility();
    void updateGL();

    void dirtyZ(); // Dirty the z values of this patch
    void setHasReceivedData();
    BOOL getHasReceivedData() const;

    F32 getDistance() const;
    F32 getMaxZ() const;
    F32 getMinZ() const;
    F32 getMeanComposition() const;
    F32 getMinComposition() const;
    F32 getMaxComposition() const;
    const LLVector3 &getCenterRegion() const;
    const U64 &getLastUpdateTime() const;
    LLSurface *getSurface() const { return mSurfacep; }
    LLVector3 getPointAgent(const U32 x, const U32 y) const; // get the point at the offset.
    LLVector2 getTexCoords(const U32 x, const U32 y) const;

    // Per-vertex normals
    // *TODO: PBR=true is a test implementation solely for proof-of-concept.
    // Final implementation would likely be very different and may not even use
    // this function. If we decide to keep calcNormalFlat, remove index as it
    // is a debug parameter for testing.
    template<bool PBR>
    void calcNormal(const U32 x, const U32 y, const U32 stride);
    const LLVector3 &getNormal(const U32 x, const U32 y) const;

    // Per-triangle normals for flat edges
    void calcNormalFlat(LLVector3& normal_out, const U32 x, const U32 y, const U32 index /* 0 or 1 */);

    void eval(const U32 x, const U32 y, const U32 stride,
                LLVector3 *vertex, LLVector3 *normal, LLVector2 *tex0, LLVector2 *tex1);



    LLVector3 getOriginAgent() const;
    const LLVector3d &getOriginGlobal() const;
    void setOriginGlobal(const LLVector3d &origin_global);

    // connectivity -- each LLPatch points at 5 neighbors (or NULL)
    // +---+---+---+
    // |   | 2 | 5 |
    // +---+---+---+
    // | 3 | 0 | 1 |
    // +---+---+---+
    // | 6 | 4 |   |
    // +---+---+---+


    BOOL getVisible() const;
    U32 getRenderStride() const;
    S32 getRenderLevel() const;

    void setSurface(LLSurface *surfacep);
    void setDataZ(F32 *data_z)                  { mDataZ = data_z; }
    void setDataNorm(LLVector3 *data_norm)      { mDataNorm = data_norm; }
    F32 *getDataZ() const                       { return mDataZ; }

    void dirty();           // Mark this surface patch as dirty...
    void clearDirty()                           { mDirty = FALSE; }

    void clearVObj();

public:
    BOOL mHasReceivedData;  // has the patch EVER received height data?
    BOOL mSTexUpdate;       // Does the surface texture need to be updated?

protected:
    LLSurfacePatch *mNeighborPatches[8]; // Adjacent patches
    BOOL mNormalsInvalid[9];  // Which normals are invalid

    BOOL mDirty;
    BOOL mDirtyZStats;
    BOOL mHeightsGenerated;

    U32 mDataOffset;
    F32 *mDataZ;
    LLVector3 *mDataNorm;

    // Pointer to the LLVOSurfacePatch object which is used in the new renderer.
    LLPointer<LLVOSurfacePatch> mVObjp;

    // All of the camera-dependent stuff should be in its own class...
    LLPatchVisibilityInfo mVisInfo;

    // pointers to beginnings of patch data fields
    LLVector3d mOriginGlobal;
    LLVector3 mOriginRegion;


    // height field stats
    LLVector3 mCenterRegion; // Center in region-local coords
    F32 mMinZ, mMaxZ, mMeanZ;
    F32 mRadius;

    F32 mMinComposition;
    F32 mMaxComposition;
    F32 mMeanComposition;

    U8 mConnectedEdge;      // This flag is non-zero iff patch is on at least one edge
                            // of LLSurface that is "connected" to another LLSurface
    U64 mLastUpdateTime;    // Time patch was last updated

    LLSurface *mSurfacep; // Pointer to "parent" surface
};

extern template void LLSurfacePatch::updateNormals</*PBR=*/false>();
extern template void LLSurfacePatch::updateNormals</*PBR=*/true>();


#endif // LL_LLSURFACEPATCH_H