ramses::RamsesHMIUtils Class Reference

Utility functions especially created for functions not yet designated for direct API integration. More...

#include <ramses-hmi-utils.h>

Static Public Member Functions
static bool	AllResourcesForSceneKnown (const Scene &scene)
	Checks if all resources for scene are locally available. More...
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. This includes disabled RenderPass-es, invisible MeshNode-s, client resources which are not used by the scene, and so on. The output is in text form, starts with a list of all unrequired objects and their names and concludes with a statistic (number of unrequired objects out of all objects of that type) More...
static void	DumpUnrequiredSceneObjectsToFile (const Scene &scene, std::ostream &out)
	As RamsesHMIUtils::DumpUnrequiredSceneObjects but write to given stream. More...
static ResourceDataPool &	GetResourceDataPoolForClient (RamsesClient &client)
	Returns the ResourceDataPool for this client. More...
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. More...

Detailed Description

Utility functions especially created for functions not yet designated for direct API integration.

Member Function Documentation

AllResourcesForSceneKnown()

static bool ramses::RamsesHMIUtils::AllResourcesForSceneKnown ( const Scene &  scene )

static

Checks if all resources for scene are locally available.

This method can be called to verify that at the time of calling all resources that are used inside scene are locally available. That means this scene could be mapped on a renderer and the renderer would be able to retrieve all needed resources. It does not check for resources in remote providers or resource caches.

Parameters

[in]

scene

The scene to verify resources for

Returns

True when all resources are available, false if not

DumpUnrequiredSceneObjects()

static void ramses::RamsesHMIUtils::DumpUnrequiredSceneObjects ( const Scene &  scene )

static

Dumps all objects of a scene which do not contribute to the visual appearance of the scene on screen. This includes disabled RenderPass-es, invisible MeshNode-s, client resources which are not used by the scene, and so on. The output is in text form, starts with a list of all unrequired objects and their names and concludes with a statistic (number of unrequired objects out of all objects of that type)

Parameters

[in]

scene

the source scene

DumpUnrequiredSceneObjectsToFile()

static void ramses::RamsesHMIUtils::DumpUnrequiredSceneObjectsToFile ( const Scene &  scene, std::ostream &  out  )

static

As RamsesHMIUtils::DumpUnrequiredSceneObjects but write to given stream.

Parameters

[in]	scene	the source scene
[out]	out	stream to write to

GetResourceDataPoolForClient()

static ResourceDataPool& ramses::RamsesHMIUtils::GetResourceDataPoolForClient ( RamsesClient &  client )

static

Returns the ResourceDataPool for this client.

Deprecated:

This function and the returned class are deprecated. See ramses::ResourceDataPool for details.

Parameters

[in]

client

The client to get the ResourceDataPool from. return The reference to the ResourceDataPool.

SaveResourcesOfSceneToResourceFile()

static bool ramses::RamsesHMIUtils::SaveResourcesOfSceneToResourceFile ( Scene const &  scene, std::string const &  filename, bool  compress  )

static

Saves all resources of a scene to a resource file, which can be opened in a ResourceDataPool.

Deprecated:

This functionality is deprecated. See ramses::ResourceDataPool for details.

Parameters

[in]	scene	The scene to save resource of.
[in]	filename	The file path to write the resource file to.
[in]	compress	if set to true, resources might be compressed before saving otherwise, uncompressed data will be saved return True if operation succeeded.

---

The documentation for this class was generated from the following file:

• /home/runner/work/ramses/ramses/client/ramses-client/ramses-client-api/include/ramses-hmi-utils.h