SurgSim::Graphics::ScreenSpaceQuadRepresentation Class Referenceabstract

A quad to display on the screen in screen space coordinates, use setPose() to set the position but x,y are presumed to be in screen space with 0|0 being in the lower left corner. More...

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

Inheritance diagram for SurgSim::Graphics::ScreenSpaceQuadRepresentation:

## Public Member Functions

| ScreenSpaceQuadRepresentation (const std::string name)
| Constructor. More...
| ~ScreenSpaceQuadRepresentation ()
virtual void | setLocation (double x, double y)=0
| Sets the location in screen space. More...
virtual void | getLocation (double *x, double *y)=0
| Gets the location in screen space. More...
virtual void | setSize (double width, double height)=0
| Sets the size for the quad in screen coordinates. More...
virtual void | getSize (double *width, double *height) const =0
| Gets the size of the quad. More...
virtual bool | setTexture (std::shared_ptr< Texture > texture)=0
| Sets a Texture for this quad, this should replace a current texture, this is a convenience function and this will use the uniform name "diffuseMap" for the uniform in this operation. More...
SurgSim::Math::RigidTransform3d | getPose () const override
Public Member Functions inherited from SurgSim::Graphics::Representation
| Representation (const std::string &name)
| Constructor. More...
virtual | ~Representation ()
| Destructor. More...
virtual bool | setMaterial (std::shared_ptr< SurgSim::Framework::Component > material)=0
| Sets the material that defines the visual appearance of the representation. More...
virtual std::shared_ptr< Material > | getMaterial () const =0
| Gets the material that defines the visual appearance of the representation. More...
virtual void | clearMaterial ()=0
| Removes the material from the representation. More...
virtual void | setDrawAsWireFrame (bool val)=0
| Sets the representation to render as a wire frame. More...
virtual bool | getDrawAsWireFrame () const =0
| Return if the representation is rendered as a wire frame. More...
virtual void | setGenerateTangents (bool value)=0
| Enable or disable the generation of tangents. More...
virtual bool | isGeneratingTangents () const =0
virtual void | update (double dt)=0
| Updates the representation. 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

## 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 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

A quad to display on the screen in screen space coordinates, use setPose() to set the position but x,y are presumed to be in screen space with 0|0 being in the lower left corner.

## Constructor & Destructor Documentation

## ScreenSpaceQuadRepresentation()

SurgSim::Graphics::ScreenSpaceQuadRepresentation::ScreenSpaceQuadRepresentation | ( | const std::string | name | ) |

inline explicit

Constructor.

Parameters

  name | The name.

## ~ScreenSpaceQuadRepresentation()

SurgSim::Graphics::ScreenSpaceQuadRepresentation::~ScreenSpaceQuadRepresentation | ( |  | ) |

inline

## Member Function Documentation

## getLocation()

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

pure virtual

Gets the location in screen space.

Parameters

  [out] | x,y | If non-null the x and y coordinates, may throw if null is passed.

Implemented in SurgSim::Graphics::OsgScreenSpaceQuadRepresentation.

## getPose()

SurgSim::Math::RigidTransform3d SurgSim::Graphics::ScreenSpaceQuadRepresentation::getPose | ( |  | ) | const

inline override virtual

Returns
  the pose of the quad, this disregards the SceneElement pose

Reimplemented from SurgSim::Framework::Representation.

## getSize()

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

pure virtual

Gets the size of the quad.

Parameters

  [out] | width | If non-null, the width, may throw if null is passed.
  [out] | height | If non-null, the height, may throw if null is passed.

Implemented in SurgSim::Graphics::OsgScreenSpaceQuadRepresentation.

## setLocation()

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

pure virtual

Sets the location in screen space.

Parameters

  x,y | The x and y coordinates.

Implemented in SurgSim::Graphics::OsgScreenSpaceQuadRepresentation.

## setSize()

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

pure 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.

Implemented in SurgSim::Graphics::OsgScreenSpaceQuadRepresentation.

## setTexture()

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

pure 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 "diffuseMap" 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.

Implemented in SurgSim::Graphics::OsgScreenSpaceQuadRepresentation.

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

- SurgSim/Graphics/ScreenSpaceQuadRepresentation.h