bufferArrayRange.h

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_IMAGING_HD_BUFFER_ARRAY_RANGE_H
#define PXR_IMAGING_HD_BUFFER_ARRAY_RANGE_H

#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/version.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/vt/value.h"
#include "pxr/imaging/hd/bufferArray.h"

#include <memory>

PXR_NAMESPACE_OPEN_SCOPE


using HdBufferSpecVector = std::vector<struct HdBufferSpec>;
using HdBufferArrayRangeSharedPtr = std::shared_ptr<class HdBufferArrayRange>;
using HdBufferSourceSharedPtr = std::shared_ptr<class HdBufferSource>;

class HdBufferArrayRange 
{
public:

    HD_API
    HdBufferArrayRange();

    HD_API
    virtual ~HdBufferArrayRange();

    virtual bool IsValid() const = 0;

    virtual bool IsAssigned() const = 0;

    virtual bool IsImmutable() const = 0;

    virtual bool RequiresStaging() const = 0;

    virtual bool Resize(int numElements) = 0;

    virtual void CopyData(HdBufferSourceSharedPtr const &bufferSource) = 0;

    virtual VtValue ReadData(TfToken const &name) const = 0;

    virtual int GetElementOffset() const = 0;
    
    virtual int GetByteOffset(TfToken const& resourceName) const = 0;
    
    virtual size_t GetNumElements() const = 0;

    virtual size_t GetVersion() const = 0;

    virtual void IncrementVersion() = 0;

    virtual size_t GetMaxNumElements() const = 0;

    virtual HdBufferArrayUsageHint GetUsageHint() const = 0;

    virtual void SetBufferArray(HdBufferArray *bufferArray) = 0;

    virtual void DebugDump(std::ostream &out) const = 0;

    bool IsAggregatedWith(HdBufferArrayRangeSharedPtr const &other) const {
        return (other && (_GetAggregation() == other->_GetAggregation()));
    }

    virtual void GetBufferSpecs(HdBufferSpecVector *bufferSpecs) const = 0;

protected:
    virtual const void *_GetAggregation() const = 0;

    // Don't allow copies
    HdBufferArrayRange(const HdBufferArrayRange &) = delete;
    HdBufferArrayRange &operator=(const HdBufferArrayRange &) = delete;

};

HD_API
std::ostream &operator <<(std::ostream &out,
                          const HdBufferArrayRange &self);

class HdBufferArrayRangeContainer
{
public:
    HdBufferArrayRangeContainer(int size) : _ranges(size) { }

    HD_API
    void Set(int index, HdBufferArrayRangeSharedPtr const &range);

    HD_API
    HdBufferArrayRangeSharedPtr const &Get(int index) const;

    HD_API
    void Resize(int size);

private:
    std::vector<HdBufferArrayRangeSharedPtr> _ranges;
};


PXR_NAMESPACE_CLOSE_SCOPE

#endif  // PXR_IMAGING_HD_BUFFER_ARRAY_RANGE_H