Ocean
GLESBackground.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Meta Platforms, Inc. and affiliates.
3  *
4  * This source code is licensed under the MIT license found in the
5  * LICENSE file in the root directory of this source tree.
6  */
7 
8 #ifndef META_OCEAN_RENDERING_GLES_BACKGROUND_H
9 #define META_OCEAN_RENDERING_GLES_BACKGROUND_H
10 
13 
15 
16 #include "ocean/math/Quaternion.h"
17 
18 namespace Ocean
19 {
20 
21 namespace Rendering
22 {
23 
24 namespace GLESceneGraph
25 {
26 
27 /**
28  * This class implements the base class for all GLESceneGraph background nodes.
29  * @ingroup renderinggles
30  */
31 class OCEAN_RENDERING_GLES_EXPORT GLESBackground :
32  virtual public GLESNode,
33  virtual public Background
34 {
35  public:
36 
37  /**
38  * Returns the position used for this background.
39  * @see Background::position().
40  */
41  Vector3 position() const override;
42 
43  /**
44  * Returns the orientation used for this background.
45  * @see Background::orientation().
46  */
47  Quaternion orientation() const override;
48 
49  /**
50  * Sets the position used for this background.
51  * @see Background::setPosition().
52  */
53  void setPosition(const Vector3& position) override;
54 
55  /**
56  * Sets the orientation used for this background.
57  * @see Background::setOrientation().
58  */
59  void setOrientation(const Quaternion& orientation) override;
60 
61  protected:
62 
63  /**
64  * Creates a new GLESceneGraph background object.
65  */
67 
68  /**
69  * Destructs a GLESceneGraph background object.
70  */
71  ~GLESBackground() override;
72 
73  protected:
74 
75  /// Background position.
77 
78  /// Background orientation.
80 };
81 
82 }
83 
84 }
85 
86 }
87 
88 #endif // META_OCEAN_RENDERING_GLES_BACKGROUND_H
This class is the base class for all backgrounds.
Definition: rendering/Background.h:37
This class implements the base class for all GLESceneGraph background nodes.
Definition: GLESBackground.h:34
Quaternion orientation() const override
Returns the orientation used for this background.
void setOrientation(const Quaternion &orientation) override
Sets the orientation used for this background.
~GLESBackground() override
Destructs a GLESceneGraph background object.
void setPosition(const Vector3 &position) override
Sets the position used for this background.
Quaternion backgroundOrientation
Background orientation.
Definition: GLESBackground.h:79
GLESBackground()
Creates a new GLESceneGraph background object.
Vector3 backgroundPosition
Background position.
Definition: GLESBackground.h:76
Vector3 position() const override
Returns the position used for this background.
This class implements a GLESceneGraph node object.
Definition: GLESNode.h:40
The namespace covering the entire Ocean framework.
Definition: Accessor.h:15