summaryrefslogtreecommitdiff
path: root/indra/newview/llvovolume.h
blob: 88a10effb39601f13a134b6b3976aba12c42fe01 (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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
/**
 * @file llvovolume.h
 * @brief LLVOVolume class header file
 *
 * $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_LLVOVOLUME_H
#define LL_LLVOVOLUME_H

#include "llviewerobject.h"
#include "llviewertexture.h"
#include "llviewermedia.h"
#include "llframetimer.h"
#include "lllocalbitmaps.h"
#include "m3math.h"     // LLMatrix3
#include "m4math.h"     // LLMatrix4
#include <unordered_map>
#include <unordered_set>


class LLViewerTextureAnim;
class LLDrawPool;
class LLMaterialID;
class LLSelectNode;
class LLObjectMediaDataClient;
class LLObjectMediaNavigateClient;
class LLVOAvatar;
class LLMeshSkinInfo;

typedef std::vector<viewer_media_t> media_list_t;

enum LLVolumeInterfaceType
{
    INTERFACE_FLEXIBLE = 1,
};

const F32 MAX_LOD_FACTOR = 4.0f;


class LLRiggedVolume : public LLVolume
{
public:
    LLRiggedVolume(const LLVolumeParams& params)
        : LLVolume(params, 0.f)
    {
    }

    using FaceIndex = S32;
    static const FaceIndex UPDATE_ALL_FACES = -1;
    static const FaceIndex DO_NOT_UPDATE_FACES = -2;
    void update(
        const LLMeshSkinInfo* skin,
        LLVOAvatar* avatar,
        const LLVolume* src_volume,
        FaceIndex face_index = UPDATE_ALL_FACES,
        bool rebuild_face_octrees = true);

    std::string mExtraDebugText;
};

// Base class for implementations of the volume - Primitive, Flexible Object, etc.
class LLVolumeInterface
{
public:
    virtual ~LLVolumeInterface() { }
    virtual LLVolumeInterfaceType getInterfaceType() const = 0;
    virtual void doIdleUpdate() = 0;
    virtual BOOL doUpdateGeometry(LLDrawable *drawable) = 0;
    virtual LLVector3 getPivotPosition() const = 0;
    virtual void onSetVolume(const LLVolumeParams &volume_params, const S32 detail) = 0;
    virtual void onSetScale(const LLVector3 &scale, BOOL damped) = 0;
    virtual void onParameterChanged(U16 param_type, LLNetworkData *data, BOOL in_use, bool local_origin) = 0;
    virtual void onShift(const LLVector4a &shift_vector) = 0;
    virtual bool isVolumeUnique() const = 0; // Do we need a unique LLVolume instance?
    virtual bool isVolumeGlobal() const = 0; // Are we in global space?
    virtual bool isActive() const = 0; // Is this object currently active?
    virtual const LLMatrix4& getWorldMatrix(LLXformMatrix* xform) const = 0;
    virtual void updateRelativeXform(bool force_identity = false) = 0;
    virtual U32 getID() const = 0;
    virtual void preRebuild() = 0;
};

// Class which embodies all Volume objects (with pcode LL_PCODE_VOLUME)
class LLVOVolume : public LLViewerObject
{
    LOG_CLASS(LLVOVolume);
protected:
    virtual             ~LLVOVolume();

public:
    static      void    initClass();
    static      void    cleanupClass();
    static      void    preUpdateGeom();

    enum
    {
        VERTEX_DATA_MASK =  (1 << LLVertexBuffer::TYPE_VERTEX) |
                            (1 << LLVertexBuffer::TYPE_NORMAL) |
                            (1 << LLVertexBuffer::TYPE_TEXCOORD0) |
                            (1 << LLVertexBuffer::TYPE_TEXCOORD1) |
                            (1 << LLVertexBuffer::TYPE_COLOR)
    };

public:
    LLVOVolume(const LLUUID &id, const LLPCode pcode, LLViewerRegion *regionp);
    void markDead() override;       // Override (and call through to parent) to clean up media references

    LLDrawable* createDrawable(LLPipeline *pipeline) override;

                void    deleteFaces();

                void    animateTextures();

                BOOL    isVisible() const ;
    BOOL isActive() const override;
    BOOL isAttachment() const override;
    BOOL isRootEdit() const override; // overridden for sake of attachments treating themselves as a root object
    BOOL isHUDAttachment() const override;

                void    generateSilhouette(LLSelectNode* nodep, const LLVector3& view_point);
    /*virtual*/ BOOL    setParent(LLViewerObject* parent) override;
                S32     getLOD() const override             { return mLOD; }
                void    setNoLOD()                          { mLOD = NO_LOD; mLODChanged = TRUE; }
                bool    isNoLOD() const                     { return NO_LOD == mLOD; }
    const LLVector3     getPivotPositionAgent() const override;
    const LLMatrix4&    getRelativeXform() const                { return mRelativeXform; }
    const LLMatrix3&    getRelativeXformInvTrans() const        { return mRelativeXformInvTrans; }
    /*virtual*/ const LLMatrix4 getRenderMatrix() const override;
                typedef std::unordered_set<const LLViewerTexture*> texture_cost_t;
                static S32 getTextureCost(const LLViewerTexture* img);
                U32     getRenderCost(texture_cost_t &textures) const;
    /*virtual*/ F32     getEstTrianglesMax() const override;
    /*virtual*/ F32     getEstTrianglesStreamingCost() const override;
    /* virtual*/ F32    getStreamingCost() const override;
    /*virtual*/ bool getCostData(LLMeshCostData& costs) const override;

    /*virtual*/ U32     getTriangleCount(S32* vcount = NULL) const override;
    /*virtual*/ U32     getHighLODTriangleCount() override;
    /*virtual*/ BOOL lineSegmentIntersect(const LLVector4a& start, const LLVector4a& end,
                                          S32 face = -1,                        // which face to check, -1 = ALL_SIDES
                                          BOOL pick_transparent = FALSE,
                                          BOOL pick_rigged = FALSE,
                                          BOOL pick_unselectable = TRUE,
                                          S32* face_hit = NULL,                 // which face was hit
                                          LLVector4a* intersection = NULL,       // return the intersection point
                                          LLVector2* tex_coord = NULL,          // return the texture coordinates of the intersection point
                                          LLVector4a* normal = NULL,             // return the surface normal at the intersection point
                                          LLVector4a* tangent = NULL           // return the surface tangent at the intersection point
        ) override;

                LLVector3 agentPositionToVolume(const LLVector3& pos) const;
                LLVector3 agentDirectionToVolume(const LLVector3& dir) const;
                LLVector3 volumePositionToAgent(const LLVector3& dir) const;
                LLVector3 volumeDirectionToAgent(const LLVector3& dir) const;


                BOOL    getVolumeChanged() const                { return mVolumeChanged; }

    F32 getVObjRadius() const override              { return mVObjRadius; };
                const LLMatrix4& getWorldMatrix(LLXformMatrix* xform) const override;

                void    markForUpdate() override;
                void    faceMappingChanged() override           { mFaceMappingChanged=TRUE; }

    /*virtual*/ void    onShift(const LLVector4a &shift_vector) override; // Called when the drawable shifts

    /*virtual*/ void    parameterChanged(U16 param_type, bool local_origin) override;
    /*virtual*/ void    parameterChanged(U16 param_type, LLNetworkData* data, BOOL in_use, bool local_origin) override;

    // update mReflectionProbe based on isReflectionProbe()
    void updateReflectionProbePtr();

    /*virtual*/ U32     processUpdateMessage(LLMessageSystem *mesgsys,
                                            void **user_data,
                                            U32 block_num, const EObjectUpdateType update_type,
                                            LLDataPacker *dp) override;

    /*virtual*/ void    setSelected(BOOL sel) override;
    /*virtual*/ BOOL    setDrawableParent(LLDrawable* parentp) override;

    /*virtual*/ void    setScale(const LLVector3 &scale, BOOL damped) override;

    /*virtual*/ void    changeTEImage(S32 index, LLViewerTexture* new_image) override;
    /*virtual*/ void    setNumTEs(const U8 num_tes) override;
    /*virtual*/ void    setTEImage(const U8 te, LLViewerTexture *imagep) override;
    /*virtual*/ S32     setTETexture(const U8 te, const LLUUID &uuid) override;
    /*virtual*/ S32     setTEColor(const U8 te, const LLColor3 &color) override;
    /*virtual*/ S32     setTEColor(const U8 te, const LLColor4 &color) override;
    /*virtual*/ S32     setTEBumpmap(const U8 te, const U8 bump) override;
    /*virtual*/ S32     setTEShiny(const U8 te, const U8 shiny) override;
    /*virtual*/ S32     setTEFullbright(const U8 te, const U8 fullbright) override;
    /*virtual*/ S32     setTEBumpShinyFullbright(const U8 te, const U8 bump) override;
    /*virtual*/ S32     setTEMediaFlags(const U8 te, const U8 media_flags) override;
    /*virtual*/ S32     setTEGlow(const U8 te, const F32 glow) override;
    /*virtual*/ S32     setTEMaterialID(const U8 te, const LLMaterialID& pMaterialID) override;

    static void setTEMaterialParamsCallbackTE(const LLUUID& objectID, const LLMaterialID& pMaterialID, const LLMaterialPtr pMaterialParams, U32 te);

    /*virtual*/ S32     setTEMaterialParams(const U8 te, const LLMaterialPtr pMaterialParams) override;
                S32     setTEGLTFMaterialOverride(U8 te, LLGLTFMaterial* mat) override;
    /*virtual*/ S32     setTEScale(const U8 te, const F32 s, const F32 t) override;
    /*virtual*/ S32     setTEScaleS(const U8 te, const F32 s) override;
    /*virtual*/ S32     setTEScaleT(const U8 te, const F32 t) override;
    /*virtual*/ S32     setTETexGen(const U8 te, const U8 texgen) override;
    /*virtual*/ S32     setTEMediaTexGen(const U8 te, const U8 media) override;
    /*virtual*/ BOOL    setMaterial(const U8 material) override;

                void    setTexture(const S32 face);
                S32     getIndexInTex(U32 ch) const {return mIndexInTex[ch];}
    /*virtual*/ BOOL    setVolume(const LLVolumeParams &volume_params, const S32 detail, bool unique_volume = false) override;
                void    updateSculptTexture();
                void    setIndexInTex(U32 ch, S32 index) { mIndexInTex[ch] = index ;}
                void    sculpt();
     static     void    rebuildMeshAssetCallback(const LLUUID& asset_uuid,
                                                 LLAssetType::EType type,
                                                 void* user_data, S32 status, LLExtStat ext_status);

                void    updateRelativeXform(bool force_identity = false);
    /*virtual*/ BOOL    updateGeometry(LLDrawable *drawable) override;
    /*virtual*/ void    updateFaceSize(S32 idx) override;
    /*virtual*/ BOOL    updateLOD() override;
                void    updateRadius() override;
    /*virtual*/ void    updateTextures() override;
                void    updateTextureVirtualSize(bool forced = false);

                void    updateFaceFlags();
                void    regenFaces();
                BOOL    genBBoxes(BOOL force_global, BOOL should_update_octree_bounds = TRUE);
                void    preRebuild();
    virtual     void    updateSpatialExtents(LLVector4a& min, LLVector4a& max) override;
    virtual     F32     getBinRadius() override;

    virtual U32 getPartitionType() const override;

    // For Lights
    void setIsLight(BOOL is_light);
    //set the gamma-corrected (sRGB) color of this light
    void setLightSRGBColor(const LLColor3& color);
    //set the linear color of this light
    void setLightLinearColor(const LLColor3& color);

    void setLightIntensity(F32 intensity);
    void setLightRadius(F32 radius);
    void setLightFalloff(F32 falloff);
    void setLightCutoff(F32 cutoff);
    void setLightTextureID(LLUUID id);
    void setSpotLightParams(LLVector3 params);

    BOOL getIsLight() const;
    bool getIsLightFast() const;


    // Get the light color in sRGB color space NOT scaled by intensity.
    LLColor3 getLightSRGBBaseColor() const;

    // Get the light color in linear color space NOT scaled by intensity.
    LLColor3 getLightLinearBaseColor() const;

    // Get the light color in linear color space scaled by intensity
    //  this is the value that should be fed into shaders
    LLColor3 getLightLinearColor() const;

    // Get the light color in sRGB color space scaled by intensity.
    LLColor3 getLightSRGBColor() const;

    LLUUID  getLightTextureID() const;
    bool isLightSpotlight() const;
    LLVector3 getSpotLightParams() const;
    void    updateSpotLightPriority();
    F32     getSpotLightPriority() const;

    LLViewerTexture* getLightTexture();
    F32 getLightIntensity() const;
    F32 getLightRadius() const;
    F32 getLightFalloff(const F32 fudge_factor = 1.f) const;
    F32 getLightCutoff() const;

    // Reflection Probes
    bool setIsReflectionProbe(BOOL is_probe);
    bool setReflectionProbeAmbiance(F32 ambiance);
    bool setReflectionProbeNearClip(F32 near_clip);
    bool setReflectionProbeIsBox(bool is_box);
    bool setReflectionProbeIsDynamic(bool is_dynamic);

    BOOL isReflectionProbe() const override;
    F32 getReflectionProbeAmbiance() const;
    F32 getReflectionProbeNearClip() const;
    bool getReflectionProbeIsBox() const;
    bool getReflectionProbeIsDynamic() const;

    // Flexible Objects
    U32 getVolumeInterfaceID() const;
    virtual BOOL isFlexible() const override;
    virtual BOOL isSculpted() const override;
    virtual BOOL isMesh() const override;
    virtual BOOL isRiggedMesh() const override;
    virtual BOOL hasLightTexture() const override;

    // fast variants above that use state that is filled in later
    //  not reliable early in the life of an object, but should be used after
    //  object is loaded
    bool isFlexibleFast() const;
    bool isSculptedFast() const;
    bool isMeshFast() const;
    bool isRiggedMeshFast() const;
    bool isAnimatedObjectFast() const;

    BOOL isVolumeGlobal() const;
    BOOL canBeFlexible() const;
    BOOL setIsFlexible(BOOL is_flexible);

    const LLMeshSkinInfo* getSkinInfo() const;
    const bool isSkinInfoUnavaliable() const { return mSkinInfoUnavaliable; }

    //convenience accessor for mesh ID (which is stored in sculpt id for legacy reasons)
    const LLUUID& getMeshID() const { return getVolume()->getParams().getSculptID(); }

    // Extended Mesh Properties
    U32 getExtendedMeshFlags() const;
    void onSetExtendedMeshFlags(U32 flags);
    void setExtendedMeshFlags(U32 flags);
    bool canBeAnimatedObject() const;
    bool isAnimatedObject() const override;
    virtual void onReparent(LLViewerObject *old_parent, LLViewerObject *new_parent) override;
    virtual void afterReparent() override;

    //virtual
    void updateRiggingInfo() override;
    S32 mLastRiggingInfoLOD;

    // Functions that deal with media, or media navigation

    // Update this object's media data with the given media data array
    // (typically this is only called upon a response from a server request)
    void updateObjectMediaData(const LLSD &media_data_array, const std::string &media_version);

    // Bounce back media at the given index to its current URL (or home URL, if current URL is empty)
    void mediaNavigateBounceBack(U8 texture_index);

    // Returns whether or not this object has permission to navigate or control
    // the given media entry
    enum MediaPermType {
        MEDIA_PERM_INTERACT, MEDIA_PERM_CONTROL
    };
    bool hasMediaPermission(const LLMediaEntry* media_entry, MediaPermType perm_type);

    void mediaNavigated(LLViewerMediaImpl *impl, LLPluginClassMedia* plugin, std::string new_location);
    void mediaEvent(LLViewerMediaImpl *impl, LLPluginClassMedia* plugin, LLViewerMediaObserver::EMediaEvent event);


    // Sync the given media data with the impl and the given te
    void syncMediaData(S32 te, const LLSD &media_data, bool merge, bool ignore_agent);

    // Send media data update to the simulator.
    void sendMediaDataUpdate();

    viewer_media_t getMediaImpl(U8 face_id) const;
    S32 getFaceIndexWithMediaImpl(const LLViewerMediaImpl* media_impl, S32 start_face_id);
    F64 getTotalMediaInterest() const;

    bool hasMedia() const;

    LLVector3 getApproximateFaceNormal(U8 face_id);

    // Flag any corresponding avatars as needing update.
    void updateVisualComplexity();

    void notifyMeshLoaded();
    void notifySkinInfoLoaded(const LLMeshSkinInfo* skin);
    void notifySkinInfoUnavailable();

    // Returns 'true' iff the media data for this object is in flight
    bool isMediaDataBeingFetched() const;

    // Returns the "last fetched" media version, or -1 if not fetched yet
    S32 getLastFetchedMediaVersion() const { return mLastFetchedMediaVersion; }

    void addMDCImpl() { ++mMDCImplCount; }
    void removeMDCImpl() { --mMDCImplCount; }
    S32 getMDCImplCount() { return mMDCImplCount; }


    // Rigged volume update (for raycasting)
    // By default, this updates the bounding boxes of all the faces and builds an octree for precise per-triangle raycasting
    void updateRiggedVolume(
        bool force_treat_as_rigged,
        LLRiggedVolume::FaceIndex face_index = LLRiggedVolume::UPDATE_ALL_FACES,
        bool rebuild_face_octrees = true);
    LLRiggedVolume* getRiggedVolume();

    //returns true if volume should be treated as a rigged volume
    // - Build tools are open
    // - object is an attachment
    // - object is attached to self
    // - object is rendered as rigged
    bool treatAsRigged();

    //clear out rigged volume and revert back to non-rigged state for picking/LOD/distance updates
    void clearRiggedVolume();

protected:
    S32 computeLODDetail(F32 distance, F32 radius, F32 lod_factor);
    BOOL calcLOD();
    LLFace* addFace(S32 face_index);

    // stats tracking for render complexity
    static S32 mRenderComplexity_last;
    static S32 mRenderComplexity_current;

    void onDrawableUpdateFromServer();
    void requestMediaDataUpdate(bool isNew);
    void cleanUpMediaImpls();
    void addMediaImpl(LLViewerMediaImpl* media_impl, S32 texture_index) ;
    void removeMediaImpl(S32 texture_index) ;

private:
    bool lodOrSculptChanged(LLDrawable *drawable, BOOL &compiled, BOOL &shouldUpdateOctreeBounds);

public:

    static S32 getRenderComplexityMax() {return mRenderComplexity_last;}
    static void updateRenderComplexity();

    LLViewerTextureAnim *mTextureAnimp;
    U8 mTexAnimMode;
    F32 mLODDistance;
    F32 mLODAdjustedDistance;
    F32 mLODRadius;
private:
    friend class LLDrawable;
    friend class LLFace;

    BOOL        mFaceMappingChanged;
    LLFrameTimer mTextureUpdateTimer;
    S32         mLOD;
    BOOL        mLODChanged;
    BOOL        mSculptChanged;
    BOOL        mColorChanged;
    F32         mSpotLightPriority;
    LLMatrix4   mRelativeXform;
    LLMatrix3   mRelativeXformInvTrans;
    BOOL        mVolumeChanged;
    F32         mVObjRadius;
    LLVolumeInterface *mVolumeImpl;
    LLPointer<LLViewerFetchedTexture> mSculptTexture;
    LLPointer<LLViewerFetchedTexture> mLightTexture;
    media_list_t mMediaImplList;
    S32         mLastFetchedMediaVersion; // as fetched from the server, starts as -1
    U32         mServerDrawableUpdateCount;
    S32 mIndexInTex[LLRender::NUM_VOLUME_TEXTURE_CHANNELS];
    S32 mMDCImplCount;

    // cached value of getIsLight to avoid redundant map lookups
    // accessed by getIsLightFast
    mutable bool mIsLight = false;

    // cached value of getIsAnimatedObject to avoid redundant map lookups
    // accessed by getIsAnimatedObjectFast
    mutable bool mIsAnimatedObject = false;
    bool mResetDebugText;

    LLPointer<LLRiggedVolume> mRiggedVolume;

    bool mSkinInfoUnavaliable;
    LLConstPointer<LLMeshSkinInfo> mSkinInfo;
    // statics
public:
    static F32 sLODSlopDistanceFactor;// Changing this to zero, effectively disables the LOD transition slop
    static F32 sLODFactor;              // LOD scale factor
    static F32 sDistanceFactor;         // LOD distance factor

    static LLPointer<LLObjectMediaDataClient> sObjectMediaClient;
    static LLPointer<LLObjectMediaNavigateClient> sObjectMediaNavigateClient;
protected:
    static S32 sNumLODChanges;

    friend class LLVolumeImplFlexible;
};

#endif // LL_LLVOVOLUME_H