SurgSim::Graphics::OsgScreenSpaceQuadRepresentation Class Reference

Implements the ScreenSpaceQuadRepresentation, provides the uniform 'texture' for the texture that it carries. More...

`#include <SurgSim/Graphics/OsgScreenSpaceQuadRepresentation.h>`

Inheritance diagram for SurgSim::Graphics::OsgScreenSpaceQuadRepresentation:

## Public Member Functions

| OsgScreenSpaceQuadRepresentation (const std::string &name)
| Constructor. More...
| ~OsgScreenSpaceQuadRepresentation ()
virtual void | setLocation (double x, double y)
| Sets the location in screen space. More...
virtual void | getLocation (double *x, double *y)
| Gets the location in screen space. More...
void | setSize (double width, double height) override
| Sets the size for the quad in screen coordinates. More...
void | getSize (double *width, double *height) const override
| Gets the size of the quad. More...
bool | setTexture (std::shared_ptr< Texture > texture) override
| Sets a Texture for this quad, this should replace a current texture, this is a convenience function and this will use the uniform name "texture" for the uniform in this operation. More...
bool | setTexture (std::shared_ptr< OsgTexture2d > texture)
| Sets a Texture2d for this quad, this should replace a current texture, this is a convenience function and this will use the uniform name "texture" for the uniform in this operation. More...
bool | setTexture (std::shared_ptr< OsgTextureRectangle > texture)
| Sets a rectangular texture for this quad, this should replace a current texture, this is a convenience function and will use the uniform name "texture" for the uniform in this operation. More...
void | setTransparent (bool value)
| Sets whether or not the alpha component of the texture should be used for transparancy blending. More...
bool | isTransparent ()
| Gets whether or not the alpha component of the texture should be used for transparancy blending. 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< Material > | getMaterial () 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...
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< 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 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 >
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::ScreenSpaceQuadRepresentation
| ScreenSpaceQuadRepresentation (const std::string name)
| Constructor. More...
| ~ScreenSpaceQuadRepresentation ()
SurgSim::Math::RigidTransform3d | getPose () const override

## Protected Member Functions

void | doUpdate (double dt) override
bool | doInitialize () override
| Interface to be implemented by derived classes. More...
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< 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...

## Private Member Functions

void | setTextureCoordinates (float left, float bottom, float right, float top)
| Sets texture coordinates for the quad. More...
bool | replaceUniform (const std::string &name, std::shared_ptr< SurgSim::Graphics::UniformBase > newUniform)
| Replace a uniform in the material, will create the material if necessary. More...

## Private Attributes

osg::ref_ptr< osg::Geode > | m_geode
| Local geode to contain geometry. More...
osg::ref_ptr< osg::Geometry > | m_geometry
| Local geometry pointer. More...
osg::ref_ptr< osg::Projection > | m_projection
| Projection matrix, needs to be updated when the view is changed. More...
osg::Vec3 | m_scale
| Size of the quad. More...
std::shared_ptr< OsgUniform< std::shared_ptr< OsgTexture2d > > > | m_textureUniform
| Uniform to carry the power of two texture, "texture". More...
std::shared_ptr< OsgUniform< std::shared_ptr< OsgTextureRectangle > > > | m_rectangleTextureUniform
| Uniform to carry the rectangle texture "texture". More...
SurgSim::DataStructures::OptionalValue< int > | m_texureType
| Indicate which type of texture is currently being used. More...
int | m_displayWidth
int | m_displayHeight

## 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 ()
Static Public Attributes inherited from SurgSim::Graphics::Representation
static const std::string | DefaultGroupName = "__OssDefault__"
static const std::string | DefaultHudGroupName = "__OssDefaulHud__"
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< OsgMaterial > | m_material
| Material defining the visual appearance of the representation. More...
osg::ref_ptr< TangentSpaceGenerator > | m_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

Implements the ScreenSpaceQuadRepresentation, provides the uniform 'texture' for the texture that it carries.

## Constructor & Destructor Documentation

## OsgScreenSpaceQuadRepresentation()

SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::OsgScreenSpaceQuadRepresentation | ( | const std::string & | name | ) |

explicit

Constructor.

## ~OsgScreenSpaceQuadRepresentation()

SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::~OsgScreenSpaceQuadRepresentation | ( |  | ) |

## Member Function Documentation

## doInitialize()

bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::doInitialize | ( |  | ) |

override protected virtual

Interface to be implemented by derived classes.

Returns
  True if component is initialized successfully; otherwise, false.

Reimplemented from SurgSim::Framework::Representation.

## doUpdate()

void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::doUpdate | ( | double | dt | ) |

override protected virtual

Reimplemented from SurgSim::Graphics::OsgRepresentation.

## getLocation()

void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::getLocation | ( | double * | x,
|  | double * | y
| ) |  |

virtual

Gets the location in screen space.

Parameters

  [out] | x,y | If non-null the x and y coordinates. Throws exception otherwise.

Implements SurgSim::Graphics::ScreenSpaceQuadRepresentation.

## getSize()

void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::getSize | ( | double * | width,
|  | double * | height
| ) |  | const

override virtual

Gets the size of the quad.

Parameters

  [out] | width | If non-null, the width. Throws exception otherwise.
  [out] | height | If non-null, the height. Throws exception otherwise.

Implements SurgSim::Graphics::ScreenSpaceQuadRepresentation.

## isTransparent()

bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::isTransparent | ( |  | ) |

Gets whether or not the alpha component of the texture should be used for transparancy blending.

Returns
  true if this will render last, allowing alpha-based blending to work.

## replaceUniform()

bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::replaceUniform | ( | const std::string & | name,
|  | std::shared_ptr< SurgSim::Graphics::UniformBase > | newUniform
| ) |  |

private

Replace a uniform in the material, will create the material if necessary.

Parameters

  name | The name of the uniform to replace.
  newUniform | The new uniform.

Returns
  true if it succeeds, false if it fails.

## setLocation()

void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setLocation | ( | double | x,
|  | double | y
| ) |  |

virtual

Sets the location in screen space.

Parameters

  x,y | The x and y coordinates.

Implements SurgSim::Graphics::ScreenSpaceQuadRepresentation.

## setSize()

void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setSize | ( | double | width,
|  | double | height
| ) |  |

override virtual

Sets the size for the quad in screen coordinates.

Parameters

  width | The width of the quad in screen coordinates.
  height | The height of the quad in screen coordinates.

Implements SurgSim::Graphics::ScreenSpaceQuadRepresentation.

## setTexture() [1/3]

bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setTexture | ( | std::shared_ptr< Texture > | texture | ) |

override virtual

Sets a Texture for this quad, this should replace a current texture, this is a convenience function and this will use the uniform name "texture" for the uniform in this operation.

This can be accomplished from the outside as well by using the material.

Parameters

  texture | The texture to be set on the quad.

Returns
  true if it succeeds, false if it fails.

Implements SurgSim::Graphics::ScreenSpaceQuadRepresentation.

## setTexture() [2/3]

bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setTexture | ( | std::shared_ptr< OsgTexture2d > | texture | ) |

Sets a Texture2d for this quad, this should replace a current texture, this is a convenience function and this will use the uniform name "texture" for the uniform in this operation.

This can be accomplished from the outside as well by using the material.

Parameters

  texture | The texture to be set on the quad.

Returns
  true if it succeeds, false if it fails.

## setTexture() [3/3]

bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setTexture | ( | std::shared_ptr< OsgTextureRectangle > | texture | ) |

Sets a rectangular texture for this quad, this should replace a current texture, this is a convenience function and will use the uniform name "texture" for the uniform in this operation.

Exceptions

  SurgSim::Framework::AssertionFailure | if the type of the texture is changed during runtime.

Parameters

  texture | The texture to be set on the quad.

Returns
  true if it succeeds, false if it fails.

## setTextureCoordinates()

void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setTextureCoordinates | ( | float | left,
|  | float | bottom,
|  | float | right,
|  | float | top
| ) |  |

private

Sets texture coordinates for the quad.

Parameters

  left,bottom,right,top | The extents for the texture coordinates for the corners of the quad.

## setTransparent()

void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setTransparent | ( | bool | value | ) |

Sets whether or not the alpha component of the texture should be used for transparancy blending.

Parameters

  value | true will render this last, allowing alpha-based blending to work.

## Member Data Documentation

## m_displayHeight

int SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_displayHeight

private

Cached view extensions

## m_displayWidth

int SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_displayWidth

private

Cached view extensions

## m_geode

osg::ref_ptr<osg::Geode> SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_geode

private

Local geode to contain geometry.

## m_geometry

osg::ref_ptr<osg::Geometry> SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_geometry

private

Local geometry pointer.

## m_projection

osg::ref_ptr<osg::Projection> SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_projection

private

Projection matrix, needs to be updated when the view is changed.

## m_rectangleTextureUniform

std::shared_ptr<OsgUniform<std::shared_ptr<OsgTextureRectangle> > > SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_rectangleTextureUniform

private

Uniform to carry the rectangle texture "texture".

## m_scale

osg::Vec3 SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_scale

private

Size of the quad.

## m_textureUniform

std::shared_ptr<OsgUniform<std::shared_ptr<OsgTexture2d> > > SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_textureUniform

private

Uniform to carry the power of two texture, "texture".

## m_texureType

SurgSim::DataStructures::OptionalValue<int> SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_texureType

private

Indicate which type of texture is currently being used.

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

- SurgSim/Graphics/OsgScreenSpaceQuadRepresentation.h
- SurgSim/Graphics/OsgScreenSpaceQuadRepresentation.cpp