gz/common/SubMesh.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * 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.
 *
*/
#ifndef GZ_COMMON_SUBMESH_HH_
#define GZ_COMMON_SUBMESH_HH_
 
#include <memory>
#include <optional>
#include <string>
 
#include <gz/math/Vector3.hh>
#include <gz/math/Vector2.hh>
 
#include <gz/utils/ImplPtr.hh>
 
#include <gz/common/graphics/Types.hh>
#include <gz/common/graphics/Export.hh>
 
namespace gz
{
  namespace common
  {
    class Material;
    class NodeAssignment;
 
    class GZ_COMMON_GRAPHICS_VISIBLE SubMesh
    {
      public: enum PrimitiveType
              {
                POINTS,
                LINES,
                LINESTRIPS,
                TRIANGLES,
                TRIFANS,
                TRISTRIPS
              };
 
      public: SubMesh();
 
      public: explicit SubMesh(const std::string &_name);
 
      public: virtual ~SubMesh();
 
      public: void SetName(const std::string &_name);
 
      public: std::string Name() const;
 
      public: void SetPrimitiveType(PrimitiveType _type);
 
      public: PrimitiveType SubMeshPrimitiveType() const;
 
      public: void AddIndex(const unsigned int _index);
 
      public: void AddVertex(const gz::math::Vector3d &_v);
 
      public: void AddVertex(const double _x, const double _y, const double _z);
 
      public: void AddNormal(const gz::math::Vector3d &_n);
 
      public: void AddNormal(const double _x, const double _y, const double _z);
 
      public: void AddTexCoord(const double _u, const double _v);
 
      public: void AddTexCoord(const gz::math::Vector2d &_uv);
 
      public: void AddTexCoordBySet(double _u, double _v,
          unsigned int _setIndex);
 
      public: void AddTexCoordBySet(const gz::math::Vector2d &_uv,
          unsigned int _setIndex);
 
      public: void AddNodeAssignment(const unsigned int _vertex,
                                     const unsigned int _node,
                                     const float _weight);
      public: gz::math::Vector3d Vertex(const unsigned int _index) const;
 
      public: const gz::math::Vector3d* VertexPtr() const;
 
      public: void SetVertex(const unsigned int _index,
                             const gz::math::Vector3d &_v);
 
      public: gz::math::Vector3d Normal(const unsigned int _index) const;
 
      public: void SetNormal(const unsigned int _index,
                  const gz::math::Vector3d &_n);
 
      public: gz::math::Vector2d TexCoord(
                  const unsigned int _index) const;
 
      public: gz::math::Vector2d TexCoordBySet(
                  unsigned int _index,
                  unsigned int _setIndex) const;
 
      public: void SetTexCoord(const unsigned int _index,
                               const gz::math::Vector2d &_uv);
 
      public: void SetTexCoordBySet(unsigned int _index,
                               const gz::math::Vector2d &_uv,
                               unsigned int _setIdex);
 
      public: int Index(const unsigned int _index) const;
 
      public: const unsigned int* IndexPtr() const;
 
      public: void SetIndex(const unsigned int _index,
          const unsigned int _i);
 
      public: NodeAssignment NodeAssignmentByIndex(
          const unsigned int _index) const;
 
      public: gz::math::Vector3d Max() const;
 
      public: gz::math::Vector3d Min() const;
 
      public: unsigned int VertexCount() const;
 
      public: unsigned int NormalCount() const;
 
      public: unsigned int IndexCount() const;
 
      public: unsigned int TexCoordCount() const;
 
      public: unsigned int TexCoordCountBySet(unsigned int _setIndex) const;
 
      public: unsigned int TexCoordSetCount() const;
 
      public: unsigned int NodeAssignmentsCount() const;
 
      public: unsigned int MaxIndex() const;
 
      public: void SetMaterialIndex(const unsigned int _index);
 
      public: unsigned int GZ_DEPRECATED(5) MaterialIndex() const;
 
      public: std::optional<unsigned int> GetMaterialIndex() const;
 
      public: bool HasVertex(const gz::math::Vector3d &_v) const;
 
      public: bool HasVertex(const unsigned int _index) const;
 
      public: bool HasNormal(const unsigned int _index) const;
 
      public: bool HasTexCoord(const unsigned int _index) const;
 
      public: bool HasTexCoordBySet(unsigned int _index, unsigned int _setIndex)
          const;
 
      public: bool HasNodeAssignment(const unsigned int _index) const;
 
      public: int IndexOfVertex(const gz::math::Vector3d &_v) const;
 
      public: void FillArrays(double **_vertArr, int **_indexndArr) const;
 
      public: void RecalculateNormals();
 
      public: void GenSphericalTexCoord(
                  const gz::math::Vector3d &_center);
 
      public: void GenSphericalTexCoordBySet(
                  const gz::math::Vector3d &_center,
                  unsigned int _setIndex);
 
      public: void Scale(const gz::math::Vector3d &_factor);
 
      public: void Scale(const double &_factor);
 
      public: void Center(const gz::math::Vector3d &_center =
                          gz::math::Vector3d::Zero);
 
      public: void Translate(const gz::math::Vector3d &_vec);
 
      public: double Volume() const;
 
      GZ_UTILS_IMPL_PTR(dataPtr)
    };
 
    class GZ_COMMON_GRAPHICS_VISIBLE NodeAssignment
    {
      public: NodeAssignment();
 
      public: unsigned int vertexIndex;
 
      public: unsigned int nodeIndex;
 
      public: float weight;
    };
  }
}
 
#endif