RobWorkProject  24.8.23-
Public Types | Public Member Functions | List of all members
RenderImage Class Reference

RenderImage renders a image in a plane defined by [-w/2;h/2][w/2;-h/2]. The image need to be scaled into metric units. This can be done using a scaling parameter. More...

#include <RenderImage.hpp>

Inherits Render.

Public Types

typedef rw::core::Ptr< RenderImagePtr
 smart pointer type to this class
 
- Public Types inherited from Render
typedef rw::core::Ptr< RenderPtr
 smart pointer type to this class
 
typedef DrawableNode::DrawType DrawType
 when calling render on the draw mode or type can be specified. See DrawableNode::DrawType
 

Public Member Functions

 RenderImage (float scale=1.0/1000.0)
 constructor More...
 
 RenderImage (const rw::sensor::Image &img, float scale=1.0/1000.0)
 Constructs. More...
 
virtual ~RenderImage ()
 Destructor.
 
void setImage (const rw::sensor::Image &img)
 set the image that is to be rendered. More...
 
void draw (const rw::graphics::DrawableNode::RenderInfo &info, rw::graphics::DrawableNode::DrawType type, double alpha) const
 
- Public Member Functions inherited from Render
virtual ~Render ()
 destructor
 

Additional Inherited Members

- Protected Member Functions inherited from Render
 Render ()
 Only instances of classes inheriting Render is allowed.
 

Detailed Description

RenderImage renders a image in a plane defined by [-w/2;h/2][w/2;-h/2]. The image need to be scaled into metric units. This can be done using a scaling parameter.

Constructor & Destructor Documentation

◆ RenderImage() [1/2]

RenderImage ( float  scale = 1.0/1000.0)

constructor

Parameters
scale[in] scale from image coordinates to meters.

◆ RenderImage() [2/2]

RenderImage ( const rw::sensor::Image img,
float  scale = 1.0/1000.0 
)

Constructs.

Parameters
img[in} the image that is to be rendered
scale[in] scale from image coordinates to meters.

Member Function Documentation

◆ draw()

void draw ( const rw::graphics::DrawableNode::RenderInfo info,
rw::graphics::DrawableNode::DrawType  type,
double  alpha 
) const
virtual

Parameters
info[in] state and rendering specific info
type[in] the drawtype which is being used
alpha[in] the alpha value to render with

Implements Render.

◆ setImage()

void setImage ( const rw::sensor::Image img)

set the image that is to be rendered.

Parameters
img[in] image to render

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