Ignition Rendering

API Reference

6.3.1
BaseThermalCamera< T > Class Template Reference

Base implementation of the ThermalCamera class. More...

#include <BaseThermalCamera.hh>

Public Member Functions

virtual ~BaseThermalCamera ()
 Destructor. More...
 
virtual float AmbientTemperature () const override
 Get the ambient temperature of the environment. More...
 
virtual float AmbientTemperatureRange () const override
 Get the range of ambient temperature. More...
 
virtual ignition::common::ConnectionPtr ConnectNewThermalFrame (std::function< void(const uint16_t *, unsigned int, unsigned int, unsigned int, const std::string &)> _subscriber) override
 Connect to the new thermal image event. More...
 
virtual float HeatSourceTemperatureRange () const override
 Get the range of temperature variation for all heat sources. More...
 
virtual float LinearResolution () const override
 Get the temperature linear resolution. More...
 
virtual float MaxTemperature () const override
 Get the maximum temperature the sensor can detect. More...
 
virtual float MinTemperature () const override
 Get the minimum temperature the sensor can detect. More...
 
virtual void SetAmbientTemperature (float _ambient) override
 Set the ambient temperature of the environment. More...
 
virtual void SetAmbientTemperatureRange (float _range) override
 Set the range of ambient temperature. More...
 
virtual void SetHeatSourceTemperatureRange (float _range) override
 Set the range of temperature variation for all heat sources. If set, the temperature reading of heat sources will vary within a temperature of +/- range/2 instead of returning a fixed uniform temperature for the entire heat source. More...
 
virtual void SetLinearResolution (float _max) override
 Set the temperature linear resolution. The thermal image data returned will be temperature in kelvin / resolution. Typical values are 0.01 (10mK), 0.1 (100mK), or 0.04 to simulate 14 bit format. More...
 
virtual void SetMaxTemperature (float _max) override
 Set the maximum temperature the sensor can detect. More...
 
virtual void SetMinTemperature (float _min) override
 Set the minimum temperature the sensor can detect. More...
 
- Public Member Functions inherited from ThermalCamera
virtual ~ThermalCamera ()
 Destructor. More...
 
- Public Member Functions inherited from Camera
virtual ~Camera ()
 Destructor. More...
 
virtual void Render ()=0
 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...
 
- Public Member Functions inherited from Sensor
virtual ~Sensor ()
 Sensor. More...
 
virtual void SetVisibilityMask (uint32_t _mask)=0
 Set visibility mask. More...
 
virtual uint32_t VisibilityMask () const =0
 Get visibility mask. More...
 
- Public Member Functions inherited from Node
virtual ~Node ()
 Destructor. More...
 
virtual void AddChild (NodePtr _child)=0
 Add the given node to this node. If the given node is already a child, no work will be done. More...
 
virtual NodePtr ChildById (unsigned int _id) const =0
 Get node with given ID. If no child exists with given ID, NULL will be returned. More...
 
virtual NodePtr ChildByIndex (unsigned int _index) const =0
 Get node at given index. If no child exists at given index, NULL will be returned. More...
 
virtual NodePtr ChildByName (const std::string &_name) const =0
 Get node with given name. If no child exists with given name, NULL will be returned. More...
 
virtual unsigned int ChildCount () const =0
 Get number of child nodes. More...
 
virtual bool HasChild (ConstNodePtr _child) const =0
 Determine if given node is an attached child. More...
 
virtual bool HasChildId (unsigned int _id) const =0
 Determine if node with given ID is an attached child. More...
 
virtual bool HasChildName (const std::string &_name) const =0
 Determine if node with given name is an attached child. More...
 
virtual bool HasParent () const =0
 Determine if this Node is attached to another Node. More...
 
virtual bool HasUserData (const std::string &_key) const =0
 Check if node has custom data. More...
 
virtual bool InheritScale () const =0
 Determine if this node inherits scale from this parent. More...
 
virtual math::Pose3d InitialLocalPose () const =0
 Get the initial local pose. More...
 
virtual math::Pose3d LocalPose () const =0
 Get the local pose. More...
 
virtual math::Vector3d LocalPosition () const =0
 Get the local position. More...
 
virtual math::Quaterniond LocalRotation () const =0
 Get the local rotation. More...
 
virtual math::Vector3d LocalScale () const =0
 Get the local scale. More...
 
virtual math::Vector3d Origin () const =0
 Get position of origin. More...
 
virtual NodePtr Parent () const =0
 Get the parent Node. More...
 
virtual NodePtr RemoveChild (NodePtr _child)=0
 Remove (detach) the given node from this node. If the given node is not a child of this node, no work will be done. More...
 
virtual NodePtr RemoveChildById (unsigned int _id)=0
 Remove (detach) the node with the given ID from this node. If the specified node is not a child of this node, no work will be done. More...
 
virtual NodePtr RemoveChildByIndex (unsigned int _index)=0
 Remove (detach) the node at the given index from this node. If the specified node is not a child of this node, no work will be done. More...
 
virtual NodePtr RemoveChildByName (const std::string &_name)=0
 Remove (detach) the node with the given name from this node. If the specified node is not a child of this node, no work will be done. More...
 
virtual void RemoveChildren ()=0
 Remove all child nodes from this node This detaches all the child nodes but does not destroy them. More...
 
virtual void RemoveParent ()=0
 Detach this Node from its parent. If this Node does not have a parent, no work will be done. More...
 
virtual void Scale (double _scale)=0
 Scale the current scale by the given scalar. The given scalar will be assigned to the x, y, and z coordinates. More...
 
virtual void Scale (double _x, double _y, double _z)=0
 Scale the current scale by the given scalars. More...
 
virtual void Scale (const math::Vector3d &_scale)=0
 Scale the current scale by the given scalars. More...
 
virtual void SetInheritScale (bool _inherit)=0
 Specify if this node inherits scale from its parent. More...
 
virtual void SetLocalPose (const math::Pose3d &_pose)=0
 Set the local pose. More...
 
virtual void SetLocalPosition (double _x, double _y, double _z)=0
 Set the local position. More...
 
virtual void SetLocalPosition (const math::Vector3d &_position)=0
 Set the local position. More...
 
virtual void SetLocalRotation (double _r, double _p, double _y)=0
 Set the local rotation. More...
 
virtual void SetLocalRotation (double _w, double _x, double _y, double _z)=0
 Set the local rotation. More...
 
virtual void SetLocalRotation (const math::Quaterniond &_rotation)=0
 Set the local rotation. More...
 
virtual void SetLocalScale (double _scale)=0
 Set the local scale. The given scale will be assigned to the x, y, and z coordinates. More...
 
virtual void SetLocalScale (double _x, double _y, double _z)=0
 Set the local scale. More...
 
virtual void SetLocalScale (const math::Vector3d &_scale)=0
 Set the local scale. More...
 
virtual void SetOrigin (double _x, double _y, double _z)=0
 Set position of origin. The position should be relative to the original origin of the geometry. More...
 
virtual void SetOrigin (const math::Vector3d &_origin)=0
 Set position of origin. The position should be relative to the original origin of the geometry. More...
 
virtual void SetUserData (const std::string &_key, Variant _value)=0
 Store any custom data associated with this node. More...
 
virtual void SetWorldPose (const math::Pose3d &_pose)=0
 Set the world pose. More...
 
virtual void SetWorldPosition (double _x, double _y, double _z)=0
 Set the world position. More...
 
virtual void SetWorldPosition (const math::Vector3d &_position)=0
 Set the world position. More...
 
virtual void SetWorldRotation (double _r, double _p, double _y)=0
 Set the world rotation. More...
 
virtual void SetWorldRotation (double _w, double _x, double _y, double _z)=0
 Set the world rotation. More...
 
virtual void SetWorldRotation (const math::Quaterniond &_rotation)=0
 Set the world rotation. More...
 
virtual void SetWorldScale (double _scale)=0
 Set the world scale. The given scale will be assigned to the x, y, and z coordinates. More...
 
virtual void SetWorldScale (double _x, double _y, double _z)=0
 Set the world scale. More...
 
virtual void SetWorldScale (const math::Vector3d &_scale)=0
 Set the world scale. More...
 
virtual Variant UserData (const std::string &_key) const =0
 Get custom data stored in this node. More...
 
virtual math::Pose3d WorldPose () const =0
 Get the world pose. More...
 
virtual math::Vector3d WorldPosition () const =0
 Get the world position. More...
 
virtual math::Quaterniond WorldRotation () const =0
 Get the world rotation. More...
 
virtual math::Vector3d WorldScale () const =0
 Get the world scale. More...
 
virtual math::Pose3d WorldToLocal (const math::Pose3d &_pose) const =0
 Convert given world pose to local pose. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
virtual void Destroy ()=0
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
 
virtual unsigned int Id () const =0
 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 =0
 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...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from BaseCamera< T >
virtual ~BaseCamera ()
 
virtual void AddRenderPass (const RenderPassPtr &_pass) override
 Add a render pass to the camera. More...
 
virtual unsigned int AntiAliasing () const override
 Get the level of anti-aliasing used during rendering. More...
 
virtual double AspectRatio () const override
 Get the camera's aspect ratio. More...
 
virtual void Capture (Image &_image) override
 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 NOT be used in applications with multiple cameras or multiple consumers of a single camera's images. More...
 
virtual common::ConnectionPtr ConnectNewImageFrame (Camera::NewFrameListener _listener) override
 Subscribes a new listener to this camera's new frame event. More...
 
virtual void Copy (Image &_image) const override
 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 override
 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 RenderWindowPtr CreateRenderWindow () override
 Create a render window. More...
 
virtual double FarClipPlane () const override
 Get the camera's far clipping plane distance. More...
 
virtual math::Vector3d FollowOffset () const override
 Get the follow offset vector in the frame specified at the time the follow target is set. More...
 
virtual double FollowPGain () const override
 Get the camera follow movement P gain. More...
 
virtual NodePtr FollowTarget () const override
 Get the target node being followed. More...
 
virtual math::Angle HFOV () const override
 Get the camera's horizontal field-of-view. More...
 
virtual PixelFormat ImageFormat () const override
 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 override
 Get the image height in pixels. More...
 
virtual unsigned int ImageMemorySize () const override
 Get the total image memory size in bytes. More...
 
virtual unsigned int ImageWidth () const override
 Get the image width in pixels. More...
 
virtual double NearClipPlane () const override
 Get the camera's near clipping plane distance. More...
 
virtual void PostRender () override
 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 () override
 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 math::Vector2i Project (const math::Vector3d &_pt) const override
 Project point in 3d world space to 2d screen space. More...
 
virtual math::Matrix4d ProjectionMatrix () const override
 Get the projection matrix for this camera. More...
 
virtual CameraProjectionType ProjectionType () const override
 Get the projection type for this camera. More...
 
virtual void RemoveRenderPass (const RenderPassPtr &_pass) override
 Remove a render pass from the camera. More...
 
virtual RenderPassPtr RenderPassByIndex (unsigned int _index) const override
 Get a render passes by index. More...
 
virtual unsigned int RenderPassCount () const override
 Get the number of render passes applied to the camera. More...
 
virtual unsigned int RenderTextureGLId () const override
 Get the OpenGL texture id associated with the render texture used by this camera. A valid id is returned only if the underlying render engine is OpenGL based. More...
 
virtual bool SaveFrame (const std::string &_name) override
 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 SetAntiAliasing (const unsigned int _aa) override
 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) override
 Set the camera's aspect ratio. This value determines the cameras vertical field-of-view. It is often the. More...
 
virtual void SetFarClipPlane (const double _far) override
 Set the camera's far clipping plane distance. More...
 
virtual void SetFollowOffset (const math::Vector3d &_offset) override
 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) override
 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) override
 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 SetHFOV (const math::Angle &_hfov) override
 Set the camera's horizontal field-of-view. More...
 
virtual void SetImageFormat (PixelFormat _format) override
 Set the image pixel format. More...
 
virtual void SetImageHeight (const unsigned int _height) override
 Set the image height in pixels. More...
 
virtual void SetImageWidth (const unsigned int _width) override
 Set the image width in pixels. More...
 
virtual void SetMaterial (const MaterialPtr &_material) override
 Set a material that the camera should see on all objects. More...
 
virtual void SetNearClipPlane (const double _near) override
 Set the camera's near clipping plane distance. More...
 
virtual void SetProjectionMatrix (const math::Matrix4d &_matrix) override
 Set the projection matrix for this camera. This overrides the standard projection matrix computed based on camera parameters. More...
 
virtual void SetProjectionType (CameraProjectionType _type) override
 Set the projection type for this camera This changes the projection matrix of the camera based on the camera projection type. A custom projection matrix can be specified via SetProjectionMatrix to override the provided one. To disable the custom projection matrix, just call this function again with the desired projection type. More...
 
virtual void SetShadowsDirty () override
 
virtual void SetTrackOffset (const math::Vector3d &_offset) override
 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) override
 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) override
 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 override
 Get the track offset vector in the frame specified at the time the track target is set. More...
 
virtual double TrackPGain () const override
 Get the camera track rotation P gain. More...
 
virtual NodePtr TrackTarget () const override
 Get the target node being tracked. More...
 
virtual void Update () override
 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 NOT be used in applications with multiple cameras or multiple consumers of a single camera's images. More...
 
virtual math::Matrix4d ViewMatrix () const override
 Get the view matrix for this camera. More...
 
virtual VisualPtr VisualAt (const ignition::math::Vector2i &_mousePos) override
 Get the visual for a given mouse position param[in] _mousePos mouse position. More...
 

Protected Member Functions

 BaseThermalCamera ()
 Constructor. More...
 
- Protected Member Functions inherited from BaseCamera< T >
 BaseCamera ()
 
virtual void * CreateImageBuffer () const
 
virtual void Load () override
 
virtual RenderTargetPtr RenderTarget () const =0
 
virtual void Reset ()
 

Protected Attributes

float ambient = 0.0f
 Ambient temperature of the environment. More...
 
float ambientRange = 0.0f
 Ambient temperature range. More...
 
float heatSourceTempRange = 0.0f
 Range of heat source temperature variation. More...
 
float maxTemp = ignition::math::INF_F
 Maximum temperature. More...
 
float minTemp = -ignition::math::INF_F
 Minimum temperature. More...
 
float resolution = 0.01f
 Linear resolution. Defaults to 10mK. More...
 
- Protected Attributes inherited from BaseCamera< T >
unsigned int antiAliasing = 0u
 Anti-aliasing. More...
 
double aspect = 1.3333333
 Aspect ratio. More...
 
double farClip = 1000.0
 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 = 1.0
 P gain for follow mode. Determines how fast the camera moves to follow the target node. Valid range: [0-1]. More...
 
bool followWorldFrame = false
 Follow target in world frame. More...
 
math::Angle hfov
 Horizontal camera field of view. More...
 
ImagePtr imageBuffer
 
double nearClip = 0.01
 Near clipping plane distance. More...
 
common::EventT< void(const void *, unsigned int, unsigned int, unsigned int, const std::string &)> newFrameEvent
 
math::Matrix4d projectionMatrix
 Custom projection matrix. More...
 
CameraProjectionType projectionType = CPT_PERSPECTIVE
 Camera projection type. More...
 
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 = 1.0
 P gain for tracking. Determines how fast the camera rotates to look at the target node. Valid range: [0-1]. More...
 
bool trackWorldFrame = false
 Track point relative to target in world frame. More...
 

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

Detailed Description

template<class T>
class ignition::rendering::BaseThermalCamera< T >

Base implementation of the ThermalCamera class.

Constructor & Destructor Documentation

◆ BaseThermalCamera()

BaseThermalCamera ( )
protected

Constructor.

◆ ~BaseThermalCamera()

~BaseThermalCamera ( )
virtual

Destructor.

Member Function Documentation

◆ AmbientTemperature()

float AmbientTemperature ( ) const
overridevirtual

Get the ambient temperature of the environment.

Returns
Ambient temperature in kelvin
See also
SetAmbientTemperature

Implements ThermalCamera.

◆ AmbientTemperatureRange()

float AmbientTemperatureRange ( ) const
overridevirtual

Get the range of ambient temperature.

Returns
The ambient temperature range. Ambient temperature ranges from (ambient - range/2) to (ambient - range/2)
See also
SetAmbientTemperatureRange

Implements ThermalCamera.

◆ ConnectNewThermalFrame()

common::ConnectionPtr ConnectNewThermalFrame ( std::function< void(const uint16_t *, unsigned int, unsigned int, unsigned int, const std::string &)>  _subscriber)
overridevirtual

Connect to the new thermal image event.

Parameters
[in]_subscriberSubscriber callback function. The callback function arguments are: <thermal data, width, height, depth, format>
Returns
Pointer to the new Connection. This must be kept in scope

Implements ThermalCamera.

Reimplemented in OgreThermalCamera.

◆ HeatSourceTemperatureRange()

float HeatSourceTemperatureRange ( ) const
overridevirtual

Get the range of temperature variation for all heat sources.

Returns
Temperature variation range
See also
SetHeatSourceTemperatureRange

Implements ThermalCamera.

◆ LinearResolution()

float LinearResolution ( ) const
overridevirtual

Get the temperature linear resolution.

Returns
Temperature linear resolution
See also
SetLinearResolution

Implements ThermalCamera.

◆ MaxTemperature()

float MaxTemperature ( ) const
overridevirtual

Get the maximum temperature the sensor can detect.

Returns
Max temperature in kelvin
See also
SetMaxTemperature

Implements ThermalCamera.

◆ MinTemperature()

float MinTemperature ( ) const
overridevirtual

Get the minimum temperature the sensor can detect.

Returns
Min temperature in kelvin
See also
SetMinTemperature

Implements ThermalCamera.

◆ SetAmbientTemperature()

void SetAmbientTemperature ( float  _ambient)
overridevirtual

Set the ambient temperature of the environment.

Parameters
[in]_ambientAmbient temperature in kelvin
See also
AmbientTemperature

Implements ThermalCamera.

◆ SetAmbientTemperatureRange()

void SetAmbientTemperatureRange ( float  _range)
overridevirtual

Set the range of ambient temperature.

Parameters
[in]_rangeThe ambient temperature ranges from (ambient - range/2) to (ambient + range/2).
See also
AmbientTemperatureRange

Implements ThermalCamera.

◆ SetHeatSourceTemperatureRange()

void SetHeatSourceTemperatureRange ( float  _range)
overridevirtual

Set the range of temperature variation for all heat sources. If set, the temperature reading of heat sources will vary within a temperature of +/- range/2 instead of returning a fixed uniform temperature for the entire heat source.

Parameters
[in]_rangeTemperature variation range
See also
HeatSourceTemperatureRange

Implements ThermalCamera.

◆ SetLinearResolution()

void SetLinearResolution ( float  _resolution)
overridevirtual

Set the temperature linear resolution. The thermal image data returned will be temperature in kelvin / resolution. Typical values are 0.01 (10mK), 0.1 (100mK), or 0.04 to simulate 14 bit format.

Parameters
[in]_resolutionTemperature linear resolution
See also
LinearResolution

Implements ThermalCamera.

◆ SetMaxTemperature()

void SetMaxTemperature ( float  _max)
overridevirtual

Set the maximum temperature the sensor can detect.

Parameters
[in]_maxMax temperature in kelvin
See also
MaxTemperature

Implements ThermalCamera.

◆ SetMinTemperature()

void SetMinTemperature ( float  _min)
overridevirtual

Set the minimum temperature the sensor can detect.

Parameters
[in]_minMin temperature in kelvin
See also
MinTemperature

Implements ThermalCamera.

Member Data Documentation

◆ ambient

float ambient = 0.0f
protected

◆ ambientRange

float ambientRange = 0.0f
protected

◆ heatSourceTempRange

float heatSourceTempRange = 0.0f
protected

◆ maxTemp

◆ minTemp

◆ resolution

float resolution = 0.01f
protected

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