Ocean
AssimpScene.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_SCENEDESCRIPTION_SDL_ASSIMP_ASSIMP_SCENE_H
9 #define META_OCEAN_SCENEDESCRIPTION_SDL_ASSIMP_ASSIMP_SCENE_H
10 
12 
14 
15 namespace Ocean
16 {
17 
18 namespace SceneDescription
19 {
20 
21 namespace SDL
22 {
23 
24 namespace Assimp
25 {
26 
27 /**
28  * This class holds the entire scene contained in one assimp-supported file.
29  * @ingroup scenedescriptionsdlassimp
30  */
31 class OCEAN_SCENEDESCRIPTION_SDL_ASSIMP_EXPORT AssimpScene : public SDLScene
32 {
33  public:
34 
35  /**
36  * Creates a new Assimp scene object.
37  * @param filename Scene filename
38  */
39  AssimpScene(const std::string& filename);
40 
41  /**
42  * Destructs an Assimp scene object.
43  */
44  ~AssimpScene() override;
45 
46  protected:
47 
48  /**
49  * Applies the entire scene to the rendering engine.
50  * @see Scene::internalApply().
51  */
53 };
54 
55 }
56 
57 }
58 
59 }
60 
61 }
62 
63 #endif // META_OCEAN_SCENEDESCRIPTION_SDL_ASSIMP_ASSIMP_SCENE_H
This class holds the entire scene contained in one assimp-supported file.
Definition: AssimpScene.h:32
AssimpScene(const std::string &filename)
Creates a new Assimp scene object.
Rendering::SceneRef internalApply(const Rendering::EngineRef &engine) override
Applies the entire scene to the rendering engine.
~AssimpScene() override
Destructs an Assimp scene object.
This class implements the base class for all sdl scene object providing access to all elements of a s...
Definition: SDLScene.h:39
The namespace covering the entire Ocean framework.
Definition: Accessor.h:15