Foundry::Katana::Render::GlobalSettings Class Reference

A utility class which provides a renderer's global settings from the Katana recipe if they are used. The attributes can be found on the root scene graph location at [rendererName]GlobalStatements. This class is a placeholder and can be extended to provide renderer specific parsing and access functions. More...

#include <GlobalSettings.h>

List of all members.

Public Member Functions
	GlobalSettings (FnScenegraphIterator rootIterator, const std::string &rendererNamespace)
virtual int	initialise (const std::string &rendererNamespace)
GroupAttribute	getGlobalSettingsAttr () const
Attribute	getAttribute (const std::string &attributeName) const

---

Detailed Description

A utility class which provides a renderer's global settings from the Katana recipe if they are used. The attributes can be found on the root scene graph location at [rendererName]GlobalStatements. This class is a placeholder and can be extended to provide renderer specific parsing and access functions.

---

Constructor & Destructor Documentation

Foundry::Katana::Render::GlobalSettings::GlobalSettings	(	FnScenegraphIterator	rootIterator,
		const std::string &	rendererNamespace
	)

Parameters:

rootIterator	The root scene graph iterator
rendererNamespace	The namespace used (typically the renderer name) to define the global settings group attribute for the renderer ([rendererNamespace]GlobalStatements).

---

Member Function Documentation

Attribute Foundry::Katana::Render::GlobalSettings::getAttribute

(

const std::string &

attributeName

)

const [inline]

Finds an Attribute under the global settings by name

Parameters:

attributeName

The name of a global settings attribute

Returns:

The named Attribute if found ([rendererNamespace]GlobalStatements.[attributeName])

GroupAttribute Foundry::Katana::Render::GlobalSettings::getGlobalSettingsAttr

(

)

const [inline]

Returns:

The group attribute containing the global settings ([rendererNamespace]GlobalStatements)

virtual int Foundry::Katana::Render::GlobalSettings::initialise

(

const std::string &

rendererNamespace

)

[virtual]

Parses the the global settings attributes

Parameters:

rendererNamespace

The namespace used (typically the renderer name) to define the global settings group attribute for the renderer ([rendererNamespace]GlobalStatements).

Returns:

A zero value if successful, a non-zero value otherwise

---

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

• GlobalSettings.h