SurgSim::Graphics::OsgScreenSpacePass Class Reference

Special RenderPass to draw items using a orthogonal projection, this is specific to the Osg implementation of the SurgSim rendering. More...

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

Inheritance diagram for SurgSim::Graphics::OsgScreenSpacePass:

## Public Member Functions

| OsgScreenSpacePass (const std::string &name)
| Constructor. More...
virtual | ~OsgScreenSpacePass ()
| Destructor. More...
void | setViewPort (int width, int height)
| Set viewport dimensions. More...
bool | doInitialize () override
| Initialize this Component. More...
Public Member Functions inherited from SurgSim::Graphics::RenderPass
| RenderPass (const std::string &name)
| Constructor. More...
| ~RenderPass ()
bool | doInitialize () override
| Executes the initialize operation. More...
bool | setRenderTarget (std::shared_ptr< RenderTarget > target)
| Sets render target for the camera, this abstracts the textures that are being used for rendering into. More...
std::shared_ptr< RenderTarget > | getRenderTarget ()
| Gets render target that is being used in this pass. More...
virtual void | setRenderOrder (SurgSim::Graphics::Camera::RenderOrder order, int value)
| Sets render order. More...
std::shared_ptr< Camera > | getCamera ()
| Gets the camera. More...
bool | setMaterial (std::shared_ptr< SurgSim::Framework::Component > material)
| Sets the material used for rendering. More...
std::shared_ptr< Material > | getMaterial ()
| Gets the current material. More...
void | showColorTarget (int x, int y, int width, int height)
| Shows a quad on the screen with the texture used as the color target for this pass. More...
void | hideColorTarget ()
| Hides the color target display. More...
void | showDepthTarget (int x, int y, int width, int height)
| Shows a quad on the screen with the texture used as the depth target for this pass. More...
void | hideDepthTarget ()
| Hides the depth target display. More...
Public Member Functions inherited from SurgSim::Framework::SceneElement
| SceneElement (const std::string &name)
| Constructor. More...
virtual | ~SceneElement ()
| Destructor. More...
virtual std::string | getClassName () const
bool | addComponent (std::shared_ptr< Component > component)
| Adds a component, calls initialize() on the component, if SceneElement::isInitialized() is true. More...
bool | removeComponent (std::shared_ptr< Component > component)
| Removes a given component. More...
bool | removeComponent (const std::string &name)
| Removes the component described by name. More...
void | removeComponents ()
| Removes all components. More...
std::shared_ptr< Component > | getComponent (const std::string &name) const
| Gets the component identified by name. More...
std::vector< std::shared_ptr< Component > > | getComponents () const
| Gets all the components of this SceneElement. More...
template<class T >
std::vector< std::shared_ptr< T > > | getComponents () const
| Template version of getComponents method to get all the components with type T. More...
template<class T >
T | getValue (const std::string &component, const std::string &property) const
| Retrieves the property value from a component. More...
boost::any | getValue (const std::string &component, const std::string &property) const
| Retrieves the property value from a component. More...
template<class T >
bool | getValue (const std::string &component, const std::string &property, T *value) const
| Retrieves the property value from a component, and convertis it to the type of the output parameter. More...
void | setValue (const std::string &component, const std::string &property, const boost::any &value)
| Sets the property value of a component. More...
void | addToGroup (const std::string &group)
| Add this scene element to the given group. More...
void | removeFromGroup (const std::string &group)
| Remove this scene element from the given group. More...
void | setGroups (const std::vector< std::string > &groups)
| Set the groups of this scene element. More...
std::vector< std::string > | getGroups () const
bool | inGroup (const std::string &name)
| Test whether this SceneElement is in a specific group. More...
bool | initialize ()
| Executes the initialize operation. More...
std::string | getName () const
| Return the name of this SceneElement. More...
void | setPose (const SurgSim::Math::RigidTransform3d &pose)
| Set the pose of this SceneElement. More...
const SurgSim::Math::RigidTransform3d & | getPose () const
| Get the pose of this SceneElement. More...
std::shared_ptr< PoseComponent > | getPoseComponent ()
| Get the PoseComponent that controls the pose all Representations in this SceneElement. More...
void | setScene (std::weak_ptr< Scene > scene)
| Sets the Scene. More...
std::shared_ptr< Scene > | getScene ()
| Gets the Scene. More...
void | setRuntime (std::weak_ptr< Runtime > runtime)
| Sets the Runtime. More...
std::shared_ptr< Runtime > | getRuntime ()
| Gets the runtime. More...
bool | isInitialized () const
| Return if this SceneElement is initialized. More...
void | setActive (bool val)
| Set this SceneElement's status (active/inactive) More...
bool | isActive () const
std::shared_ptr< SceneElement > | getSharedPtr ()
| Gets a shared pointer to this SceneElement. More...
virtual YAML::Node | encode (bool standalone) const
| Convert to a YAML::Node. More...
virtual bool | decode (const YAML::Node &node)
| Pull data from a YAML::Node. More...

## Private Member Functions

void | updateViewport (int width, int height)
| Update the projection matrix. More...

## Private Attributes

osg::ref_ptr< osg::Camera > | m_camera
| The osg camera reference. More...
int | m_width
| The width of the viewport. More...
int | m_height
| The height of the viewport. More...

## Detailed Description

Special RenderPass to draw items using a orthogonal projection, this is specific to the Osg implementation of the SurgSim rendering.

## Constructor & Destructor Documentation

## OsgScreenSpacePass()

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

explicit

Constructor.

Parameters

  name | The name of the component

## ~OsgScreenSpacePass()

SurgSim::Graphics::OsgScreenSpacePass::~OsgScreenSpacePass | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## doInitialize()

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

override virtual

Initialize this Component.

Implements SurgSim::Framework::SceneElement.

## setViewPort()

void SurgSim::Graphics::OsgScreenSpacePass::setViewPort | ( | int | width,
|  | int | height
| ) |  |

Set viewport dimensions.

## updateViewport()

void SurgSim::Graphics::OsgScreenSpacePass::updateViewport | ( | int | width,
|  | int | height
| ) |  |

private

Update the projection matrix.

## Member Data Documentation

## m_camera

osg::ref_ptr<osg::Camera> SurgSim::Graphics::OsgScreenSpacePass::m_camera

private

The osg camera reference.

## m_height

int SurgSim::Graphics::OsgScreenSpacePass::m_height

private

The height of the viewport.

## m_width

int SurgSim::Graphics::OsgScreenSpacePass::m_width

private

The width of the viewport.

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

- SurgSim/Graphics/OsgScreenSpacePass.h
- SurgSim/Graphics/OsgScreenSpacePass.cpp