Ignition Rendering

API Reference

5.1.0
BaseWireBox.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2020 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 IGNITION_RENDERING_BASE_WIREBOX_HH_
18 #define IGNITION_RENDERING_BASE_WIREBOX_HH_
19 
20 #include <string>
22 
23 namespace ignition
24 {
25  namespace rendering
26  {
27  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
28  //
30  template <class T>
31  class BaseWireBox :
32  public virtual WireBox,
33  public virtual T
34  {
36  protected: BaseWireBox();
37 
39  public: virtual ~BaseWireBox();
40 
41  // Documentation inherited.
42  public: virtual void PreRender();
43 
44  // Documentation inherited.
45  public: virtual void Destroy();
46 
47  // Documentation inherited.
48  public: virtual void SetBox(const ignition::math::AxisAlignedBox &_box);
49 
50  // Documentation inherited.
51  public: virtual ignition::math::AxisAlignedBox Box() const;
52 
53  // \brief Underlying axis aligned box that the wire box reflects.
55 
57  protected: bool wireBoxDirty = false;
58  };
59 
61  // BaseWireBox
63  template <class T>
65  {
66  }
67 
69  template <class T>
71  {
72  }
73 
75  template <class T>
77  {
78  T::PreRender();
79  }
80 
82  template <class T>
84  {
85  T::Destroy();
86  }
87 
89  template <class T>
91  {
92  this->box = _box;
93  this->wireBoxDirty = true;
94  }
95 
97  template <class T>
99  {
100  return this->box;
101  }
102  }
103  }
104 }
105 #endif
virtual void PreRender()
Prepare this object and any of its children for rendering. This should be called for each object in a...
Definition: BaseWireBox.hh:76
Base implementation of a wireframe box.
Definition: BaseWireBox.hh:31
virtual ~BaseWireBox()
Destructor.
Definition: BaseWireBox.hh:70
ignition::math::AxisAlignedBox box
Definition: BaseWireBox.hh:54
virtual void SetBox(const ignition::math::AxisAlignedBox &_box)
Set the axis aligned box.
Definition: BaseWireBox.hh:90
virtual ignition::math::AxisAlignedBox Box() const
Get the wireframe box.
Definition: BaseWireBox.hh:98
virtual void Destroy()
Destroy any resources associated with this object. Invoking any other functions after destroying an o...
Definition: BaseWireBox.hh:83
Draws a wireframe box.
Definition: WireBox.hh:32
BaseWireBox()
Constructor.
Definition: BaseWireBox.hh:64