Base class that defines the interface for graphics materials. More...

#include <Material.h>

Inheritance diagram for SurgSim::Graphics::Material:

Public Member Functions
	Material (const std::string &name)
	Constructor.

virtual	~Material ()
	Destructor.

virtual void	addUniform (std::shared_ptr< UniformBase > uniform)=0
	Adds a uniform to this material. More...

virtual void	addUniform (const std::string &type, const std::string &name)=0
	Adds a GLSL typed uniform to this material. More...

virtual bool	removeUniform (std::shared_ptr< UniformBase > uniform)=0
	Removes a uniform from this material. More...

virtual bool	removeUniform (const std::string &name)=0
	Removes a uniform from this material. More...

virtual std::shared_ptr< UniformBase >	getUniform (const std::string &name) const =0
	Gets a uniform in this material. More...

virtual std::shared_ptr< UniformBase >	getUniform (size_t index) const =0
	Gets a uniform in this material. More...

virtual bool	hasUniform (const std::string &name) const =0
	Checks if this material has a uniform with the given name. More...

virtual size_t	getNumUniforms () const =0
	Returns the number of uniforms in this material.

virtual void	loadProgram (const std::string &nameTuple)=0

virtual bool	setProgram (std::shared_ptr< Program > program)=0
	Sets the program used by this material. More...

virtual std::shared_ptr< Program >	getProgram () const =0
	Gets the program used by this material. More...

virtual void	clearProgram ()=0
	Removes the shader from the material, falling back to fixed-function pipeline.

Public Member Functions inherited from SurgSim::Framework::Component
	Component (const std::string &name)
	Constructor. More...

virtual	~Component ()
	Destructor.

std::string	getName () const
	Gets component name. More...

std::string	getFullName () const
	Gets a string containing the name of the Component and (if it has one) its SceneElement. More...

void	setName (const std::string &name)
	Sets the name of component. More...

boost::uuids::uuid	getUuid () const
	Gets the id of the component.

bool	isInitialized () const

bool	initialize (const std::weak_ptr< Runtime > &runtime)
	Initialize this component, this needs to be called before wakeUp() can be called. More...

bool	isAwake () const

bool	wakeUp ()
	Wakeup this component, this will be called when the component is inserted into the ComponentManager that is responsible for handling this component. More...

void	retire ()
	Retire this component, this will be called when the component is removed from the ComponentManager that is responsible for handling this component. More...

void	setScene (std::weak_ptr< Scene > scene)
	Sets the scene. More...

std::shared_ptr< Scene >	getScene ()
	Gets the scene. More...

void	setSceneElement (std::weak_ptr< SceneElement > sceneElement)
	Sets the scene element. More...

std::shared_ptr< SceneElement >	getSceneElement ()
	Gets the scene element. More...

std::shared_ptr< const SceneElement >	getSceneElement () const
	Gets the scene element, constant version. More...

std::shared_ptr< Runtime >	getRuntime () const
	Get the runtime which contains this component. More...

virtual std::string	getClassName () const
	The class name for this class, this being the base class it should return SurgSim::Framework::Component but this would make missing implemenentations of this hard to catch, therefore this calls SURGSIM_FAILURE. More...

std::shared_ptr< Component >	getSharedPtr ()
	Gets a shared pointer to this component. More...

virtual bool	doInitialize ()=0
	Interface to be implemented by derived classes. More...

virtual bool	doWakeUp ()=0
	Interface to be implemented by derived classes. More...

virtual void	doRetire ()
	Interface to be implemented by derived classes Has a default implementation, does nothing.

bool	isActive () const

virtual void	setLocalActive (bool val)
	Set the component's active state. More...

bool	isLocalActive () const

Public Member Functions inherited from SurgSim::Framework::Accessible
	Accessible ()
	Default Constructor.

	~Accessible ()
	Destructor.

template<class T >
T	getValue (const std::string &name) const
	Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...

boost::any	getValue (const std::string &name) const
	Retrieves the value with the name by executing the getter if it is found. More...

template<class T >
bool	getValue (const std::string &name, T *value) const
	Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...

void	setValue (const std::string &name, const boost::any &value)
	Sets a value of a property that has setter. More...

bool	isReadable (const std::string &name) const
	Check whether a property is readable. More...

bool	isWriteable (const std::string &name) const
	Check whether a property is writable. More...

void	setGetter (const std::string &name, GetterType func)
	Sets a getter for a given property. More...

void	setSetter (const std::string &name, SetterType func)
	Sets a setter for a given property. More...

void	setAccessors (const std::string &name, GetterType getter, SetterType setter)
	Sets the accessors getter and setter in one function. More...

void	removeAccessors (const std::string &name)
	Removes all the accessors (getter and setter) for a given property. More...

void	forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
	Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...

void	setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
	Sets the functions used to convert data from and to a YAML::Node. More...

void	setDecoder (const std::string &name, DecoderType decoder)
	Sets the functions used to convert data from a YAML::Node. More...

YAML::Node	encode () const
	Encode this Accessible to a YAML::Node. More...

void	decode (const YAML::Node &node, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
	Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...

std::vector< std::string >	getProperties ()

template<>
boost::any	getValue (const std::string &name) const

Additional Inherited Members
Public Types inherited from SurgSim::Framework::Accessible
typedef std::function< boost::any(void)>	GetterType

typedef std::function< void(boost::any)>	SetterType

typedef std::function< YAML::Node(void)>	EncoderType

typedef std::function< void(const YAML::Node *)>	DecoderType

Public Types inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
typedef ObjectFactory1< Component, std::string >	FactoryType

Static Public Member Functions inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
static FactoryType &	getFactory ()

Protected Member Functions inherited from SurgSim::Framework::Component
virtual std::shared_ptr< PoseComponent >	getPoseComponent ()
	Get the PoseComponent for this component. More...

virtual std::shared_ptr< const PoseComponent >	getPoseComponent () const
	Get the PoseComponent for this component, constant access. More...

Detailed Description

Base class that defines the interface for graphics materials.

Graphics materials define the visual appearance of graphics representations and are composed of the uniforms and shaders applied used when rendering the geometry.

See also: UniformBase; Shader

Member Function Documentation

§ addUniform() [1/2]

virtual void SurgSim::Graphics::Material::addUniform ( std::shared_ptr< UniformBase > uniform )

pure virtual

Adds a uniform to this material.

Parameters

uniform Uniform to add.

Implemented in SurgSim::Graphics::OsgMaterial.

§ addUniform() [2/2]

virtual void SurgSim::Graphics::Material::addUniform	(	const std::string &	type,
		const std::string &	name
	)

pure virtual

Adds a GLSL typed uniform to this material.

Parameters

type	the type of the uniform
name	the name that this uniform should have

Implemented in SurgSim::Graphics::OsgMaterial.

§ getProgram()

virtual std::shared_ptr<Program> SurgSim::Graphics::Material::getProgram ( ) const

pure virtual

Gets the program used by this material.

Returns: Shader program.

Implemented in SurgSim::Graphics::OsgMaterial.

§ getUniform() [1/2]

virtual std::shared_ptr<UniformBase> SurgSim::Graphics::Material::getUniform ( const std::string & name ) const

pure virtual

Gets a uniform in this material.

Parameters

name	The name of the Uniform to fetch.

Returns: The uniform, nullptr if the uniform does not exist.

Implemented in SurgSim::Graphics::OsgMaterial.

§ getUniform() [2/2]

virtual std::shared_ptr<UniformBase> SurgSim::Graphics::Material::getUniform ( size_t index ) const

pure virtual

Gets a uniform in this material.

Parameters

index Index of the uniform in the material's list of uniforms

Returns: Uniform at the index

Implemented in SurgSim::Graphics::OsgMaterial.

§ hasUniform()

virtual bool SurgSim::Graphics::Material::hasUniform ( const std::string & name ) const

pure virtual

Checks if this material has a uniform with the given name.

Parameters

name	The name of the Uniform to check.

Returns: true if the uniform is in the material, false otherwise.

Implemented in SurgSim::Graphics::OsgMaterial.

§ removeUniform() [1/2]

virtual bool SurgSim::Graphics::Material::removeUniform ( std::shared_ptr< UniformBase > uniform )

pure virtual

Removes a uniform from this material.

Parameters

uniform Uniform to remove.

Returns: True if uniform was removed successfully, otherwise false.

Implemented in SurgSim::Graphics::OsgMaterial.

§ removeUniform() [2/2]

virtual bool SurgSim::Graphics::Material::removeUniform ( const std::string & name )

pure virtual

Removes a uniform from this material.

Parameters

name	Uniform to remove.

Returns: True if uniform was removed successfully, otherwise false.

Implemented in SurgSim::Graphics::OsgMaterial.

§ setProgram()

virtual bool SurgSim::Graphics::Material::setProgram ( std::shared_ptr< Program > program )

pure virtual

Sets the program used by this material.

Parameters

program Shader program.

Returns: True if program was set successfully, otherwise false.

Implemented in SurgSim::Graphics::OsgMaterial.

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

SurgSim/Graphics/Material.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

§ addUniform() [1/2]

§ addUniform() [2/2]

§ getProgram()

§ getUniform() [1/2]

§ getUniform() [2/2]

§ hasUniform()

§ removeUniform() [1/2]

§ removeUniform() [2/2]

§ setProgram()