Class ProxySceneVars

• Defined in File ProxyScene.h

Inheritance Relationships

Base Type

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

Class Documentation

class ProxySceneVars : public Karana::Scene::SceneVars

The Vars for the ProxyScene class.

Public Functions

ProxySceneVars(const kc::ks_ptr<ProxyScene> &ps)

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

Parameters:

ps – The ProxyScene associated with this ProxySceneVars.

~ProxySceneVars()

Destructor.

virtual kc::NestedVars getAllVars() const override

Get all the Vars that this VarHolder has.

Returns:

A map of Vars, where the Var name is the key and the Var is the value.

Public Members

kc::ks_ptr<Karana::Core::Var_T<std::string>> root_frame

the root frame name

Public Static Functions

static kc::ks_ptr<ProxySceneVars> create(const kc::ks_ptr<ProxyScene> &ps)

Create an instance of the ProxySceneVars.

Parameters:

ps – The ProxyScene associated with this ProxySceneVars.

Returns:

A pointer to the newly created instance of ProxySceneVars.