#include <OgreCamera.hh>

Public Member Functions
virtual	~OgreCamera ()

virtual unsigned int	AntiAliasing () const
	Get the level of anti-aliasing used during rendering. More...

virtual double	AspectRatio () const
	Get the camera's aspect ratio. More...

virtual math::Color	BackgroundColor () const

virtual RenderWindowPtr	CreateRenderWindow ()
	Create a render window. More...

virtual math::Matrix4d	ProjectionMatrix () const
	Get the projection matrix for this camera. More...

virtual void	Render ()
	Renders the current scene using this camera. This function assumes PreRender() has already been called on the parent Scene, allowing the camera and the scene itself to prepare for rendering. More...

virtual void	SetAntiAliasing (const unsigned int _aa)
	Set the level of anti-aliasing used during rendering. If a value of 0 is given, no anti-aliasing will be performed. Higher values can significantly slow-down rendering times, depending on the underlying render engine. More...

virtual void	SetAspectRatio (const double _ratio)
	Set the camera's aspect ratio. This value determines the cameras vertical field-of-view. It is often the. More...

virtual void	SetBackgroundColor (const math::Color &_color)

virtual void	SetFarClipPlane (const double _far)
	Set the camera's far clipping plane distance. More...

virtual void	SetHFOV (const math::Angle &_angle)
	Set the camera's horizontal field-of-view. More...

virtual void	SetNearClipPlane (const double _near)
	Set the camera's near clipping plane distance. More...

virtual math::Matrix4d	ViewMatrix () const
	Get the view matrix for this camera. More...

Public Member Functions inherited from BaseCamera< OgreSensor >
virtual	~BaseCamera ()

virtual void	Capture (Image &_image)
	Renders a new frame and writes the results to the given image. This is a convenience function for single-camera scenes. It wraps the pre-render, render, post-render, and get-image calls into a single function. This should be used in applications with multiple cameras or multiple consumers of a single camera's images. More...

virtual common::ConnectionPtr	ConnectNewImageFrame (Camera::NewFrameListener _listener)
	Subscribes a new listener to this camera's new frame event. More...

virtual void	Copy (Image &_image) const
	Writes the last rendered image to the given image buffer. This function can be called multiple times after PostRender has been called, without rendering the scene again. Calling this function before a single image has been rendered will have undefined behavior. More...

virtual Image	CreateImage () const
	Created an empty image buffer for capturing images. The resulting image will have sufficient memory allocated for subsequent calls to this camera's Capture function. However, any changes to this cameras properties may invalidate the condition. More...

virtual double	FarClipPlane () const
	Get the camera's far clipping plane distance. More...

virtual math::Vector3d	FollowOffset () const
	Get the follow offset vector in the frame specified at the time the follow target is set. More...

virtual double	FollowPGain () const
	Get the camera follow movement P gain. More...

virtual NodePtr	FollowTarget () const
	Get the target node being followed. More...

virtual math::Angle	HFOV () const
	Get the camera's horizontal field-of-view. More...

virtual PixelFormat	ImageFormat () const
	Get the image pixel format. If the image pixel format has not been set with a valid value, PF_UNKNOWN will be returned. More...

virtual unsigned int	ImageHeight () const
	Get the image height in pixels. More...

virtual unsigned int	ImageMemorySize () const
	Get the total image memory size in bytes. More...

virtual unsigned int	ImageWidth () const
	Get the image width in pixels. More...

virtual double	NearClipPlane () const
	Get the camera's near clipping plane distance. More...

virtual void	PostRender ()
	Preforms any necessary final rendering work. Once rendering is complete the camera will alert any listeners of the new frame event. This function should only be called after a call to Render has successfully been executed. More...

virtual void	PreRender ()
	Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...

virtual bool	SaveFrame (const std::string &_name)
	Writes the previously rendered frame to a file. This function can be called multiple times after PostRender has been called, without rendering the scene again. Calling this function before a single image has been rendered will have undefined behavior. More...

virtual void	SetFollowOffset (const math::Vector3d &_offset)
	Set offset of camera from target node being followed. The offset will be in the frame that is specified at the time the follow target is set. More...

virtual void	SetFollowPGain (const double _pGain)
	Set follow P Gain. Determines how fast the camera moves to follow the target node. Valid range: [0-1]. More...

virtual void	SetFollowTarget (const NodePtr &_target, const math::Vector3d &_Offset, const bool _worldFrame)
	Set a node for camera to follow. The camera will automatically update its position to keep itself at the specified offset distance from the target being followed. If null is specified, camera follow is disabled. In contrast to SetTrackTarget, the camera does not change its orientation when following is enabled. More...

virtual void	SetImageFormat (PixelFormat _format)
	Set the image pixel format. More...

virtual void	SetImageHeight (const unsigned int _height)
	Set the image height in pixels. More...

virtual void	SetImageWidth (const unsigned int _width)
	Set the image width in pixels. More...

virtual void	SetTrackOffset (const math::Vector3d &_offset)
	Set track offset. Camera will track a point that's at an offset from the target node. The offset will be in the frame that is specified at the time the track target is set. More...

virtual void	SetTrackPGain (const double _pGain)
	Set track P Gain. Determines how fast the camera rotates to look at the target node. Valid range: [0-1]. More...

virtual void	SetTrackTarget (const NodePtr &_target, const math::Vector3d &_offset, const bool _worldFrame)
	Set a node for camera to track. The camera will automatically change its orientation to face the target being tracked. If null is specified, tracking is disabled. In contrast to SetFollowTarget the camera does not change its position when tracking is enabled. More...

virtual math::Vector3d	TrackOffset () const
	Get the track offset vector in the frame specified at the time the track target is set. More...

virtual double	TrackPGain () const
	Get the camera track rotation P gain. More...

virtual NodePtr	TrackTarget () const
	Get the target node being tracked. More...

virtual void	Update ()
	Renders a new frame. This is a convenience function for single-camera scenes. It wraps the pre-render, render, and post-render into a single function. This should be used in applications with multiple cameras or multiple consumers of a single camera's images. More...

Public Member Functions inherited from Camera
virtual	~Camera ()
	Deconstructor. More...

Public Member Functions inherited from Sensor
virtual	~Sensor ()
	Sensor. More...

Public Member Functions inherited from Node
virtual	~Node ()
	Deconstructor. More...

Public Member Functions inherited from Object
virtual	~Object ()
	Deconstructor. More...

Public Member Functions inherited from OgreSensor
virtual	~OgreSensor ()

Public Member Functions inherited from BaseSensor< OgreNode >
virtual	~BaseSensor ()

Public Member Functions inherited from OgreNode
virtual	~OgreNode ()

virtual void	Destroy ()
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...

virtual bool	HasParent () const
	Determine if this Geometry is attached to a Visual. More...

virtual Ogre::SceneNode *	Node () const

virtual VisualPtr	Parent () const
	Get the parent Visual. More...

Public Member Functions inherited from BaseNode< OgreObject >
virtual	~BaseNode ()

virtual math::Pose3d	LocalPose () const
	Get the local pose. More...

virtual math::Vector3d	LocalPosition () const
	Get the local position. More...

virtual math::Quaterniond	LocalRotation () const
	Get the local rotation. More...

virtual math::Vector3d	Origin () const
	Get position of origin. More...

virtual void	RemoveParent ()
	Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More...

virtual void	SetLocalPose (const math::Pose3d &_pose)
	Set the local pose. More...

virtual void	SetLocalPosition (double _x, double _y, double _z)
	Set the local position. More...

virtual void	SetLocalPosition (const math::Vector3d &_position)
	Set the local position. More...

virtual void	SetLocalRotation (double _r, double _p, double _y)
	Set the local rotation. More...

virtual void	SetLocalRotation (double _w, double _x, double _y, double _z)
	Set the local rotation. More...

virtual void	SetLocalRotation (const math::Quaterniond &_rotation)
	Set the local rotation. More...

virtual void	SetOrigin (double _x, double _y, double _z)
	Set position of origin. The position should be relative to the original origin of the geometry. More...

virtual void	SetOrigin (const math::Vector3d &_origin)
	Set position of origin. The position should be relative to the original origin of the geometry. More...

virtual void	SetWorldPose (const math::Pose3d &_pose)
	Set the world pose. More...

virtual void	SetWorldPosition (double _x, double _y, double _z)
	Set the world position. More...

virtual void	SetWorldPosition (const math::Vector3d &_position)
	Set the world position. More...

virtual void	SetWorldRotation (double _r, double _p, double _y)
	Set the world rotation. More...

virtual void	SetWorldRotation (double _w, double _x, double _y, double _z)
	Set the world rotation. More...

virtual void	SetWorldRotation (const math::Quaterniond &_rotation)
	Set the world rotation. More...

virtual math::Pose3d	WorldPose () const
	Get the world pose. More...

virtual math::Vector3d	WorldPosition () const
	Get the world position. More...

virtual math::Quaterniond	WorldRotation () const
	Get the world rotation. More...

virtual math::Pose3d	WorldToLocal (const math::Pose3d &_pose) const
	Convert given world pose to local pose. More...

Public Member Functions inherited from OgreObject
virtual	~OgreObject ()

virtual ScenePtr	Scene () const
	Get the Scene that created this object. More...

Public Member Functions inherited from BaseObject
virtual	~BaseObject ()

virtual unsigned int	Id () const
	Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...

virtual std::string	Name () const
	Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...

Public Member Functions inherited from enable_shared_from_this< BaseObject >
T	enable_shared_from_this (T... args)

T	~enable_shared_from_this (T... args)

T	operator= (T... args)

T	shared_from_this (T... args)

Protected Member Functions
	OgreCamera ()

virtual void	CreateRenderTexture ()

virtual void	Init ()

virtual RenderTargetPtr	RenderTarget () const

Protected Member Functions inherited from BaseCamera< OgreSensor >
	BaseCamera ()

virtual void *	CreateImageBuffer () const

virtual void	Load ()

virtual void	Reset ()

Protected Member Functions inherited from OgreSensor
	OgreSensor ()

Protected Member Functions inherited from BaseSensor< OgreNode >
	BaseSensor ()

Protected Member Functions inherited from OgreNode
	OgreNode ()

virtual math::Pose3d	RawLocalPose () const

virtual math::Vector3d	RawLocalPosition () const

virtual math::Quaterniond	RawLocalRotation () const

virtual void	SetParent (OgreVisualPtr _parent)

virtual void	SetRawLocalPose (const math::Pose3d &_Pose3d)

virtual void	SetRawLocalPosition (const math::Vector3d &_position)

virtual void	SetRawLocalRotation (const math::Quaterniond &_rotation)

Protected Member Functions inherited from BaseNode< OgreObject >
	BaseNode ()

Protected Member Functions inherited from OgreObject
	OgreObject ()

Protected Member Functions inherited from BaseObject
	BaseObject ()

Protected Attributes
math::Color	backgroundColor

Ogre::Camera *	ogreCamera = nullptr

OgreRenderTargetPtr	renderTexture

Protected Attributes inherited from BaseCamera< OgreSensor >
unsigned int	antiAliasing
	Anti-aliasing. More...

double	aspect
	Aspect ratio. More...

double	farClip
	Far clipping plane distance. More...

NodePtr	followNode
	Target node to follow. More...

math::Vector3d	followOffset
	Offset distance between camera and target node being followed. More...

double	followPGain
	P gain for follow mode. Determines how fast the camera moves to follow the target node. Valid range: [0-1]. More...

bool	followWorldFrame
	Follow target in world frame. More...

math::Angle	hfov
	Horizontal camera field of view. More...

ImagePtr	imageBuffer

double	nearClip
	Near clipping plane distance. More...

common::EventT< void(const void *, unsigned int, unsigned int, unsigned int, const std::string &)>	newFrameEvent

NodePtr	trackNode
	Target node to track if camera tracking is on. More...

math::Vector3d	trackOffset
	Set camera to track a point offset in target node's local or world frame depending on trackWorldFrame. More...

double	trackPGain
	P gain for tracking. Determines how fast the camera rotates to look at the target node. Valid range: [0-1]. More...

bool	trackWorldFrame
	Track point relative to target in world frame. More...

Protected Attributes inherited from OgreNode
Ogre::SceneNode *	ogreNode

OgreVisualPtr	parent

Protected Attributes inherited from BaseNode< OgreObject >
math::Vector3d	origin

Protected Attributes inherited from OgreObject
OgreScenePtr	scene

Protected Attributes inherited from BaseObject
unsigned int	id

std::string	name

Additional Inherited Members
Public Types inherited from Camera
typedef std::function< void(const void *, unsigned int, unsigned int, unsigned int, const std::string &)>	NewFrameListener
	Callback function for new frame render event listeners. More...

Constructor & Destructor Documentation

◆ OgreCamera()

OgreCamera ( )

protected

◆ ~OgreCamera()

virtual ~OgreCamera ( )

virtual

Member Function Documentation

◆ AntiAliasing()

virtual unsigned int AntiAliasing ( ) const

virtual

Get the level of anti-aliasing used during rendering.

Returns: The level of anti-aliasing used during rendering

Reimplemented from BaseCamera< OgreSensor >.

◆ AspectRatio()

virtual double AspectRatio ( ) const

virtual

Get the camera's aspect ratio.

Returns: The camera's aspect ratio

Reimplemented from BaseCamera< OgreSensor >.

◆ BackgroundColor()

virtual math::Color BackgroundColor ( ) const

virtual

◆ CreateRenderTexture()

virtual void CreateRenderTexture ( )

protectedvirtual

◆ CreateRenderWindow()

virtual RenderWindowPtr CreateRenderWindow ( )

virtual

Create a render window.

Returns: A pointer to the render window.

Reimplemented from BaseCamera< OgreSensor >.

◆ Init()

virtual void Init ( )

protectedvirtual

Reimplemented from OgreNode.

◆ ProjectionMatrix()

virtual math::Matrix4d ProjectionMatrix ( ) const

virtual

Get the projection matrix for this camera.

Returns: Camera projection matrix

Reimplemented from BaseCamera< OgreSensor >.

◆ Render()

virtual void Render ( )

virtual

Renders the current scene using this camera. This function assumes PreRender() has already been called on the parent Scene, allowing the camera and the scene itself to prepare for rendering.

Implements Camera.

◆ RenderTarget()

virtual RenderTargetPtr RenderTarget ( ) const

protectedvirtual

Implements BaseCamera< OgreSensor >.

◆ SetAntiAliasing()

virtual void SetAntiAliasing ( const unsigned int _aa )

virtual

Set the level of anti-aliasing used during rendering. If a value of 0 is given, no anti-aliasing will be performed. Higher values can significantly slow-down rendering times, depending on the underlying render engine.

Parameters

[in] _aa Level of anti-aliasing used during rendering

Reimplemented from BaseCamera< OgreSensor >.

◆ SetAspectRatio()

virtual void SetAspectRatio ( const double _ratio )

virtual

Set the camera's aspect ratio. This value determines the cameras vertical field-of-view. It is often the.

image_height /

image_width

but this is not necessarily true.

Returns: The camera's aspect ratio

Reimplemented from BaseCamera< OgreSensor >.

◆ SetBackgroundColor()

virtual void SetBackgroundColor ( const math::Color & _color )

virtual

◆ SetFarClipPlane()

virtual void SetFarClipPlane ( const double _far )

virtual

Set the camera's far clipping plane distance.

Parameters

[in] _far Far clipping plane distance

Reimplemented from BaseCamera< OgreSensor >.

◆ SetHFOV()

virtual void SetHFOV ( const math::Angle & _hfov )

virtual

Set the camera's horizontal field-of-view.

Parameters

[in] _angle Desired horizontal field-of-view

Reimplemented from BaseCamera< OgreSensor >.

◆ SetNearClipPlane()

virtual void SetNearClipPlane ( const double _near )

virtual

Set the camera's near clipping plane distance.

Parameters

[in] _near Near clipping plane distance

Reimplemented from BaseCamera< OgreSensor >.

◆ ViewMatrix()

virtual math::Matrix4d ViewMatrix ( ) const

virtual

Get the view matrix for this camera.

Returns: Camera view matrix

Reimplemented from BaseCamera< OgreSensor >.

Member Data Documentation

◆ backgroundColor

math::Color backgroundColor

protected

◆ ogreCamera

Ogre::Camera* ogreCamera = nullptr

protected

◆ renderTexture

OgreRenderTargetPtr renderTexture

protected

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

OgreCamera.hh

Ignition Rendering

API Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ OgreCamera()

◆ ~OgreCamera()

Member Function Documentation

◆ AntiAliasing()

◆ AspectRatio()

◆ BackgroundColor()

◆ CreateRenderTexture()

◆ CreateRenderWindow()

◆ Init()

◆ ProjectionMatrix()

◆ Render()

◆ RenderTarget()

◆ SetAntiAliasing()

◆ SetAspectRatio()

◆ SetBackgroundColor()

◆ SetFarClipPlane()

◆ SetHFOV()

◆ SetNearClipPlane()

◆ ViewMatrix()

Member Data Documentation

◆ backgroundColor

◆ ogreCamera

◆ renderTexture