Camera class for testing. More...

#include <MockObjects.h>

Inheritance diagram for MockCamera:

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

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

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

virtual void	setPose (const SurgSim::Math::RigidTransform3d &transform)
	Sets the current pose of the camera. More...

virtual SurgSim::Math::RigidTransform3d	getPose () const
	Gets the pose of the camera. More...

virtual void	setViewMatrix (const SurgSim::Math::Matrix44d &matrix)
	Sets the view matrix of the camera. More...

virtual SurgSim::Math::Matrix44d	getViewMatrix () const
	Gets the view matrix of the camera. More...

virtual void	setProjectionMatrix (const SurgSim::Math::Matrix44d &matrix)
	Sets the projection matrix of the camera. More...

virtual const SurgSim::Math::Matrix44d &	getProjectionMatrix () const
	Gets the projection matrix of the camera. More...

virtual SurgSim::Math::Matrix44d	getInverseProjectionMatrix () const
	Gets the inverse projection matrix of the camera. More...

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

virtual bool	setMaterial (std::shared_ptr< SurgSim::Framework::Component > material)
	Sets the material that defines the visual appearance of the representation. More...

virtual std::shared_ptr< SurgSim::Graphics::Material >	getMaterial () const
	Gets the material that defines the visual appearance of the representation. More...

virtual void	clearMaterial ()
	Removes the material from the representation.

virtual void	setDrawAsWireFrame (bool val)
	Sets the representation to render as a wire frame. More...

virtual bool	getDrawAsWireFrame () const
	Return if the representation is rendered as a wire frame. More...

virtual bool	setColorRenderTexture (std::shared_ptr< SurgSim::Graphics::Texture > texture)

virtual std::shared_ptr< SurgSim::Graphics::Texture >	getColorRenderTexture () const

virtual bool	setRenderTarget (std::shared_ptr< SurgSim::Graphics::RenderTarget > renderTarget)
	Sets RenderTarget for the current camera, enables the camera to render to off-screen textures. More...

virtual std::shared_ptr< SurgSim::Graphics::RenderTarget >	getRenderTarget () const
	Gets RenderTarget that is currently being used by the camera. More...

void	setRenderOrder (RenderOrder bin, int value) override
	Determine when this camera will render. More...

void	setMainCamera (bool val) override
	Marks the camera as a main view camera, this means that view dependent passes should follow this camera with their appropriate calculations, for this purpose when isMainCamera() is true, the camera provides a uniform struct with it's transforms. More...

bool	isMainCamera () override

virtual SurgSim::Math::Matrix44d	getInverseViewMatrix () const
	Gets the inverse view matrix of the camera. More...

void	setAmbientColor (const SurgSim::Math::Vector4d &color)
	Sets a value for the ambient lighting term, this can add light to the scene when there is no lighting. More...

SurgSim::Math::Vector4d	getAmbientColor ()

void	setGenerateTangents (bool value)
	Enable or disable the generation of tangents. More...

bool	isGeneratingTangents () const

void	setPerspectiveProjection (double fovy, double aspect, double near, double far)
	Set the projection matrix with the appropriate perspective projection parameters. More...

void	setOrthogonalProjection (double left, double right, double bottom, double top, double near, double far)
	Set the projection matrix with the appropriate orthogonal projection parameters. More...

void	setViewport (int x, int y, int width, int height)
	Sets the viewport size for this camera. More...

std::array< int, 4 >	getViewport () const

void	getViewport (int x, int y, int width, int height) const
	collect the viewport values More...

void	setViewportSize (std::array< double, 2 > dimensions)
	Sets the width and height of the viewport. More...

std::array< double, 2 >	getViewportSize () const
	Gets the dimensions of the viewport.

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

void	addUniform (std::shared_ptr< SurgSim::Graphics::UniformBase > uniform)
	Adds a uniform to this representation. More...

void	setUniforms (const std::vector< std::shared_ptr< SurgSim::Graphics::UniformBase >> &uniforms)
	Sets a set of uniforms for this representation. More...

std::vector< std::shared_ptr< SurgSim::Graphics::UniformBase > >	getUniforms () const

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

void	setRenderGroupReference (const std::string &name)
	Set the group reference that this camera wants to use as the group for rendering. More...

void	setRenderGroupReferences (const std::vector< std::string > &names)
	Set the collections of group references that this camera wants to use for rendering. More...

std::vector< std::string >	getRenderGroupReferences () const
	Gets the collection of names of render groups used for rendering. More...

void	addRenderGroupReference (const std::string &name)
	Adds a single group reference to the collection of group references for rendering. More...

virtual bool	setRenderGroup (std::shared_ptr< Group > group)
	Sets the group of representations that will be seen by this camera. More...

virtual bool	setRenderGroups (const std::vector< std::shared_ptr< Group >> &groups)
	Sets the representation groups that will be seen by this camera. More...

virtual bool	addRenderGroup (std::shared_ptr< Group > group)
	Add a group of representations that will seen by this camera. More...

std::vector< std::shared_ptr< Group > >	getRenderGroups () const
	Gets all groups of representations that will be seen by this camera. More...

bool	addGroupReference (const std::string &name) override
	Add a reference to a group, this will eventual add this representation to the group with the the same name. More...

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

virtual	~Representation ()
	Destructor.

void	setMaterialReference (const std::string &materialName)

std::string	getMaterialReference () const

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.

bool	doWakeUp () override
	Interface to be implemented by derived classes. 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.

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::Camera
enum	RenderOrder { RENDER_ORDER_PRE_RENDER = 0, RENDER_ORDER_IN_ORDER, RENDER_ORDER_POST_RENDER, RENDER_ORDER_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 ()

Static Public Attributes inherited from SurgSim::Graphics::Representation
static const std::string	DefaultGroupName = "__OssDefault__"

static const std::string	DefaultHudGroupName = "__OssDefaultHud__"

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

Camera class for testing.

Constructor & Destructor Documentation

§ MockCamera()

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

inlineexplicit

Constructor.

Parameters

name	Name of the camera

Postcondition: m_numUpdates and m_sumDt are initialized to 0; m_transform is set to identity, m_eye to (0,0,0), m_center to (0, 0, -1), and m_up to (0, 1, 0); m_isVisible is set to true

Member Function Documentation

§ addUniform() [1/2]

void MockCamera::addUniform	(	const std::string &	type,
		const std::string &	name,
		const boost::any &	value
	)

inlinevirtual

Adds and a uniform to this representation and set its value.

Parameters

type	the type of the uniform
name	Name used in shader code to access this uniform
value	The value for this uniform

Implements SurgSim::Graphics::Representation.

§ addUniform() [2/2]

void MockCamera::addUniform ( std::shared_ptr< SurgSim::Graphics::UniformBase > uniform )

inlinevirtual

Adds a uniform to this representation.

Parameters

uniform Uniform to add.

Implements SurgSim::Graphics::Representation.

§ getAmbientColor()

SurgSim::Math::Vector4d MockCamera::getAmbientColor ( )

inlinevirtual

Returns: the ambient light that gets added to the scene

Implements SurgSim::Graphics::Camera.

§ getDrawAsWireFrame()

virtual bool MockCamera::getDrawAsWireFrame ( ) const

inlinevirtual

Return if the representation is rendered as a wire frame.

Returns: True if this representation is rendered as a wireframe; false if not.

Implements SurgSim::Graphics::Representation.

§ getInverseProjectionMatrix()

virtual SurgSim::Math::Matrix44d MockCamera::getInverseProjectionMatrix ( ) const

inlinevirtual

Gets the inverse projection matrix of the camera.

Returns: Inverse Projection matrix

Implements SurgSim::Graphics::Camera.

§ getInverseViewMatrix()

virtual SurgSim::Math::Matrix44d MockCamera::getInverseViewMatrix ( ) const

inlinevirtual

Gets the inverse view matrix of the camera.

Returns: Inverse view matrix

Implements SurgSim::Graphics::Camera.

§ getMaterial()

virtual std::shared_ptr<SurgSim::Graphics::Material> MockCamera::getMaterial ( ) const

inlinevirtual

Gets the material that defines the visual appearance of the representation.

Returns: Graphics material

Implements SurgSim::Graphics::Representation.

§ getPose()

virtual SurgSim::Math::RigidTransform3d MockCamera::getPose ( ) const

inlinevirtual

Gets the pose of the camera.

Returns: Rigid transformation that describes the pose of the representation

Reimplemented from SurgSim::Framework::Representation.

§ getProjectionMatrix()

virtual const SurgSim::Math::Matrix44d& MockCamera::getProjectionMatrix ( ) const

inlinevirtual

Gets the projection matrix of the camera.

Returns: Projection matrix

Implements SurgSim::Graphics::Camera.

§ getRenderTarget()

virtual std::shared_ptr<SurgSim::Graphics::RenderTarget> MockCamera::getRenderTarget ( ) const

inlinevirtual

Gets RenderTarget that is currently being used by the camera.

Returns: The RenderTarget.

Implements SurgSim::Graphics::Camera.

§ getUniforms()

std::vector<std::shared_ptr<SurgSim::Graphics::UniformBase> > MockCamera::getUniforms ( ) const

inlinevirtual

Returns: the uniforms used for this representation

Implements SurgSim::Graphics::Representation.

§ getViewMatrix()

virtual SurgSim::Math::Matrix44d MockCamera::getViewMatrix ( ) const

inlinevirtual

Gets the view matrix of the camera.

Returns: View matrix

Implements SurgSim::Graphics::Camera.

§ getViewport()

void MockCamera::getViewport	(	int *	x,
		int *	y,
		int *	width,
		int *	height
	)		const

inlinevirtual

collect the viewport values

Parameters

x,y,width,height [out] non-nullptr parameters to write the viewport parameters

Implements SurgSim::Graphics::Camera.

§ isGeneratingTangents()

bool MockCamera::isGeneratingTangents ( ) const

inlinevirtual

Returns: whether tangent generation is on or off

Implements SurgSim::Graphics::Representation.

§ isMainCamera()

bool MockCamera::isMainCamera ( )

inlineoverridevirtual

Returns: whether this is used as a main camera

Implements SurgSim::Graphics::Camera.

§ setAmbientColor()

void MockCamera::setAmbientColor ( const SurgSim::Math::Vector4d & color )

inlinevirtual

Sets a value for the ambient lighting term, this can add light to the scene when there is no lighting.

Parameters

color value for the light that should get added to the scene

Implements SurgSim::Graphics::Camera.

§ setDrawAsWireFrame()

virtual void MockCamera::setDrawAsWireFrame ( bool val )

inlinevirtual

Sets the representation to render as a wire frame.

Parameters

val	true if this representation should be rendered as a wireframe.

Implements SurgSim::Graphics::Representation.

§ setGenerateTangents()

void MockCamera::setGenerateTangents ( bool value )

inlinevirtual

Enable or disable the generation of tangents.

Parameters

value true enables tangent generation, false otherwise

Implements SurgSim::Graphics::Representation.

§ setMainCamera()

void MockCamera::setMainCamera ( bool val )

inlineoverridevirtual

Marks the camera as a main view camera, this means that view dependent passes should follow this camera with their appropriate calculations, for this purpose when isMainCamera() is true, the camera provides a uniform struct with it's transforms.

This function will most likely be called by the view.

struct MainCamera {
    mat4 viewMatrix;
    mat4 inverseViewMatrix;
    mat4 projectionMatrix;
    mat4 mainProjectionMatrix;
};
uniform MainCamera mainCamera;

Implements SurgSim::Graphics::Camera.

§ setMaterial()

virtual bool MockCamera::setMaterial ( std::shared_ptr< SurgSim::Framework::Component > material )

inlinevirtual

Sets the material that defines the visual appearance of the representation.

Parameters

material Graphics material

Returns: True if set successfully, otherwise false

Implements SurgSim::Graphics::Representation.

§ setOrthogonalProjection()

void MockCamera::setOrthogonalProjection	(	double	left,
		double	right,
		double	bottom,
		double	top,
		double	near,
		double	far
	)

inlinevirtual

Set the projection matrix with the appropriate orthogonal projection parameters.

Parameters

left,right	left and right bounds of the view volume
bottom,top	bottom and top bounds of the view volume
near,far	near and far bounds of the view volume

Implements SurgSim::Graphics::Camera.

§ setPerspectiveProjection()

void MockCamera::setPerspectiveProjection	(	double	fovy,
		double	aspect,
		double	near,
		double	far
	)

inlinevirtual

Set the projection matrix with the appropriate perspective projection parameters.

Parameters

fovy	Field of view along the y-axis
aspect	Aspect ration between y and x axis in the viewport
near,far	near and far clipping planes

Implements SurgSim::Graphics::Camera.

§ setPose()

virtual void MockCamera::setPose ( const SurgSim::Math::RigidTransform3d & transform )

inlinevirtual

Sets the current pose of the camera.

Parameters

transform Rigid transformation that describes the current pose of the camera

§ setProjectionMatrix()

virtual void MockCamera::setProjectionMatrix ( const SurgSim::Math::Matrix44d & matrix )

inlinevirtual

Sets the projection matrix of the camera.

Parameters

matrix Projection matrix

Implements SurgSim::Graphics::Camera.

§ setRenderOrder()

void MockCamera::setRenderOrder	(	RenderOrder	order,
		int	value
	)

inlineoverridevirtual

Determine when this camera will render.

The main camera will render at (RENDER_ORDER_IN_ORDER,0) In general all preprocessing should be done in RENDER_ORDER_PRE_ORDER, HUD Displaying usually at RENDER_ORDER_POST_ORDER

Parameters

order	The phase of rendering.
value	The index within the phase, the order between two cameras of the same phase and index is not determined.

Implements SurgSim::Graphics::Camera.

§ setRenderTarget()

virtual bool MockCamera::setRenderTarget ( std::shared_ptr< SurgSim::Graphics::RenderTarget > renderTarget )

inlinevirtual

Sets RenderTarget for the current camera, enables the camera to render to off-screen textures.

Parameters

renderTarget The render target.

Implements SurgSim::Graphics::Camera.

§ setUniforms()

void MockCamera::setUniforms ( const std::vector< std::shared_ptr< SurgSim::Graphics::UniformBase >> & uniforms )

inlinevirtual

Sets a set of uniforms for this representation.

Parameters

uniforms the uniforms to be used in this representation

Implements SurgSim::Graphics::Representation.

§ setViewMatrix()

virtual void MockCamera::setViewMatrix ( const SurgSim::Math::Matrix44d & matrix )

inlinevirtual

Sets the view matrix of the camera.

Parameters

matrix View matrix

§ setViewport()

void MockCamera::setViewport	(	int	x,
		int	y,
		int	width,
		int	height
	)

inlinevirtual

Sets the viewport size for this camera.

Parameters

x,y	location of the viewport in screen space
width,height	size of the viewport in screen space

Implements SurgSim::Graphics::Camera.

§ setViewportSize()

void MockCamera::setViewportSize ( std::array< double, 2 > dimensions )

inlinevirtual

Sets the width and height of the viewport.

Parameters

dimensions size of the viewport in screen space

Implements SurgSim::Graphics::Camera.

§ update()

virtual void MockCamera::update ( double dt )

inlinevirtual

Updates the camera.

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

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

§ MockCamera()

Member Function Documentation

§ addUniform() [1/2]

§ addUniform() [2/2]

§ getAmbientColor()

§ getDrawAsWireFrame()

§ getInverseProjectionMatrix()

§ getInverseViewMatrix()

§ getMaterial()

§ getPose()

§ getProjectionMatrix()

§ getRenderTarget()

§ getUniforms()

§ getViewMatrix()

§ getViewport()

§ isGeneratingTangents()

§ isMainCamera()

§ setAmbientColor()

§ setDrawAsWireFrame()

§ setGenerateTangents()

§ setMainCamera()

§ setMaterial()

§ setOrthogonalProjection()

§ setPerspectiveProjection()

§ setPose()

§ setProjectionMatrix()

§ setRenderOrder()

§ setRenderTarget()

§ setUniforms()

§ setViewMatrix()

§ setViewport()

§ setViewportSize()

§ update()