Class GraphicalScene

• Defined in File GraphicalScene.h

Inheritance Relationships

Base Type

• public Karana::Scene::Scene (Class Scene)

Derived Type

• public Karana::Scene::WebScene (Class WebScene)

Class Documentation

class GraphicalScene : public Karana::Scene::Scene

Scene with an added graphics-specific interface.

See Scene layer for more discussion on the scene layer.

Subclassed by Karana::Scene::WebScene

Public Functions

virtual ~GraphicalScene()

virtual Karana::Core::ks_ptr<GraphicalSceneCamera> defaultCamera() const = 0

Get the automatically created default camera.

Returns:

The default camera

virtual void renderToFile(const std::filesystem::path &filepath) = 0

Render the scene to a file.

Parameters:

filepath – - filename to render to

virtual Karana::Core::id_t addOverlayText(std::string_view message, float x, float y, const TextParameters &parameters = TextParameters{}) = 0

Add text in screen space.

Parameters:

• message – - The content of the overlay text

• x – - The horizontal position of the text between 0 and 1

• y – - The vertical position of the text between 0 and 1

• parameters – - Addition text parameters

Returns:

Unique id to later update the text instance

virtual void setOverlayText(const Karana::Core::id_t &id, std::string_view message) = 0

Update the content of an existing overlay text.

Parameters:

• id – - Id for the text returned by a prior addOverlayText call

• message – - The new content of the overlay text

virtual void removeOverlayText(const Karana::Core::id_t &id) = 0

Delete an overlay text instance.

Parameters:

id – - Id for the text returned by a prior addOverlayText call

Protected Functions

GraphicalScene(std::string_view name)

Constructor for a GraphicalScene.

Parameters:

name – - Name of the GraphicalScene