Class CoalSceneFileObject

• Defined in File CoalSceneFileObject.h

Inheritance Relationships

Base Types

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

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

Class Documentation

class CoalSceneFileObject : public Karana::Scene::SceneFileObject, public Karana::Scene::CoalSceneNode

SceneFileObject implementation for CoalScene.

See Scene layer for more discussion on the scene layer.

Public Functions

CoalSceneFileObject(std::string_view name, const kc::ks_ptr<Scene> &scene, const std::filesystem::path &filepath, layer_t layers)

CoalSceneFileObject constructor. The constructor is not meant to be called directly. Please use the create(…) method instead to create an instance.

Parameters:

• name – Name of the CoalSceneFileObject.

• scene – The CoalScene to add the part to.

• filepath – Filepath to populate the node from.

• layers – Layers to use for the CoalSceneFileObject.

Public Static Functions

static kc::ks_ptr<CoalSceneFileObject> create(std::string_view name, const kc::ks_ptr<CoalScene> &scene, const std::filesystem::path &filepath, layer_t layers = LAYER_PHYSICAL)

Create a CoalSceneFileObject.

Parameters:

• name – Name of the CoalSceneFileObject.

• scene – The GraphicalScene to add the CoalSceneFileObject to.

• filepath – Filepath to populate the node from.

• layers – Layers to use for the CoalSceneFileObject.

Returns:

The new CoalScene file node.