RAMSES Documentation  27.0.130
Information for RAMSES users and developers
ramses-hmi-utils.h
Go to the documentation of this file.
1 // -------------------------------------------------------------------------
2 // Copyright (C) 2017 BMW Car IT GmbH
3 // -------------------------------------------------------------------------
4 // This Source Code Form is subject to the terms of the Mozilla Public
5 // License, v. 2.0. If a copy of the MPL was not distributed with this
6 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
7 // -------------------------------------------------------------------------
8 
9 #ifndef RAMSES_RAMSES_HMI_UTILS_H
10 #define RAMSES_RAMSES_HMI_UTILS_H
11 
14 #include <string>
15 
16 namespace ramses
17 {
18  class ResourceDataPool;
19 
24  {
25  public:
37  static bool AllResourcesForSceneKnown(const Scene& scene);
38 
47  static void DumpUnrequiredSceneObjects(const Scene& scene);
48 
55  static void DumpUnrequiredSceneObjectsToFile(const Scene& scene, std::ostream& out);
56 
65 
76  static bool SaveResourcesOfSceneToResourceFile(Scene const& scene, std::string const& filename, bool compress);
77  };
78 }
79 
80 #endif
#define RAMSES_API
Definition: APIExport.h:35
Entry point of RAMSES client API.
Definition: RamsesClient.h:34
Utility functions especially created for functions not yet designated for direct API integration.
Definition: ramses-hmi-utils.h:24
static void DumpUnrequiredSceneObjectsToFile(const Scene &scene, std::ostream &out)
As RamsesHMIUtils::DumpUnrequiredSceneObjects but write to given stream.
static ResourceDataPool & GetResourceDataPoolForClient(RamsesClient &client)
Returns the ResourceDataPool for this client.
static void DumpUnrequiredSceneObjects(const Scene &scene)
Dumps all objects of a scene which do not contribute to the visual appearance of the scene on screen....
static bool SaveResourcesOfSceneToResourceFile(Scene const &scene, std::string const &filename, bool compress)
Saves all resources of a scene to a resource file, which can be opened in a ResourceDataPool.
static bool AllResourcesForSceneKnown(const Scene &scene)
Checks if all resources for scene are locally available.
The ResourceDataPool holds resource data which can be instantiated for a given scene....
Definition: ResourceDataPool.h:37
The Scene holds a scene graph. It is the essential class for distributing content to the ramses syste...
Definition: Scene.h:83
The RAMSES namespace contains all client side objects and functions used to implement RAMSES applicat...
Definition: AnimatedProperty.h:15