Mesh.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2018 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 #ifndef SDF_MESH_HH_
18 #define SDF_MESH_HH_
19 
20 #include <string>
21 #include <ignition/math/Vector3.hh>
22 #include <sdf/Element.hh>
23 #include <sdf/Error.hh>
24 #include <sdf/sdf_config.h>
25 
26 namespace sdf
27 {
28  // Inline bracket to help doxygen filtering.
29  inline namespace SDF_VERSION_NAMESPACE {
30  //
31 
32  // Forward declare private data class.
33  class MeshPrivate;
34 
38  {
40  public: Mesh();
41 
44  public: Mesh(const Mesh &_mesh);
45 
48  public: Mesh(Mesh &&_mesh) noexcept;
49 
51  public: virtual ~Mesh();
52 
56  public: Mesh &operator=(Mesh &&_mesh);
57 
61  public: Mesh &operator=(const Mesh &_mesh);
62 
69  public: Errors Load(ElementPtr _sdf);
70 
73  public: std::string Uri() const;
74 
77  public: void SetUri(const std::string &_uri);
78 
81  public: const std::string &FilePath() const;
82 
85  public: void SetFilePath(const std::string &_filePath);
86 
89  public: ignition::math::Vector3d Scale() const;
90 
93  public: void SetScale(const ignition::math::Vector3d &_scale);
94 
99  public: std::string Submesh() const;
100 
104  public: void SetSubmesh(const std::string &_submesh);
105 
111  public: bool CenterSubmesh() const;
112 
116  public: void SetCenterSubmesh(const bool _center);
117 
121  public: sdf::ElementPtr Element() const;
122 
124  private: MeshPrivate *dataPtr;
125  };
126  }
127 }
128 #endif
sdf::v9::Mesh::Mesh
Mesh(const Mesh &_mesh)
Copy constructor.
sdf::v9::Mesh::Submesh
std::string Submesh() const
A submesh, contained with the mesh at the specified URI, may optionally be specified.
Error.hh
sdf::v9::Mesh::Uri
std::string Uri() const
Get the mesh's URI.
sdf::v9::Mesh::SetFilePath
void SetFilePath(const std::string &_filePath)
Set the path to the file where this element was loaded from.
sdf::v9::Mesh::~Mesh
virtual ~Mesh()
Destructor.
sdf
namespace for Simulation Description Format parser
Definition: Actor.hh:33
sdf::v9::Mesh::SetSubmesh
void SetSubmesh(const std::string &_submesh)
Set the mesh's submesh.
sdf::v9::Mesh::Element
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
sdf::v9::Mesh::operator=
Mesh & operator=(Mesh &&_mesh)
Move assignment operator.
sdf::v9::Mesh::CenterSubmesh
bool CenterSubmesh() const
Get whether the submesh should be centered at 0,0,0.
sdf::v9::Errors
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:89
SDFORMAT_VISIBLE
#define SDFORMAT_VISIBLE
Definition: system_util.hh:48
sdf::v9::Mesh::SetCenterSubmesh
void SetCenterSubmesh(const bool _center)
Set whether the submesh should be centered.
sdf::v9::Mesh
Mesh represents a mesh shape, and is usually accessed through a Geometry.
Definition: Mesh.hh:38
sdf::v9::ElementPtr
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:53
sdf::v9::Mesh::FilePath
const std::string & FilePath() const
The path to the file where this element was loaded from.
sdf::v9::Mesh::SetScale
void SetScale(const ignition::math::Vector3d &_scale)
Set the mesh's scale factor.
sdf::v9::Mesh::Scale
ignition::math::Vector3d Scale() const
Get the mesh's scale factor.
sdf::v9::Mesh::Mesh
Mesh(Mesh &&_mesh) noexcept
Move constructor.
sdf::v9::Mesh::Mesh
Mesh()
Constructor.
sdf::v9::Mesh::operator=
Mesh & operator=(const Mesh &_mesh)
Copy Assignment operator.
sdf::v9::Mesh::Load
Errors Load(ElementPtr _sdf)
Load the mesh geometry based on a element pointer.
Element.hh
sdf::v9::Mesh::SetUri
void SetUri(const std::string &_uri)
Set the mesh's URI.