Geometry.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 Geometry_INCLUDE_ONCE
#define Geometry_INCLUDE_ONCE

#include <vlGraphics/IVertexAttribSet.hpp>
#include <vlGraphics/BufferObject.hpp>
#include <vlCore/Vector2.hpp>
#include <vlCore/Vector4.hpp>
#include <vlGraphics/Renderable.hpp>
#include <vlCore/vlnamespace.hpp>
#include <vlCore/Log.hpp>
#include <vlCore/Say.hpp>
#include <vlCore/Colors.hpp>
#include <vlGraphics/DrawElements.hpp>
#include <vlGraphics/DrawArrays.hpp>
#include <vlCore/Collection.hpp>

namespace vl
{
  class OpenGLContext;

  //------------------------------------------------------------------------------
  // Geometry
  //------------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT Geometry: public Renderable, public IVertexAttribSet
  {
    VL_INSTRUMENT_CLASS(vl::Geometry, Renderable)

    // use deepCopy() and shallowCopy() instead
    // Geometry(const Geometry& other): Renderable(other) { }
    Geometry& operator=(const Geometry&) { return *this; }

  public:
    Geometry();

    virtual ~Geometry();

    ref<Geometry> shallowCopy() const;

    Geometry& shallowCopyFrom(const Geometry&);

    ref<Geometry> deepCopy() const;

    Geometry& deepCopyFrom(const Geometry&);

    Collection<DrawCall>& drawCalls() { return mDrawCalls; }

    const Collection<DrawCall>& drawCalls() const { return mDrawCalls; }

    void setColorArray(const fvec4& color)
    {
      u32 vert_count = (u32)(vertexArray() ? vertexArray()->size() : 0);
      VL_CHECK( vert_count )

      // try to minimize reallocations
      ref<ArrayFloat4> color_array = colorArray()->as<ArrayFloat4>();
      if ( ! color_array ) {
        color_array = new ArrayFloat4;
      }
      if ( color_array->size() != vert_count ) {
        color_array->resize(vert_count);
      }
      for( u32 i = 0; i < color_array->size(); ++i ) {
        color_array->at( i ) = color;
      }
      color_array->setBufferObjectDirty();
      setBufferObjectDirty();

      setColorArray(color_array.get());
    }

    virtual void clearArrays(bool clear_draw_calls=true);

    // --- Renderable interface implementation ---

    virtual void updateDirtyBufferObject(EBufferObjectUpdateMode mode);

    virtual void deleteBufferObject();

    // ------------------------------------------------------------------------
    // Geometry Tools
    // ------------------------------------------------------------------------

    void computeNormals(bool verbose=false);

    bool flipNormals();

    void fixTriangleWinding();

    void transform(const mat4&matr, bool normalize = true);

    void convertDrawCallToDrawArrays();

    DrawCall* mergeTriangleStrips();

    void mergeDrawCallsWithPrimitiveRestart(EPrimitiveType primitive_type);

    void mergeDrawCallsWithMultiDrawElements(EPrimitiveType primitive_type);

    void mergeDrawCallsWithTriangles(EPrimitiveType primitive_type);

    void triangulateDrawCalls();

    void shrinkDrawCalls();

    void makeGLESFriendly();

    bool sortVertices();

    void regenerateVertices(const std::vector<u32>& map_new_to_old);

    void colorizePrimitives();

    // Based on:
    // Lengyel, Eric. “Computing Tangent Space Basis Vectors for an Arbitrary Mesh”. Terathon Software 3D Graphics Library, 2001.
    // http://www.terathon.com/code/tangent.html
    static void computeTangentSpace(
      u32 vert_count,
      const vl::fvec3 *vertex,
      const vl::fvec3* normal,
      const vl::fvec2 *texcoord,
      const vl::DrawCall* primitives,
      vl::fvec3 *tangent,
      vl::fvec3 *bitangent );

    // ------------------------------------------------------------------------
    // IVertexAttribSet Interface Implementation
    // ------------------------------------------------------------------------

    void setVertexArray(ArrayAbstract* data);

    const ArrayAbstract* vertexArray() const { return mVertexAttribArrays[VA_Position].get(); }

    ArrayAbstract* vertexArray() { return mVertexAttribArrays[VA_Position].get(); }

    void setNormalArray(ArrayAbstract* data);

    const ArrayAbstract* normalArray() const { return mVertexAttribArrays[VA_Normal].get(); }

    ArrayAbstract* normalArray() { return mVertexAttribArrays[VA_Normal].get(); }

    void setColorArray(ArrayAbstract* data);

    const ArrayAbstract* colorArray() const { return mVertexAttribArrays[VA_Color].get(); }

    ArrayAbstract* colorArray() { return mVertexAttribArrays[VA_Color].get(); }

    void setSecondaryColorArray(ArrayAbstract* data);

    const ArrayAbstract* secondaryColorArray() const { return mVertexAttribArrays[VA_SecondaryColor].get(); }

    ArrayAbstract* secondaryColorArray() { return mVertexAttribArrays[VA_SecondaryColor].get(); }

    void setFogCoordArray(ArrayAbstract* data);

    const ArrayAbstract* fogCoordArray() const { return mVertexAttribArrays[VA_FogCoord].get(); }

    ArrayAbstract* fogCoordArray() { return mVertexAttribArrays[VA_FogCoord].get(); }

    void setTexCoordArray(int tex_unit, ArrayAbstract* data);

    const ArrayAbstract* texCoordArray(int tex_unit) const { return mVertexAttribArrays[VA_TexCoord0 + tex_unit].get(); }

    ArrayAbstract* texCoordArray(int tex_unit) { return mVertexAttribArrays[VA_TexCoord0 + tex_unit].get(); }

    void setVertexAttribArray(int attrib_location, const ArrayAbstract* info);

    const ArrayAbstract* vertexAttribArray(int attrib_location) const;

    ArrayAbstract* vertexAttribArray(int attrib_location);

  protected:
    virtual void computeBounds_Implementation();

    virtual void render_Implementation(const Actor* actor, const Shader* shader, const Camera* camera, OpenGLContext* gl_context) const;

    // render calls
    Collection<DrawCall> mDrawCalls;

    // vertex attributes
    ref<ArrayAbstract> mVertexAttribArrays[VA_MaxAttribCount];
  };
  //------------------------------------------------------------------------------
}

#endif