vertex_array.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2020 by the OpenStructure authors
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 3.0 of the License, or (at your option)
// any later version.
// This library is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------
#ifndef OST_VERTEX_ARRAY_HH
#define OST_VERTEX_ARRAY_HH

/*
  encapsulation of vertex-array based OpenGL rendering

  Author: Ansgar Philippsen
*/

#include <vector>
#include <cassert>
#include <iostream>
#include <cmath>

#include <ost/log.hh>
#include <ost/geom/geom.hh>
#include <ost/geom/aligned_cuboid.hh>


#include "color.hh"
#include "material.hh"
#include "gfx_prim.hh"
#include "povray_fw.hh"
#include "exporter_fw.hh"

namespace ost { namespace gfx {

typedef unsigned int VertexID;
typedef unsigned int LineID;
typedef unsigned int TriID;
typedef unsigned int QuadID;
class DLLEXPORT_OST_GFX IndexedVertexArray {
 public:
  struct DLLEXPORT Entry {
    Entry()
    {
      v[0]=0.0; v[1]=0.0; v[2]=0.0;
      n[0]=0.0; n[1]=0.0; n[2]=1.0;
      c[0]=0.0; c[1]=0.0; c[2]=0.0; c[3]=0.0;
      t[0]=0.0; t[1]=0.0;
    }

    Entry(const geom::Vec3& vv, const geom::Vec3& nn, const Color& cc, 
          const geom::Vec2& tt)
    {
      v[0]=vv[0]; v[1]=vv[1]; v[2]=vv[2];
      n[0]=nn[0]; n[1]=nn[1]; n[2]=nn[2];
      c[0]=cc[0]; c[1]=cc[1]; c[2]=cc[2]; c[3]=cc[3];
      t[0]=tt[0]; t[1]=tt[1];
    }
    float t[2];
    float c[4];
    float n[3];
    float v[3];
  };

  struct NormalizerVertexEntry {
    geom::Vec3 pos;
    TriID tri_list[50];  // this is a hack until the iso-contouring is fixed
    uint tri_count;
    float weight;
  };

  struct NormalizerTriEntry {
    TriID tid;
    VertexID id0,id1,id2;
    geom::Vec3 norm;
    float weight;
  };

  typedef std::vector<Entry> EntryList;
  typedef std::vector<VertexID> IndexList;
  typedef std::vector<NormalizerVertexEntry> NVEntryList;
  typedef std::vector<NormalizerTriEntry> NTEntryList;

  IndexedVertexArray();
  ~IndexedVertexArray();

  IndexedVertexArray(const IndexedVertexArray& va);
  IndexedVertexArray& operator=(const IndexedVertexArray& va);

  static unsigned int GetFormat();

  void Cleanup();

  /*
    bitmask : 0 = render points only
              1 = render lines
              2 = render tris and quads
   */
  void SetMode(int m);
  int GetMode() const;

  // polygon mode, 2:fill, 1:line, 0:point (different to overall mode)
  void SetPolyMode(int m);

  void SetLighting(bool f);
  void SetTwoSided(bool f);
  void SetCullFace(bool f);
  void SetColorMaterial(bool f);
  void SetLineWidth(float lw);
  void SetAALines(bool f);
  void SetPointSize(float ps);
  void SetLineHalo(float lh);

  void SetOutlineMode(int m);
  int GetOutlineMode() const {return outline_mode_;}
  void SetOutlineWidth(float f);
  float GetOutlineWidth() const {return outline_width_;}
  void SetOutlineMaterial(const Material& m);
  void SetOutlineExpandFactor(float f);
  float GetOutlineExpandFactor() const {return outline_exp_factor_;}
  void SetOutlineExpandColor(const Color& c);
  Color GetOutlineExpandColor() const {return outline_exp_color_;}

  void SetSolid(bool f) {solid_=f;}
  bool GetSolid() const {return solid_;}
  void SetSolidColor(const Color& c) {solid_color_=c;}
  Color GetSolidcolor() const {return solid_color_;}
  void SetClipOffset(float f) {clip_offset_=f;}
  float GetClipOffset() const {return clip_offset_;}

  // vertex, normal, color and texcoord (T2F_C4F_N3F_V3F)
  VertexID Add(const geom::Vec3& vert, const geom::Vec3& norm, 
               const Color& col, const geom::Vec2& texc=geom::Vec2()) {
    dirty_=true;
    entry_list_.push_back(Entry(vert,norm,col,texc));
    entry_list_.back().c[3] = opacity_;
    return entry_list_.size()-1;
  }

  unsigned int GetVertexCount() const;
  void DumpVertices() const;

  // add line given two vertex ids 
  LineID AddLine(VertexID id0, VertexID id1);

  // add triangle given three vertex ids
  TriID AddTri(VertexID id0, VertexID id1, VertexID id2);

  // as above, but generate a normal based on the given ids
  TriID AddTriN(VertexID id0, VertexID id1, VertexID id2);

  // add quad given four vertex ids
  QuadID AddQuad(VertexID id0, VertexID id1, VertexID id2, VertexID id3);

  // add a normal sphere
  void AddSphere(const SpherePrim& prim, unsigned int detail);

  // add an icosahedral based sphere with the given params to the va
  void AddIcoSphere(const SpherePrim& prim, unsigned int detail);

  void AddCylinder(const CylinderPrim& prim, unsigned int detail,bool cap=false);

  void SetOpacity(float o);

  // OpenGL rendering call
  void RenderGL();

  // POVray export
  void RenderPov(PovState& pov, const std::string& name);

  void Export(Exporter* ex) const;

  // only removes the drawing elements
  void Clear();
  // removes all elements and resets internal state to default
  void Reset();

  // forces re-calculation of some buffered features
  void FlagRefresh();

  // for debugging, draw all normals
  void DrawNormals(bool f);

  // NOTE: all methods below could be delegated to the outside, 
  // using the GetEntries() and Get*Indices() member functions

  // experimental, do not use
  void CalcNormals(float smoothf);
  // experimental, do not use
  void CalcFullNormals();
  // experimental, do not use
  void SmoothNormals(float smoothf);
  // experimental, do not use
  void NPatch();
  // experimental, do not use
  void SmoothVertices(float smoothf);

  void UseTex(bool b) {use_tex_=b;}
  uint& TexID() {return tex_id_;}

  const EntryList& GetEntries() const {return entry_list_;}
  const IndexList& GetQuadIndices() const {return quad_index_list_;}
  const IndexList& GetTriIndices() const {return tri_index_list_;}
  const IndexList& GetLineIndices() const {return line_index_list_;}

  geom::AlignedCuboid GetBoundingBox() const;

  geom::Vec3 GetVert(VertexID id) const
  {
    geom::Vec3 nrvo;
    if(id>=entry_list_.size()) return nrvo;
    nrvo = geom::Vec3(entry_list_[id].v);
    return nrvo;
  } 

  void SetVert(VertexID id, const geom::Vec3& v) 
  {
    if(id>=entry_list_.size()) return;
    entry_list_[id].v[0]=v[0];
    entry_list_[id].v[1]=v[1];
    entry_list_[id].v[2]=v[2];
  }

  geom::Vec3 GetNormal(VertexID id) const
  {
    geom::Vec3 nrvo;
    if(id>=entry_list_.size()) return nrvo;
    nrvo = geom::Vec3(entry_list_[id].n);
    return nrvo;
  } 

  void SetNormal(VertexID id, const geom::Vec3& n) 
  {
    if(id>=entry_list_.size()) return;
    entry_list_[id].n[0]=n[0];
    entry_list_[id].n[1]=n[1];
    entry_list_[id].n[2]=n[2];
  }

  Color GetColor(VertexID id) const
  {
    Color nrvo;
    if(id>=entry_list_.size()) return nrvo;
    nrvo = Color(entry_list_[id].c[0],
                entry_list_[id].c[1],
                entry_list_[id].c[2],
                entry_list_[id].c[3]);
    return nrvo;
  } 

  void SetColor(VertexID id, const Color& c) 
  {
    if(id>=entry_list_.size()) return;
    entry_list_[id].c[0]=c[0];
    entry_list_[id].c[1]=c[1];
    entry_list_[id].c[2]=c[2];
    entry_list_[id].c[3]=opacity_;
  }

  geom::Vec2 GetTexCoord(VertexID id) const
  {
    geom::Vec2 nrvo;
    if(id>=entry_list_.size()) return nrvo;
    nrvo = geom::Vec2(entry_list_[id].t);
    return nrvo;
  } 

  void SetTexCoord(VertexID id, const geom::Vec2& t) 
  {
    if(id>=entry_list_.size()) return;
    entry_list_[id].t[0]=t[0];
    entry_list_[id].t[1]=t[1];
  }
 private:
  bool initialized_;
  
  EntryList entry_list_;
  IndexList quad_index_list_;
  IndexList tri_index_list_;
  IndexList line_index_list_;
  NTEntryList ntentry_list_;

  bool dirty_;

  int mode_;
  int poly_mode_;
  bool lighting_;
  bool cull_face_;
  bool two_sided_;
  bool color_mat_;
  float line_width_;
  bool aalines_flag_;
  float point_size_;
  float line_halo_;
  float opacity_;

  int outline_mode_;
  float outline_width_;
  Material outline_mat_;
  bool outline_mat_update_;
  unsigned int outline_mat_dlist_;
  float outline_exp_factor_;
  Color outline_exp_color_;
  bool solid_;
  Color solid_color_;
  float clip_offset_;
  bool draw_normals_;

  bool use_tex_;
  uint tex_id_;

  unsigned int buffer_id_[7]; // magic number related to the .cc buffer use

  void copy(const IndexedVertexArray& va);
  bool prep_buff();
  void draw_ltq(bool use_buff);
  void draw_p(bool use_buff);
  void draw_aalines();
  void draw_line_halo(bool use_buff);
  void set_clip_offset(float);
};

}} // ns

#endif