CameraGroup Class Reference

A group of cameras. More...

#include <SceneCamera.hpp>

Public Types
typedef rw::core::Ptr< CameraGroup >	Ptr
	Smart pointer type for CameraGroup.

Public Member Functions
virtual	~CameraGroup ()
	Destructor.
virtual std::string	getName ()=0
	Get name of group. More...
virtual bool	isEnabled ()=0
	Check if group is enabled. More...
virtual void	setEnabled (bool enabled)=0
	Enable/disable group. More...
virtual void	insertCamera (SceneCamera::Ptr cam, int index)=0
	Insert a camera in group. More...
virtual void	removeCamera (int index)=0
	Remove camera. More...
virtual std::list< SceneCamera::Ptr >	getCameras ()=0
	Get all cameras in group. More...
virtual void	setMainCamera (SceneCamera::Ptr cam)=0
	Set the main camera. More...
virtual SceneCamera::Ptr	getMainCamera ()=0
	Get the main camera. More...
virtual bool	setOffscreenRenderEnabled (bool enable)=0
	Enable/disable offscreen rendering. More...
virtual bool	isOffscreenRenderEnabled ()=0
	Check if offscreen rendering is enabled. More...
virtual void	setOffscreenRenderSize (int width, int height)=0
	Set size for offscreen rendering. More...
virtual void	setOffscreenRenderColor (rw::sensor::Image::ColorCode color)=0
	Set color space for offscreen rendering. More...
virtual void	setCopyToImage (rw::sensor::Image::Ptr img)=0
	Copy to image. More...
virtual void	setCopyToScan25D (rw::core::Ptr< rw::geometry::PointCloud > img)=0
	Copy to point cloud. More...
virtual void	setMultiSample (int samples)=0
	Enable multi-sampling. More...

Detailed Description

A group of cameras.

Member Function Documentation

getCameras()

virtual std::list<SceneCamera::Ptr> getCameras ( )

pure virtual

Get all cameras in group.

Returns

list of cameras.

getMainCamera()

virtual SceneCamera::Ptr getMainCamera ( )

pure virtual

Get the main camera.

Returns

the main camera.

getName()

virtual std::string getName ( )

pure virtual

Get name of group.

Returns

the name.

insertCamera()

virtual void insertCamera ( SceneCamera::Ptr  cam, int  index  )

pure virtual

Insert a camera in group.

Parameters

cam	[in] camera.
index	[in] the index to insert at.

isEnabled()

virtual bool isEnabled ( )

pure virtual

Check if group is enabled.

Returns

true if enabled.

isOffscreenRenderEnabled()

virtual bool isOffscreenRenderEnabled ( )

pure virtual

Check if offscreen rendering is enabled.

Returns

true if enabled, false otherwise.

removeCamera()

virtual void removeCamera ( int  index )

pure virtual

Remove camera.

Parameters

index

[in] the index of the camera to remove.

setCopyToImage()

virtual void setCopyToImage ( rw::sensor::Image::Ptr  img )

pure virtual

Copy to image.

Parameters

img	[out] image to copy to.

setCopyToScan25D()

virtual void setCopyToScan25D ( rw::core::Ptr< rw::geometry::PointCloud >  img )

pure virtual

Copy to point cloud.

Parameters

img	[out] point cloud to copy to.

setEnabled()

virtual void setEnabled ( bool  enabled )

pure virtual

Enable/disable group.

Parameters

enabled

[in] true to enable, false to disable.

setMainCamera()

virtual void setMainCamera ( SceneCamera::Ptr  cam )

pure virtual

Set the main camera.

Parameters

cam	[in] main camera.

setMultiSample()

virtual void setMultiSample ( int  samples )

pure virtual

Enable multi-sampling.

Parameters

samples

[in] number of samples.

setOffscreenRenderColor()

virtual void setOffscreenRenderColor ( rw::sensor::Image::ColorCode  color )

pure virtual

Set color space for offscreen rendering.

Parameters

color

[in] the color space to use.

setOffscreenRenderEnabled()

virtual bool setOffscreenRenderEnabled ( bool  enable )

pure virtual

Enable/disable offscreen rendering.

Parameters

enable

[in] true to enable, false to disable.

Returns

true if offscreen rendering was enabled, false if offscreen rendering is not possible.

setOffscreenRenderSize()

virtual void setOffscreenRenderSize ( int  width, int  height  )

pure virtual

Set size for offscreen rendering.

Parameters

width	[in]
height	[in]

---

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

• SceneCamera.hpp