View class for testing. More...

#include <MockObjects.h>

Inheritance diagram for MockView:

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

void	setPosition (const std::array< int, 2 > &position) override
	Set the position of this view. More...

std::array< int, 2 >	getPosition () const override
	Get the position of this view. More...

void	setDimensions (const std::array< int, 2 > &dimensions) override
	Set the dimensions of this view. More...

std::array< int, 2 >	getDimensions () const override
	Set the dimensions of this view. More...

void	setDimensionsDouble (const std::array< double, 2 > &dimensions)
	Set the dimensions of this view in doubles. More...

std::array< double, 2 >	getDimensionsDouble () const
	Get the dimensions of this view in doubles. More...

void	setWindowBorderEnabled (bool enabled) override
	Sets whether the view window has a border. More...

bool	isWindowBorderEnabled () const override
	Returns whether the view window has a border. More...

int	getNumUpdates () const
	Returns the number of times the view has been updated.

double	getSumDt () const
	Returns the sum of the dt that the view has been updated with.

virtual void	update (double dt)
	Updates the view. More...

bool	isInitialized () const
	Gets whether the view has been initialized.

bool	isAwoken () const
	Gets whether the view has been awoken.

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

virtual void	setCamera (std::shared_ptr< SurgSim::Framework::Component > camera)
	Sets the camera which provides the viewpoint in the scene. More...

std::shared_ptr< Camera >	getCamera () const
	Gets the camera which provides the viewpoint in the scene. More...

virtual bool	isStereo () const

virtual void	setStereoMode (int val)
	Set the mode that this view should use for stereo display, see StereMode for all the modes. More...

int	getStereoMode () const

void	setDisplayType (int type)
	Set the kind of display. More...

int	getDisplayType () const

void	setFullScreen (bool val)
	Request the display to use the whole screen. More...

bool	isFullScreen () const

void	setTargetScreen (int val)
	Request a certain screen to be used for this view. More...

int	getTargetScreen () const

void	setEyeSeparation (double val)
	Set the distance between the users eyes, this is necessary to calculate the correct projection matrices for stereo rendering. More...

double	getEyeSeparation () const

void	setScreenDistance (double val)
	Set the distance of the user from the screen, this is necessary to calculate the correct projection matrices for stereo rendering. More...

double	getScreenDistance () const

void	setScreenWidth (double val)
	Set the width of the screen, this is necessary to calculate the correct projection matrices for stereo rendering. More...

double	getScreenWidth () const

void	setScreenHeight (double val)
	Set the height of the screen, this is necessary to calculate the correct projection matrices for stereo rendering. More...

double	getScreenHeight () const

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

virtual	~Component ()
	Destructor.

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.

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.

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.

	~Accessible ()
	Destructor.

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

std::vector< std::string >	getProperties ()

template<>
boost::any	getValue (const std::string &name) const

Additional Inherited Members
Public Types inherited from SurgSim::Graphics::View
enum	StereoMode { STEREO_MODE_NONE = -1, STEREO_MODE_QUAD_BUFFER, STEREO_MODE_ANAGLYPHIC, STEREO_MODE_HORIZONTAL_SPLIT, STEREO_MODE_VERTICAL_SPLIT, STEREO_MODE_LEFT_EYE, STEREO_MODE_RIGHT_EYE, STEREO_MODE_HORIZONTAL_INTERLACE, STEREO_MODE_VERTICAL_INTERLACE, STEREO_MODE_CHECKERBOARD, STEREO_MODE_COUNT }

enum	DisplayType { DISPLAY_TYPE_MONITOR, DISPLAY_TYPE_HMD, DISPLAY_TYPE_COUNT }

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 ()

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

View class for testing.

Constructor & Destructor Documentation

§ MockView()

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

inlineexplicit

Constructor.

Parameters

name	Name of the view

Postcondition: m_x and m_y are initialized to 0; m_width is initialized to 800, m_height to 600; m_isWindowBorderEnabled is initialized to true; m_numUpdates and m_sumDt are initialized to 0; m_transform is set to identity

Member Function Documentation

§ getDimensions()

std::array<int, 2> MockView::getDimensions ( ) const

inlineoverridevirtual

Set the dimensions of this view.

Parameters

[out] width,height Dimensions on the screen (in pixels)

Implements SurgSim::Graphics::View.

§ getDimensionsDouble()

std::array<double, 2> MockView::getDimensionsDouble ( ) const

inlinevirtual

Get the dimensions of this view in doubles.

Returns: Dimensions on the screen (in pixels)

Implements SurgSim::Graphics::View.

§ getPosition()

std::array<int, 2> MockView::getPosition ( ) const

inlineoverridevirtual

Get the position of this view.

Parameters

[out] x,y Position on the screen (in pixels)

Implements SurgSim::Graphics::View.

§ isWindowBorderEnabled()

bool MockView::isWindowBorderEnabled ( ) const

inlineoverridevirtual

Returns whether the view window has a border.

Returns: True to enable the border around the window; false for no border

Implements SurgSim::Graphics::View.

§ setDimensions()

void MockView::setDimensions ( const std::array< int, 2 > & dimensions )

inlineoverridevirtual

Set the dimensions of this view.

Parameters

width,height Dimensions on the screen (in pixels)

Implements SurgSim::Graphics::View.

§ setDimensionsDouble()

void MockView::setDimensionsDouble ( const std::array< double, 2 > & dimensions )

inlinevirtual

Set the dimensions of this view in doubles.

Parameters

dimensions Dimensions on the screen (in pixels)

Implements SurgSim::Graphics::View.

§ setPosition()

void MockView::setPosition ( const std::array< int, 2 > & position )

inlineoverridevirtual

Set the position of this view.

Parameters

x,y	Position on the screen (in pixels)

Implements SurgSim::Graphics::View.

§ setWindowBorderEnabled()

void MockView::setWindowBorderEnabled ( bool enabled )

inlineoverridevirtual

Sets whether the view window has a border.

Parameters

enabled True to enable the border around the window; false for no border

Implements SurgSim::Graphics::View.

§ update()

virtual void MockView::update ( double dt )

inlinevirtual

Updates the view.

Parameters

dt	The time in seconds of the preceding timestep.

Postcondition: m_numUpdates is incremented and dt is added to m_sumDt

Implements SurgSim::Graphics::View.

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

SurgSim/Graphics/UnitTests/MockObjects.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ MockView()

Member Function Documentation

§ getDimensions()

§ getDimensionsDouble()

§ getPosition()

§ isWindowBorderEnabled()

§ setDimensions()

§ setDimensionsDouble()

§ setPosition()

§ setWindowBorderEnabled()

§ update()