InstanceGroup.h

// ======================================================================== //
// Copyright 2019-2020 Ingo Wald                                            //
//                                                                          //
// Licensed under the Apache License, Version 2.0 (the "License");          //
// you may not use this file except in compliance with the License.         //
// You may obtain a copy of the License at                                  //
//                                                                          //
//     http://www.apache.org/licenses/LICENSE-2.0                           //
//                                                                          //
// Unless required by applicable law or agreed to in writing, software      //
// distributed under the License is distributed on an "AS IS" BASIS,        //
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. //
// See the License for the specific language governing permissions and      //
// limitations under the License.                                           //
// ======================================================================== //
 
#pragma once
 
#include "Group.h"
 
namespace owl {
 
  struct InstanceGroup : public Group {
    typedef std::shared_ptr<InstanceGroup> SP;
    
    struct DeviceData : public Group::DeviceData {
      typedef std::shared_ptr<DeviceData> SP;
      
      DeviceData(const DeviceContext::SP &device);
      
      DeviceMemory optixInstanceBuffer;
 
      DeviceMemory motionTransformsBuffer;
      DeviceMemory outputBuffer;
 
      CUfunction instanceFuncKernel = 0;
 
      CUfunction motionInstanceFuncKernel = 0;
    };
    
    InstanceGroup(Context *const context,
                  size_t numChildren,
                  Group::SP *groups,
                  unsigned int buildFlags,
                  bool useInstanceProgram);
 
    std::string toString() const override;
    
    void setChild(size_t childID, Group::SP child);
                  
    void setTransform(size_t childID, const affine3f &xfm);
 
    void setTransforms(uint32_t timeStep,
                       const float *floatsForThisStimeStep,
                       OWLMatrixFormat matrixFormat);
 
    /* set instance IDs to use for the children - MUST be an array of
       children.size() items */
    void setInstanceIDs(const uint32_t *instanceIDs);
 
    /* set visibility masks to use for the children - MUST be an array of
       children.size() items */
    void setVisibilityMasks(const uint8_t *visibilityMasks);
 
    void setInstanceProg(Module::SP module,
                         const std::string &progName);
    
    void setMotionInstanceProg(Module::SP module,
                               const std::string &progName);
    
    void buildInstanceProg();
 
    void buildMotionInstanceProg();
 
    void buildAccel(LaunchParams::SP launchParams = nullptr) override;
    void refitAccel(LaunchParams::SP launchParams = nullptr) override;
 
    RegisteredObject::DeviceData::SP createOn(const DeviceContext::SP &device) override;
    
    inline DeviceData &getDD(const DeviceContext::SP &device) const;
 
    template<bool FULL_REBUILD>
    void staticBuildOn(const DeviceContext::SP &device);
    template<bool FULL_REBUILD>
    void motionBlurBuildOn(const DeviceContext::SP &device);
 
    template<bool FULL_REBUILD>
    void staticDeviceBuildOn(const DeviceContext::SP &device, LaunchParams::SP launchParams);
    template<bool FULL_REBUILD>
    void motionBlurDeviceBuildOn(const DeviceContext::SP &device, LaunchParams::SP launchParams);
    
    int getSBTOffset() const override { return 0; }
    
    size_t numChildren;
 
    std::vector<Group::SP>  children;
    
    std::vector<affine3f>   transforms[2];
 
    std::vector<uint32_t>   instanceIDs;
 
    std::vector<uint8_t> visibilityMasks;
 
    constexpr static unsigned int defaultBuildFlags = 
        OPTIX_BUILD_FLAG_PREFER_FAST_TRACE;
 
    protected:
    const unsigned int buildFlags;
 
    bool useInstanceProgram;
 
    ProgramDesc instanceProg;
 
    ProgramDesc motionInstanceProg;
  };
 
  // ------------------------------------------------------------------
  // implementation section
  // ------------------------------------------------------------------
  
  inline InstanceGroup::DeviceData &InstanceGroup::getDD(const DeviceContext::SP &device) const
  {
    assert(device && device->ID < (int)deviceData.size());
    return deviceData[device->ID]->as<DeviceData>();
  }
  
} // ::owl