DrawCall.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://visualizationlibrary.org                                                   */
/*                                                                                    */
/*  Copyright (c) 2005-2020, Michele Bosi                                             */
/*  All rights reserved.                                                              */
/*                                                                                    */
/*  Redistribution and use in source and binary forms, with or without modification,  */
/*  are permitted provided that the following conditions are met:                     */
/*                                                                                    */
/*  - Redistributions of source code must retain the above copyright notice, this     */
/*  list of conditions and the following disclaimer.                                  */
/*                                                                                    */
/*  - Redistributions in binary form must reproduce the above copyright notice, this  */
/*  list of conditions and the following disclaimer in the documentation and/or       */
/*  other materials provided with the distribution.                                   */
/*                                                                                    */
/*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND   */
/*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED     */
/*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE            */
/*  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR  */
/*  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES    */
/*  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;      */
/*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON    */
/*  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT           */
/*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS     */
/*  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                      */
/*                                                                                    */
/**************************************************************************************/

#ifndef DrawCommand_INCLUDE_ONCE
#define DrawCommand_INCLUDE_ONCE

#include <vlGraphics/Array.hpp>
#include <vlGraphics/TriangleIterator.hpp>
#include <vlGraphics/IndexIterator.hpp>
#include <vlGraphics/PatchParameter.hpp>

namespace vl 
{
  //------------------------------------------------------------------------------
  // DrawCall
  //------------------------------------------------------------------------------
  class DrawCall: public Object
  {
    VL_INSTRUMENT_ABSTRACT_CLASS(vl::DrawCalls, Object)

  public:
    DrawCall(): mType(PT_TRIANGLES), mEnabled(true) {}

    DrawCall& operator=(const DrawCall& other)
    {
      mType      = other.mType;
      mEnabled   = other.mEnabled;
      return *this;
    }

    void setPrimitiveType(EPrimitiveType type) { mType = type; }

    EPrimitiveType primitiveType() const { return mType; }

    virtual void render(bool use_bo = true) const = 0;

    virtual ref<DrawCall> clone() const = 0;

    virtual void updateDirtyBufferObject(EBufferObjectUpdateMode) = 0;

    virtual void deleteBufferObject() = 0;

    void setEnabled(bool enable) { mEnabled = enable; }

    bool isEnabled() const { return mEnabled; }

    virtual TriangleIterator triangleIterator() const = 0;

    virtual IndexIterator indexIterator() const = 0;

    u32 countIndices() const
    {
      u32 count = 0;
      for( IndexIterator it = indexIterator(); it.hasNext(); it.next() )
        ++count;
      return count;
    }

    u32 countTriangles() const
    {
      u32 count = 0;
      for( TriangleIterator it = triangleIterator(); it.hasNext(); it.next() )
        ++count;
      return count;
    }

    virtual int instances() const { return 1; }

    virtual bool primitiveRestartEnabled() const { return false; }

    virtual unsigned int primitiveRestartIndex() { return 0; }

    void setPatchParameter(PatchParameter* patch_param) { mPatchParameter = patch_param; }

    PatchParameter* patchParameter() { return mPatchParameter.get(); }

    const PatchParameter* patchParameter() const { return mPatchParameter.get(); }

  protected:
    void applyPatchParameters() const
    {
      if (mType == PT_PATCHES && mPatchParameter)
        mPatchParameter->apply();

      if (mPatchParameter && mType != PT_PATCHES)
      {
        vl::Log::warning("PatchParameter used with non PT_PATCHES draw call!\n");
      }
      else
      if (!mPatchParameter && mType == PT_PATCHES)
      {
        vl::Log::warning("No PatchParameter supplied while using PT_PATCHES draw call!\n");
      }
    }

  protected:
      ref<PatchParameter> mPatchParameter;
      EPrimitiveType mType;
      bool mEnabled;
  };
}

#endif