instancer.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_ST_INSTANCER_H
#define PXR_IMAGING_HD_ST_INSTANCER_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdSt/api.h"
#include "pxr/imaging/hd/changeTracker.h"
#include "pxr/imaging/hd/instancer.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/base/vt/array.h"
#include "pxr/base/tf/hashmap.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdRprim;
class HdStDrawItem;
struct HdRprimSharedData;
 
using HdBufferArrayRangeSharedPtr = std::shared_ptr<class HdBufferArrayRange>;
 
 
class HdStInstancer : public HdInstancer {
public:
    HDST_API
    HdStInstancer(HdSceneDelegate* delegate, SdfPath const &id);
 
    // Updates the instance primvar buffers.
    // XXX: Note, this is currently called from rprimUtils instead of the
    // render index sync phase, so it needs to take a mutex.
    HDST_API
    void Sync(HdSceneDelegate *sceneDelegate,
              HdRenderParam   *renderParam,
              HdDirtyBits     *dirtyBits) override;
 
    HdBufferArrayRangeSharedPtr GetInstancePrimvarRange() const {
        return _instancePrimvarRange;
    }
 
    HDST_API
    VtIntArray GetInstanceIndices(SdfPath const &prototypeId);
 
    HDST_API
    bool HasDisplayOpacity() const;
 
    HDST_API
    bool HasNormals() const;
 
    HDST_API
    const GfMatrix4d& GetTransform() const;
 
    HDST_API
    const GfMatrix4d& GetTransformInverse() const;
 
protected:
    HDST_API
    void _GetInstanceIndices(SdfPath const &prototypeId,
                             std::vector<VtIntArray> *instanceIndicesArray);
 
    HDST_API
    void _SyncPrimvars(HdSceneDelegate *sceneDelegate,
                       HdDirtyBits *dirtyBits);
 
private:
    // # of entries in an instance primvar.  This should be consistent between
    // all primvars, and also consistent with the instance indices (meaning
    // no instance index is out-of-range).
    size_t _instancePrimvarNumElements;
 
    // The BAR of the instance primvars for this instancer.
    // (Note: instance indices are computed per prototype and the rprim owns
    // the bar).
    HdBufferArrayRangeSharedPtr _instancePrimvarRange;
 
    GfMatrix4d _transform;
    GfMatrix4d _transformInverse;
 
    // Visibility
    bool _visible : 1;
    bool _hasDisplayOpacity : 1;
    bool _hasNormals : 1;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif  // PXR_IMAGING_HD_ST_INSTANCER_H