Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
SurgSim::Graphics::OsgLight Class Reference

OpenScenegraph implementation for the Light interface. More...

#include <SurgSim/Graphics/OsgLight.h>

Inheritance diagram for SurgSim::Graphics::OsgLight:
SurgSim::Graphics::OsgRepresentation SurgSim::Graphics::Light SurgSim::Graphics::Representation SurgSim::Graphics::Representation SurgSim::Framework::Representation SurgSim::Framework::Representation SurgSim::Framework::Component SurgSim::Framework::Component SurgSim::Framework::Accessible SurgSim::Framework::FactoryBase1< Component, std::string > SurgSim::Framework::Accessible SurgSim::Framework::FactoryBase1< Component, std::string >

Public Member Functions

 OsgLight (const std::string &name)
 Constructor. More...
 
virtual ~OsgLight ()
 
 SURGSIM_CLASSNAME (SurgSim::Graphics::OsgLight)
 
bool setGroup (std::shared_ptr< SurgSim::Graphics::Group > group) override
 Sets the group for this light, setting nullptr here will remove the light from its current group. More...
 
void setLightGroupReference (const std::string &name) override
 Sets the name of the group that this light should work on. More...
 
std::string getLightGroupReference () override
 Gets the name of the group this light should operate on. More...
 
std::shared_ptr< SurgSim::Graphics::GroupgetGroup () override
 Gets the group that this light has been assigned to. More...
 
void setDiffuseColor (const SurgSim::Math::Vector4d &color) override
 Sets diffuse color of this light. More...
 
SurgSim::Math::Vector4d getDiffuseColor () override
 Gets diffuse color. More...
 
void setSpecularColor (const SurgSim::Math::Vector4d &color) override
 Sets specular color of this light. More...
 
SurgSim::Math::Vector4d getSpecularColor () override
 Gets specular color. More...
 
void setConstantAttenuation (double val) override
 Sets constant attenuation. More...
 
double getConstantAttenuation () override
 Gets constant attenuation. More...
 
void setLinearAttenuation (double val) override
 Sets linear attenuation. More...
 
double getLinearAttenuation () override
 Gets linear attenuation. More...
 
void setQuadraticAttenuation (double val) override
 Sets quadratic attenuation. More...
 
double getQuadraticAttenuation () override
 Gets quadratic attenuation. More...
 
- Public Member Functions inherited from SurgSim::Graphics::OsgRepresentation
 OsgRepresentation (const std::string &name)
 Constructor. More...
 
virtual ~OsgRepresentation ()
 Destructor. More...
 
osg::ref_ptr< osg::Node > getOsgNode () const
 Returns the root OSG Node for this representations portion of the scene graph. More...
 
bool setMaterial (std::shared_ptr< SurgSim::Framework::Component > material) override
 Sets the material that defines the visual appearance of the representation. More...
 
std::shared_ptr< MaterialgetMaterial () const override
 Gets the material that defines the visual appearance of the representation. More...
 
void clearMaterial () override
 Removes the material from the representation. More...
 
void setDrawAsWireFrame (bool val) override
 Sets the representation to render as a wire frame. More...
 
bool getDrawAsWireFrame () const override
 Return if the representation is rendered as a wire frame. More...
 
void setGenerateTangents (bool value) override
 Enable the generation of tangents When enabled it is up to the subclasses responsibility to react to changes and trigger the regeneration of Tangents. More...
 
bool isGeneratingTangents () const override
 
void update (double dt) override
 Updates the representation. More...
 
void addUniform (std::shared_ptr< SurgSim::Graphics::UniformBase > uniform)
 Adds a uniform to this representation. More...
 
void addUniform (const std::string &type, const std::string &name, const boost::any &value)
 Adds and a uniform to this representation and set its value. More...
 
- Public Member Functions inherited from SurgSim::Graphics::Representation
 Representation (const std::string &name)
 Constructor. More...
 
virtual ~Representation ()
 Destructor. More...
 
virtual bool addGroupReference (const std::string &name)
 Add a reference to a group, this will eventual add this representation to the group with the the same name. More...
 
void addGroupReferences (const std::vector< std::string > &groups)
 Adds a list of group references. More...
 
void setGroupReferences (const std::vector< std::string > &groups)
 Sets the list of group references. More...
 
void setGroupReference (const std::string &group)
 Helper functions, this clears all the references and sets, only the reference given in the parameter. More...
 
std::vector< std::string > getGroupReferences () const
 Gets group references. More...
 
bool removeGroupReference (const std::string &group)
 Function to remove an unwanted reference. More...
 
void clearGroupReferences ()
 Clear all the Group references. More...
 
- Public Member Functions inherited from SurgSim::Framework::Representation
 Representation (const std::string &name)
 Constructor. More...
 
virtual void setLocalPose (const SurgSim::Math::RigidTransform3d &pose)
 Set the pose of the representation with respect to the Scene Element. More...
 
virtual SurgSim::Math::RigidTransform3d getLocalPose () const
 Get the pose of the representation with respect to the Scene Element. More...
 
virtual SurgSim::Math::RigidTransform3d getPose () const
 Get the pose of the representation in world coordinates. More...
 
- Public Member Functions inherited from SurgSim::Framework::Component
 Component (const std::string &name)
 Constructor. More...
 
virtual ~Component ()
 Destructor. More...
 
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. More...
 
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< ScenegetScene ()
 Gets the scene. More...
 
void setSceneElement (std::weak_ptr< SceneElement > sceneElement)
 Sets the scene element. More...
 
std::shared_ptr< SceneElementgetSceneElement ()
 Gets the scene element. More...
 
std::shared_ptr< const SceneElementgetSceneElement () const
 Gets the scene element, constant version. More...
 
std::shared_ptr< RuntimegetRuntime () 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< ComponentgetSharedPtr ()
 Gets a shared pointer to this component. More...
 
virtual void doRetire ()
 Interface to be implemented by derived classes Has a default implementation, does nothing. More...
 
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. More...
 
 ~Accessible ()
 Destructor. More...
 
template<class 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...
 
template<>
boost::any getValue (const std::string &name) const
 
- Public Member Functions inherited from SurgSim::Graphics::Light
 Light (const std::string &name)
 Constructor. More...
 
virtual ~Light ()
 

Private Types

enum  UniformType {
  POSITION = 0, DIFFUSE_COLOR, SPECULAR_COLOR, CONSTANT_ATTENUATION,
  LINEAR_ATTENUATION, QUADRATIC_ATTENUATION
}
 Internal for managing uniforms. More...
 

Private Member Functions

void doUpdate (double dt) override
 
void apply (osg::ref_ptr< osg::StateSet > stateSet)
 Applies all the lights variables to the given StateSet. More...
 
void remove (osg::ref_ptr< osg::StateSet > stateSet)
 Removes all the lights variable from the given StateSet. More...
 

Private Attributes

std::shared_ptr< OsgGroupm_group
 The group for this light. More...
 
std::unordered_map< int, osg::ref_ptr< osg::Uniform > > m_uniforms
 Map for managing all uniforms that this object owns. More...
 
SurgSim::Math::Vector4d m_diffuseColor
 The actual diffuse color that was set. More...
 
SurgSim::Math::Vector4d m_specularColor
 The actual specular color that was set. More...
 
double m_constantAttenuation
 The actual constant attenuation value that was set. More...
 
double m_linearAttenuation
 The actual linear attenuation value that was set. More...
 
double m_quadraticAttenuation
 The actual quadratic attenuation value that was set. More...
 
std::string m_groupReference
 Name of the group that this light should shine on... More...
 
osg::ref_ptr< osg::Light > m_light
 
osg::ref_ptr< osg::LightSource > m_lightSource
 

Friends

class OsgLightTests
 If we use the uniforms map, to check for all the uniforms that should be set in the stateset, then we can reduce the breakability of the unittest. More...
 

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 FactoryTypegetFactory ()
 
- Static Public Attributes inherited from SurgSim::Graphics::Representation
static const std::string DefaultGroupName = "__OssDefault__"
 
static const std::string DefaultHudGroupName = "__OssDefaulHud__"
 
- Protected Member Functions inherited from SurgSim::Graphics::OsgRepresentation
void setVisible (bool val)
 Set the visibility of this representation. More...
 
void updateTangents ()
 Causes the tangents to be recalculated if tangent generation is enabled Subclasses should call this whenever the state changes in a way that need tangents to be recalculated. More...
 
- Protected Member Functions inherited from SurgSim::Framework::Component
virtual std::shared_ptr< PoseComponentgetPoseComponent ()
 Get the PoseComponent for this component. More...
 
virtual std::shared_ptr< const PoseComponentgetPoseComponent () const
 Get the PoseComponent for this component, constant access. More...
 
- Protected Attributes inherited from SurgSim::Graphics::OsgRepresentation
osg::ref_ptr< osg::Switch > m_switch
 Switch used to toggle the visibility of the representation. More...
 
osg::ref_ptr< osg::PositionAttitudeTransform > m_transform
 Transform used to pose the representation. More...
 
osg::ref_ptr< osg::Group > m_materialProxy
 Holder for attributes coming from OsgMaterial. More...
 
std::shared_ptr< OsgMaterialm_material
 Material defining the visual appearance of the representation. More...
 
osg::ref_ptr< TangentSpaceGeneratorm_tangentGenerator
 Visitor to generate tangents. More...
 
bool m_drawAsWireFrame
 Indicates if the representation is rendered as a wireframe. More...
 
std::shared_ptr< OsgUniform< SurgSim::Math::Matrix44f > > m_modelMatrixUniform
 

Detailed Description

OpenScenegraph implementation for the Light interface.

Member Enumeration Documentation

§ UniformType

Internal for managing uniforms.

Enumerator
POSITION 
DIFFUSE_COLOR 
SPECULAR_COLOR 
CONSTANT_ATTENUATION 
LINEAR_ATTENUATION 
QUADRATIC_ATTENUATION 

Constructor & Destructor Documentation

§ OsgLight()

SurgSim::Graphics::OsgLight::OsgLight ( const std::string &  name)
explicit

Constructor.

Note
HS-2013-sep-09 Right now we are implementing all the shader uniforms as floats, this means that they all have to be downconverted from double, i don't know what the hit of going to double in the shaders would be

§ ~OsgLight()

SurgSim::Graphics::OsgLight::~OsgLight ( )
virtual

Member Function Documentation

§ apply()

void SurgSim::Graphics::OsgLight::apply ( osg::ref_ptr< osg::StateSet >  stateSet)
private

Applies all the lights variables to the given StateSet.

§ doUpdate()

void SurgSim::Graphics::OsgLight::doUpdate ( double  dt)
overrideprivatevirtual

§ getConstantAttenuation()

double SurgSim::Graphics::OsgLight::getConstantAttenuation ( )
overridevirtual

Gets constant attenuation.

Returns
The constant attenuation.

Implements SurgSim::Graphics::Light.

§ getDiffuseColor()

SurgSim::Math::Vector4d SurgSim::Graphics::OsgLight::getDiffuseColor ( )
overridevirtual

Gets diffuse color.

Returns
The diffuse color.

Implements SurgSim::Graphics::Light.

§ getGroup()

std::shared_ptr< SurgSim::Graphics::Group > SurgSim::Graphics::OsgLight::getGroup ( )
overridevirtual

Gets the group that this light has been assigned to.

Returns
The group or nullptr if no group has been set.

Implements SurgSim::Graphics::Light.

§ getLightGroupReference()

std::string SurgSim::Graphics::OsgLight::getLightGroupReference ( )
overridevirtual

Gets the name of the group this light should operate on.

Returns
the name of the group for this light

Implements SurgSim::Graphics::Light.

§ getLinearAttenuation()

double SurgSim::Graphics::OsgLight::getLinearAttenuation ( )
overridevirtual

Gets linear attenuation.

Returns
The linear attenuation.

Implements SurgSim::Graphics::Light.

§ getQuadraticAttenuation()

double SurgSim::Graphics::OsgLight::getQuadraticAttenuation ( )
overridevirtual

Gets quadratic attenuation.

Returns
The quadratic attenuation.

Implements SurgSim::Graphics::Light.

§ getSpecularColor()

SurgSim::Math::Vector4d SurgSim::Graphics::OsgLight::getSpecularColor ( )
overridevirtual

Gets specular color.

Returns
The specular color.

Implements SurgSim::Graphics::Light.

§ remove()

void SurgSim::Graphics::OsgLight::remove ( osg::ref_ptr< osg::StateSet >  stateSet)
private

Removes all the lights variable from the given StateSet.

§ setConstantAttenuation()

void SurgSim::Graphics::OsgLight::setConstantAttenuation ( double  val)
overridevirtual

Sets constant attenuation.

Parameters
valThe value.

Implements SurgSim::Graphics::Light.

§ setDiffuseColor()

void SurgSim::Graphics::OsgLight::setDiffuseColor ( const SurgSim::Math::Vector4d color)
overridevirtual

Sets diffuse color of this light.

Parameters
colorThe color.

Implements SurgSim::Graphics::Light.

§ setGroup()

bool SurgSim::Graphics::OsgLight::setGroup ( std::shared_ptr< SurgSim::Graphics::Group group)
overridevirtual

Sets the group for this light, setting nullptr here will remove the light from its current group.

Parameters
groupThe group.
Returns
true if it succeeds, false if the group is not an OsgGroup.

Implements SurgSim::Graphics::Light.

§ setLightGroupReference()

void SurgSim::Graphics::OsgLight::setLightGroupReference ( const std::string &  name)
overridevirtual

Sets the name of the group that this light should work on.

Parameters
nameThe name of the group to light

Implements SurgSim::Graphics::Light.

§ setLinearAttenuation()

void SurgSim::Graphics::OsgLight::setLinearAttenuation ( double  val)
overridevirtual

Sets linear attenuation.

Parameters
valThe value.

Implements SurgSim::Graphics::Light.

§ setQuadraticAttenuation()

void SurgSim::Graphics::OsgLight::setQuadraticAttenuation ( double  val)
overridevirtual

Sets quadratic attenuation.

Parameters
valThe value.

Implements SurgSim::Graphics::Light.

§ setSpecularColor()

void SurgSim::Graphics::OsgLight::setSpecularColor ( const SurgSim::Math::Vector4d color)
overridevirtual

Sets specular color of this light.

Parameters
colorThe color.

Implements SurgSim::Graphics::Light.

§ SURGSIM_CLASSNAME()

SurgSim::Graphics::OsgLight::SURGSIM_CLASSNAME ( SurgSim::Graphics::OsgLight  )

Friends And Related Function Documentation

§ OsgLightTests

friend class OsgLightTests
friend

If we use the uniforms map, to check for all the uniforms that should be set in the stateset, then we can reduce the breakability of the unittest.

Member Data Documentation

§ m_constantAttenuation

double SurgSim::Graphics::OsgLight::m_constantAttenuation
private

The actual constant attenuation value that was set.

§ m_diffuseColor

SurgSim::Math::Vector4d SurgSim::Graphics::OsgLight::m_diffuseColor
private

The actual diffuse color that was set.

§ m_group

std::shared_ptr<OsgGroup> SurgSim::Graphics::OsgLight::m_group
private

The group for this light.

§ m_groupReference

std::string SurgSim::Graphics::OsgLight::m_groupReference
private

Name of the group that this light should shine on...

§ m_light

osg::ref_ptr<osg::Light> SurgSim::Graphics::OsgLight::m_light
private

Osg instances to manage the light

§ m_lightSource

osg::ref_ptr<osg::LightSource> SurgSim::Graphics::OsgLight::m_lightSource
private

Osg instances to manage the light

§ m_linearAttenuation

double SurgSim::Graphics::OsgLight::m_linearAttenuation
private

The actual linear attenuation value that was set.

§ m_quadraticAttenuation

double SurgSim::Graphics::OsgLight::m_quadraticAttenuation
private

The actual quadratic attenuation value that was set.

§ m_specularColor

SurgSim::Math::Vector4d SurgSim::Graphics::OsgLight::m_specularColor
private

The actual specular color that was set.

§ m_uniforms

std::unordered_map<int, osg::ref_ptr<osg::Uniform> > SurgSim::Graphics::OsgLight::m_uniforms
private

Map for managing all uniforms that this object owns.


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