OSG-based implementation of graphics view element. More...

#include <OsgViewElement.h>

Inheritance diagram for SurgSim::Graphics::OsgViewElement:

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

virtual	~OsgViewElement ()
	Destructor.

bool	setView (std::shared_ptr< View > view) override
	Sets the view component that provides the visualization of the graphics representations Only allows OsgView components, any other will not be set and it will return false. More...

void	enableManipulator (bool val)
	Enables a camera manipulator, implemented via a trackball, this is a temporary solution as it uses the OSG input events rather than reading from the OpenSurgSim input. More...

void	setManipulatorParameters (const SurgSim::Math::Vector3d &position, const SurgSim::Math::Vector3d &lookat)
	As the camera is not accessible from here and as it cannot be controlled from the outside any more we let the user set the parameters from here. More...

std::shared_ptr< SurgSim::Input::CommonDevice >	getKeyboardDevice () override
	Return the keyboard to be used with this view. More...

void	enableKeyboardDevice (bool val) override
	Turn on/off the keyboard device to be used. More...

std::shared_ptr< SurgSim::Input::CommonDevice >	getMouseDevice () override
	Return the mouse to be used with this view. More...

void	enableMouseDevice (bool val) override
	Turn on/off the mouse device to be used. More...

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

virtual	~ViewElement ()
	Destructor.

std::shared_ptr< View >	getView ()
	Returns the view component that provides the visualization of the graphics representations. More...

void	setCamera (std::shared_ptr< Camera > camera)
	Sets the camera for the view in this sceneelement. More...

std::shared_ptr< Camera >	getCamera ()
	Get the camera for the view in this sceneelement. More...

Public Member Functions inherited from SurgSim::Framework::BasicSceneElement
	BasicSceneElement (const std::string &name)

virtual	~BasicSceneElement ()
	Destructor.

	SURGSIM_CLASSNAME (SurgSim::Framework::BasicSceneElement)

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

virtual	~SceneElement ()
	Destructor.

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.

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

Additional Inherited Members
Protected Member Functions inherited from SurgSim::Graphics::ViewElement
bool	doInitialize () override
	Initializes the scene element. More...

Protected Member Functions inherited from SurgSim::Framework::BasicSceneElement

Detailed Description

OSG-based implementation of graphics view element.

A Graphics::OsgViewElement creates and wraps a Graphics::OsgView so that it can be added to the Scene.

A Scene needs at least one Graphics::View component for any visualization of Graphics:Representation objects to be shown.

Constructor & Destructor Documentation

§ OsgViewElement()

OsgViewElement::OsgViewElement ( const std::string & name )

explicit

Constructor.

Parameters

name	Name of the scene element

Member Function Documentation

§ enableKeyboardDevice()

void SurgSim::Graphics::OsgViewElement::enableKeyboardDevice ( bool val )

overridevirtual

Turn on/off the keyboard device to be used.

Parameters

val	Indicate whether or not to use keyboard device

Implements SurgSim::Graphics::ViewElement.

§ enableManipulator()

void SurgSim::Graphics::OsgViewElement::enableManipulator ( bool val )

Enables a camera manipulator, implemented via a trackball, this is a temporary solution as it uses the OSG input events rather than reading from the OpenSurgSim input.

Parameters

val	whether to enable the manipulator or not.

§ enableMouseDevice()

void SurgSim::Graphics::OsgViewElement::enableMouseDevice ( bool val )

overridevirtual

Turn on/off the mouse device to be used.

Parameters

val	Indicate whether or not to use mouse device

Implements SurgSim::Graphics::ViewElement.

§ getKeyboardDevice()

std::shared_ptr< SurgSim::Input::CommonDevice > SurgSim::Graphics::OsgViewElement::getKeyboardDevice ( )

overridevirtual

Return the keyboard to be used with this view.

Returns: A keyboard device

Implements SurgSim::Graphics::ViewElement.

§ getMouseDevice()

std::shared_ptr< SurgSim::Input::CommonDevice > SurgSim::Graphics::OsgViewElement::getMouseDevice ( )

overridevirtual

Return the mouse to be used with this view.

Returns: A mouse device

Implements SurgSim::Graphics::ViewElement.

§ setManipulatorParameters()

void SurgSim::Graphics::OsgViewElement::setManipulatorParameters	(	const SurgSim::Math::Vector3d &	position,
		const SurgSim::Math::Vector3d &	lookat
	)

As the camera is not accessible from here and as it cannot be controlled from the outside any more we let the user set the parameters from here.

Parameters

position	The position of the camera.
lookat	The location the camera looks at.

§ setView()

bool OsgViewElement::setView ( std::shared_ptr< View > view )

overridevirtual

Sets the view component that provides the visualization of the graphics representations Only allows OsgView components, any other will not be set and it will return false.

Parameters

view	The view that should be used.

Returns: True if it succeeds, false if it fails.

Reimplemented from SurgSim::Graphics::ViewElement.

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

SurgSim/Graphics/OsgViewElement.h
SurgSim/Graphics/OsgViewElement.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ OsgViewElement()

Member Function Documentation

§ enableKeyboardDevice()

§ enableManipulator()

§ enableMouseDevice()

§ getKeyboardDevice()

§ getMouseDevice()

§ setManipulatorParameters()

§ setView()