Gazebo Rendering

API Reference

3.7.2
gz/rendering/Grid.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 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 GZ_RENDERING_GRID_HH_
18 #define GZ_RENDERING_GRID_HH_
19 
20 #include <string>
21 #include "gz/rendering/config.hh"
22 #include "gz/rendering/Geometry.hh"
23 #include "gz/rendering/Object.hh"
24 
25 namespace ignition
26 {
27  namespace rendering
28  {
29  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
30  //
34  class IGNITION_RENDERING_VISIBLE Grid :
35  public virtual Geometry
36  {
38  public: virtual ~Grid() { }
39 
42  public: virtual void SetCellCount(const unsigned int _count) = 0;
43 
46  public: virtual unsigned int CellCount() const = 0;
47 
51  public: virtual void SetCellLength(const double _len) = 0;
52 
55  public: virtual double CellLength() const = 0;
56 
59  public: virtual void SetVerticalCellCount(const unsigned int _count) = 0;
60 
63  public: virtual unsigned int VerticalCellCount() const = 0;
64  };
65  }
66  }
67 }
68 
69 #endif
virtual void SetCellLength(const double _len)=0
Set the cell length in one direction. The cells are assumed to be square.
virtual unsigned int CellCount() const =0
Get the number of cells on a planar grid.
virtual unsigned int VerticalCellCount() const =0
Get the vertical cell count.
Represents a grid geometry drawn along the XY plane. If vertical cell count is specified then the gri...
Definition: gz/rendering/Grid.hh:34
virtual double CellLength() const =0
Get the cell length.
virtual void SetVerticalCellCount(const unsigned int _count)=0
Set the vertical cell count of the grid. This makes the grid 3D.
virtual void SetCellCount(const unsigned int _count)=0
Set the number of cells on a planar grid.
virtual ~Grid()
Destructor.
Definition: gz/rendering/Grid.hh:38
Represents a geometric shape to be rendered.
Definition: gz/rendering/Geometry.hh:34