Provides functions to dynamically declare new Grob classes, commands, shaders and tools. More...

#include <OGF/scene_graph/types/scene_graph_library.h>

Inheritance diagram for OGF::SceneGraphLibrary:

Public Member Functions
	SceneGraphLibrary ()
	SceneGraphLibrary constructor.

	~SceneGraphLibrary () override
	SceneGraphLibrary destructor.

SceneGraph *	scene_graph ()
	Gets the SceneGraph.

const SceneGraph *	scene_graph () const
	Gets the SceneGraph.

SceneGraphToolsManager *	scene_graph_tools_manager ()
	Gets the SceneGraphToolsManager.

void	register_grob_type (const std::string &grob_class_name, bool abstract=false)
	Registers a new Grob type.

void	register_grob_read_file_extension (const std::string &grob_class_name, const std::string &extension)
	Registers a new file extension associated with a Grob type for reading.

void	register_grob_write_file_extension (const std::string &grob_class_name, const std::string &extension)
	Registers a new file extension associated with a Grob type for writing.

void	register_grob_shader (const std::string &grob_class_name, const std::string &shader_class_name, const std::string &shader_user_name="")
	Registers a new Shader class associated with a Grob class.

void	register_grob_tool (const std::string &grob_class_name, const std::string &tool_class_name)
	Registers a new Tool class associated with a Grob class.

void	register_grob_interface (const std::string &grob_class_name, const std::string &interface_class_name)
	Registers a new Interface class associated with a Grob class.

void	register_grob_commands (const std::string &grob_class_name, const std::string &commands_class_name)
	Registers a new Commands class associated with a Grob class.

void	register_full_screen_effect (const std::string &full_screen_effect_class_name, const std::string &user_name="")
	Registers a new full screen effect.

std::string	file_extension_to_grob (const std::string &extension) const
	Finds the object class names associated with a file extension for reading.

bool	get_local_value (const std::string &name, std::string &value) const override
	Retrieves a variable value locally.

bool	set_local_value (const std::string &name, const std::string &value) override
	Sets a variable value locally.

std::string	default_grob_read_extension (const std::string &grob_class_name) const
	Gets the default file extension associated with a Grob class for reading.

std::string	default_grob_write_extension (const std::string &grob_class_name) const
	Gets the default file extension associated with a Grob class for writing.

const std::string &	shader_user_to_classname (const std::string &grob_class_name, const std::string &shader_user_name) const
	Converts a shader user name to the associated internal class name.

const std::string &	shader_classname_to_user (const std::string &grob_class_name, const std::string &shader_class_name) const
	Converts a shader class name to the associated user shader name.

std::string	full_screen_effect_user_to_classname (const std::string &full_screen_effect_user_name) const
	Converts a full screen effect user name to the associated internal full screen effect class name.

const std::string &	full_screen_effect_classname_to_user (const std::string &full_screen_effect_classname) const
	Converts a full screen effect class name to the associated user name.

Public Member Functions inherited from GEO::Environment
virtual bool	add_environment (Environment *env)
	Adds a child environment.

bool	has_value (const std::string &name) const
	Tests if a variable exists.

virtual bool	get_value (const std::string &name, std::string &value) const
	Retrieves the value of a variable.

std::string	get_value (const std::string &name) const
	Retrieves the value of a variable.

virtual bool	set_value (const std::string &name, const std::string &value)
	Sets a variable value.

virtual Environment *	find_environment (const std::string &name)
	Finds the environment that declares a variable as a local name.

virtual bool	add_observer (const std::string &name, VariableObserver *observer)
	Attaches an observer to a variable.

virtual bool	remove_observer (const std::string &name, VariableObserver *observer)
	Detaches an observer from a variable.

virtual bool	notify_observers (const std::string &name, bool recursive=false)
	Notifies observers.

Public Member Functions inherited from GEO::Counted
void	ref () const
	Increments the reference count.

void	unref () const
	Decrements the reference count.

bool	is_shared () const
	Check if the object is shared.

int	nb_refs () const
	Gets the number of references that point to this object.

Static Public Member Functions
static SceneGraphLibrary *	instance ()
	Gets the instance.

static void	initialize ()
	Initializes the SceneGraphLibrary instance.

static void	terminate ()
	Terminates the SceneGraphLibrary instance.

Static Public Member Functions inherited from GEO::Environment
static Environment *	instance ()
	Gets the root environment.

static void	terminate ()
	Cleans up the environment.

Static Public Member Functions inherited from GEO::Counted
static void	ref (const Counted *counted)
	Increments the reference count.

static void	unref (const Counted *counted)
	Decrements the reference count.

Protected Member Functions
void	scene_graph_values_changed_notify_environment ()
	Notifies all listeners of scene graph environment variables.

void	set_scene_graph (SceneGraph *scene_graph, bool transfer_ownership=false)
	Sets the SceneGraph.

void	set_scene_graph_shader_manager (SceneGraphShaderManager *scene_graph_shader_manager)
	Sets the SceneGraphShaderManager.

void	set_scene_graph_tools_manager (SceneGraphToolsManager *scene_graph_tools_manager)
	Sets the SceneGraphToolsManager.

Protected Member Functions inherited from GEO::Environment
	~Environment () override
	Environment destructor.

bool	notify_observers (const std::string &name, const std::string &value, bool recursive)
	Notifies observers.

bool	notify_local_observers (const std::string &name, const std::string &value)
	Notifies local observers.

Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object.

virtual	~Counted ()
	Destroys a reference counted object.

Friends
class	SceneGraph

class	SceneGraphCommandsManager

class	SceneGraphShaderManager

class	SceneGraphToolsManager

Detailed Description

Provides functions to dynamically declare new Grob classes, commands, shaders and tools.

Note: SceneGraphLibrary member functions register_xxx use typenames passed as strings. It is preferred to use typesafe template wrappers ogf_register_xxx<>().

Definition at line 68 of file scene_graph_library.h.

Member Function Documentation

◆ default_grob_read_extension()

std::string OGF::SceneGraphLibrary::default_grob_read_extension ( const std::string & grob_class_name ) const

Gets the default file extension associated with a Grob class for reading.

Parameters

[in] grob_class_name the Grob class name as a string, with the "OGF::" prefix

Returns: the default file extension associated with the Grob class name for reading

◆ default_grob_write_extension()

std::string OGF::SceneGraphLibrary::default_grob_write_extension ( const std::string & grob_class_name ) const

Gets the default file extension associated with a Grob class for writing.

Parameters

[in] grob_class_name the Grob class name as a string, with the "OGF::" prefix

Returns: the default file extension associated with the Grob class name for writing

◆ file_extension_to_grob()

std::string OGF::SceneGraphLibrary::file_extension_to_grob ( const std::string & extension ) const

Finds the object class names associated with a file extension for reading.

Parameters

[in] extension the extension, without the "."

Returns: the ';'-separated list of object class names that can read the extension

◆ full_screen_effect_classname_to_user()

const std::string & OGF::SceneGraphLibrary::full_screen_effect_classname_to_user ( const std::string & full_screen_effect_classname ) const

Converts a full screen effect class name to the associated user name.

Parameters

[in] full_screen_effect_classname the class name of the full screen effect as a string, with the "OGF::" prefix

Returns: the user name of the full screen effect

◆ full_screen_effect_user_to_classname()

std::string OGF::SceneGraphLibrary::full_screen_effect_user_to_classname ( const std::string & full_screen_effect_user_name ) const

Converts a full screen effect user name to the associated internal full screen effect class name.

Parameters

[in] full_screen_effect_user_name the user name of the full screen effect

Returns: the internal class name of the full screen effect as a string, with the "OGF::" prefix

◆ get_local_value()

bool OGF::SceneGraphLibrary::get_local_value	(	const std::string &	name,
		std::string &	value
	)		const

overridevirtual

Retrieves a variable value locally.

This function is used internally. It searches variable name locally and stores its value in the output string value.

Parameters

[in]	name	the name of the variable
[out]	value	is set the variable value if it was found locally.

Return values

true	if the variable was found
false	if not

Note: This function must be reimplemented in derived custom environments.

Provides the following environment variables:

grob_types
grob_read_extensions
grob_write_extensions
SceneGraph_commands
xxx_read_extensions
xxx_write_extensions
xxx_shaders
xxx_tools
xxx_commands
full_screen_effects

Implements GEO::Environment.

◆ initialize()

static void OGF::SceneGraphLibrary::initialize ( )

static

Initializes the SceneGraphLibrary instance.

This function is called at Graphite startup. Client code should not call it.

◆ instance()

static SceneGraphLibrary * OGF::SceneGraphLibrary::instance ( )

static

Gets the instance.

Returns: a pointer to the SceneGraphLibrary instance

◆ register_full_screen_effect()

void OGF::SceneGraphLibrary::register_full_screen_effect	(	const std::string &	full_screen_effect_class_name,
		const std::string &	user_name = `""`
	)

Registers a new full screen effect.

Parameters

[in] full_screen_effect_class_name the class name of the full screen effect, with the "OGF::" prefix

Note: it is preferred to use the type-safe ogf_register_full_screen_effect instead.

Parameters

[in] user_name an optional user name for the full screen effect that will be used in the GUI

◆ register_grob_commands()

void OGF::SceneGraphLibrary::register_grob_commands	(	const std::string &	grob_class_name,
		const std::string &	commands_class_name
	)

Registers a new Commands class associated with a Grob class.

Parameters

[in]	grob_class_name	the object class name as a string, with the "OGF::" prefix
[in]	commands_class_name	the tool class name as a string, with the "OGF::" prefix

Note: it is preferred to use the type-safe ogf_register_grob_commands instead.

◆ register_grob_interface()

void OGF::SceneGraphLibrary::register_grob_interface	(	const std::string &	grob_class_name,
		const std::string &	interface_class_name
	)

Registers a new Interface class associated with a Grob class.

Parameters

[in]	grob_class_name	the object class name as a string, with the "OGF::" prefix
[in]	interface_class_name	the tool class name as a string, with the "OGF::" prefix

Note: it is preferred to use the type-safe ogf_register_grob_interface instead.

◆ register_grob_read_file_extension()

void OGF::SceneGraphLibrary::register_grob_read_file_extension	(	const std::string &	grob_class_name,
		const std::string &	extension
	)

Registers a new file extension associated with a Grob type for reading.

Parameters

[in]	grob_class_name	the object class name as a string, with the "OGF::" prefix
[in]	extension	the extension, without the "."

Note: it is preferred to use the type-safe ogf_register_grob_read_file_extension instead.

◆ register_grob_shader()

void OGF::SceneGraphLibrary::register_grob_shader	(	const std::string &	grob_class_name,
		const std::string &	shader_class_name,
		const std::string &	shader_user_name = `""`
	)

Registers a new Shader class associated with a Grob class.

Parameters

[in]	grob_class_name	the object class name as a string, with the "OGF::" prefix
[in]	shader_class_name	the shader class name as a string, with the "OGF::" prefix
[in]	shader_user_name	an optional user name for the shader, that will be used in the GUI

Note: it is preferred to use the type-safe ogf_register_grob_shader instead.

◆ register_grob_tool()

void OGF::SceneGraphLibrary::register_grob_tool	(	const std::string &	grob_class_name,
		const std::string &	tool_class_name
	)

Registers a new Tool class associated with a Grob class.

Parameters

[in]	grob_class_name	the object class name as a string, with the "OGF::" prefix
[in]	tool_class_name	the tool class name as a string, with the "OGF::" prefix

Note: it is preferred to use the type-safe ogf_register_grob_tool instead.

◆ register_grob_type()

void OGF::SceneGraphLibrary::register_grob_type	(	const std::string &	grob_class_name,
		bool	abstract = `false`
	)

Registers a new Grob type.

Parameters

[in]	grob_class_name	the object class name as a string, with the "OGF::" prefix
[in]	abstract	true if the object class name is abstract

Note: it is prefered to use the type-safe ogf_register_grob_type instead.

◆ register_grob_write_file_extension()

void OGF::SceneGraphLibrary::register_grob_write_file_extension	(	const std::string &	grob_class_name,
		const std::string &	extension
	)

Registers a new file extension associated with a Grob type for writing.

Parameters

[in]	grob_class_name	the object class name as a string, with the "OGF::" prefix
[in]	extension	the extension, without the "."

Note: it is preferred to use the type-safe ogf_register_grob_write_file_extension instead.

◆ scene_graph() [1/2]

SceneGraph * OGF::SceneGraphLibrary::scene_graph ( )

inline

Gets the SceneGraph.

Returns: a pointer to the SceneGraph

Definition at line 106 of file scene_graph_library.h.

◆ scene_graph() [2/2]

const SceneGraph * OGF::SceneGraphLibrary::scene_graph ( ) const

inline

Gets the SceneGraph.

Returns: a const pointer to the SceneGraph

Definition at line 114 of file scene_graph_library.h.

◆ scene_graph_tools_manager()

SceneGraphToolsManager * OGF::SceneGraphLibrary::scene_graph_tools_manager ( )

inline

Gets the SceneGraphToolsManager.

Returns: a pointer to the SceneGraphToolsManager

Definition at line 122 of file scene_graph_library.h.

◆ set_local_value()

bool OGF::SceneGraphLibrary::set_local_value	(	const std::string &	name,
		const std::string &	value
	)

overridevirtual

Sets a variable value locally.

This function is used internally. It sets the variable named name to the given value locally.

Parameters

[in]	name	the name of the variable
[in]	value	the value of the variable

Return values

true	if the variable was successfully added locally
false	otherwise

Note: This function must be reimplemented in derived custom environments.

Implements GEO::Environment.

◆ set_scene_graph()

void OGF::SceneGraphLibrary::set_scene_graph	(	SceneGraph *	scene_graph,
		bool	transfer_ownership = `false`
	)

protected

Sets the SceneGraph.

Parameters

[in]	scene_graph	a pointer to the SceneGraph
[in]	transfer_ownership	if set, then the SceneGraphLibrary takes the ownership of the SceneGraph (used when SceneGraph is created by Grob constructor).

Precondition: scene_graph() == nullptr

◆ set_scene_graph_shader_manager()

void OGF::SceneGraphLibrary::set_scene_graph_shader_manager ( SceneGraphShaderManager * scene_graph_shader_manager )

inlineprotected

Sets the SceneGraphShaderManager.

Parameters

[in] scene_graph_shader_manager a pointer to the SceneGraphShaderManager

Precondition: scene_graph_shader_manager() == nullptr

Definition at line 378 of file scene_graph_library.h.

◆ set_scene_graph_tools_manager()

void OGF::SceneGraphLibrary::set_scene_graph_tools_manager ( SceneGraphToolsManager * scene_graph_tools_manager )

inlineprotected

Sets the SceneGraphToolsManager.

Parameters

[in] scene_graph_tools_manager a pointer to the SceneGraphToolsManager

Precondition: scene_graph_tools_manager() == nullptr

Definition at line 391 of file scene_graph_library.h.

◆ shader_classname_to_user()

const std::string & OGF::SceneGraphLibrary::shader_classname_to_user	(	const std::string &	grob_class_name,
		const std::string &	shader_class_name
	)		const

Converts a shader class name to the associated user shader name.

Parameters

[in]	grob_class_name	the Grob class name the shader is associated with, as a string with the "OGF::" prefix
[in]	shader_class_name	the Shader class name as a string, with the "OGF::" prefix

Returns: the user shader name

◆ shader_user_to_classname()

const std::string & OGF::SceneGraphLibrary::shader_user_to_classname	(	const std::string &	grob_class_name,
		const std::string &	shader_user_name
	)		const

Converts a shader user name to the associated internal class name.

Parameters

[in]	grob_class_name	the Grob class name the shader is associated with, as a string with the "OGF::" prefix
[in]	shader_user_name	the shader user name

Returns: the internal shader class name as a string, with the "OGF::" prefix

◆ terminate()

static void OGF::SceneGraphLibrary::terminate ( )

static

Terminates the SceneGraphLibrary instance.

This function is called at Graphite shutdown. Client code should not call it.

Friends And Related Symbol Documentation

◆ SceneGraph

friend class SceneGraph

friend

Definition at line 348 of file scene_graph_library.h.

◆ SceneGraphCommandsManager

friend class SceneGraphCommandsManager

friend

Definition at line 349 of file scene_graph_library.h.

◆ SceneGraphShaderManager

friend class SceneGraphShaderManager

friend

Definition at line 350 of file scene_graph_library.h.

◆ SceneGraphToolsManager

friend class SceneGraphToolsManager

friend

Definition at line 351 of file scene_graph_library.h.

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

OGF/scene_graph/types/scene_graph_library.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Function Documentation

◆ default_grob_read_extension()

◆ default_grob_write_extension()

◆ file_extension_to_grob()

◆ full_screen_effect_classname_to_user()

◆ full_screen_effect_user_to_classname()

◆ get_local_value()

◆ initialize()

◆ instance()

◆ register_full_screen_effect()

◆ register_grob_commands()

◆ register_grob_interface()

◆ register_grob_read_file_extension()

◆ register_grob_shader()

◆ register_grob_tool()

◆ register_grob_type()

◆ register_grob_write_file_extension()

◆ scene_graph() [1/2]

◆ scene_graph() [2/2]

◆ scene_graph_tools_manager()

◆ set_local_value()

◆ set_scene_graph()

◆ set_scene_graph_shader_manager()

◆ set_scene_graph_tools_manager()

◆ shader_classname_to_user()

◆ shader_user_to_classname()

◆ terminate()

Friends And Related Symbol Documentation

◆ SceneGraph

◆ SceneGraphCommandsManager

◆ SceneGraphShaderManager

◆ SceneGraphToolsManager