HGL::ImageOutput::IPreRenderOutput Interface Reference
[Image output plugins]

Interface for writing images into a file. More...

#include <iprerenderoutput.h>

List of all members.

Public Types
enum	RENDEREVENT {   START,   END }
	Indicates the state of rendering. More...
Public Member Functions
Information functions
virtual std::string	getOutputFilename () const =0
	Get the effective output filename of the rendered picture.
Command line options support
virtual struct::poptOption *	getPoptOptions () const
	Get plugin supplied command line options.
Pre-render notifications
virtual void	update (const TextPrimitive *const primitive)=0 throw (ImageOutputException)
	Notification about a text to render.
virtual void	update (const EllipsePrimitive *const primitive)=0 throw (ImageOutputException)
	Notification about an ellipse to render.
virtual void	update (const PolyPrimitive *const primitive)=0 throw (ImageOutputException)
	Notification about a poly to render.
virtual void	update (const CurvePrimitive *const primitive)=0 throw (ImageOutputException)
	Notification about a curve to render.
virtual void	update (const LinePrimitive *const primitive)=0 throw (ImageOutputException)
	Notification about a line to render.
virtual void	update (const PointPrimitive *const primitive)=0 throw (ImageOutputException)
	Notification about a point to render.
virtual void	update (const ICanvas::TRANSFORMATIONINFO *const ti)=0 throw (ImageOutputException)
	Notification about transformation information available.
virtual void	update (const RENDEREVENT evt)=0 throw (ImageOutputException)
	Notification about an general render event.
Bitmap render methods
virtual void	writeImage (const ICanvas &canvas, const std::string &filename=std::string()) const =0 throw (ImageOutputException)
	Writes an ICanvas bitmap into an image.

---

Detailed Description

Interface for writing images into a file.

Note:

If you need to keep the primitives you got from the update methods, make a copy of them, since it is not guaranteed they exist over all the lifetime of the plugin.

See Image Output Plugins in detail for more information.

See also:

REGISTER_IOPLUGIN

Author:

Heiko Schäfer <heiko@hgl.rangun.de>

Since:

0.4.70 BSD License

---

Member Enumeration Documentation

enum HGL::ImageOutput::IPreRenderOutput::RENDEREVENT

Indicates the state of rendering.

Since:

0.4.70

Enumerator:

START	overall rendering has started
END	overall rendering has ended

---

Member Function Documentation

virtual std::string HGL::ImageOutput::IOutput::getOutputFilename

(

)

const [pure virtual, inherited]

Get the effective output filename of the rendered picture.

It should return an empty std::string if the standard output is used

Returns:

the output filename of the rendered picture

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.

virtual struct ::poptOption* HGL::Common::IPluginPoptOptions::getPoptOptions

(

)

const [virtual, inherited]

Get plugin supplied command line options.

Note:

See http://linux.die.net/man/3/popt for how to create and use the popt structure and Command line options support for details on how to use it in your plugins.

The default implementation returns NULL i.e. it won't provide own command line options

In your POPT_ARG_CALLBACK you can indicate HGL to exit gracefully by throwing HGL::Exception::PoptExitException

Returns:

structure to popt options

Since:

0.4.53

virtual void HGL::ImageOutput::IPreRenderOutput::update

(

const TextPrimitive *const

primitive

)

throw (ImageOutputException) [pure virtual]

Notification about a text to render.

Parameters:

primitive

the text primitive

Exceptions:

HGL::ImageOutput::ImageOutputException

in case of an unrecoverable error

Since:

0.4.70

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.

virtual void HGL::ImageOutput::IPreRenderOutput::update

(

const EllipsePrimitive *const

primitive

)

throw (ImageOutputException) [pure virtual]

Notification about an ellipse to render.

Parameters:

primitive

the ellipse primitive

Exceptions:

HGL::ImageOutput::ImageOutputException

in case of an unrecoverable error

Since:

0.4.70

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.

virtual void HGL::ImageOutput::IPreRenderOutput::update

(

const PolyPrimitive *const

primitive

)

throw (ImageOutputException) [pure virtual]

Notification about a poly to render.

Parameters:

primitive

the poly primitive

Exceptions:

HGL::ImageOutput::ImageOutputException

in case of an unrecoverable error

Since:

0.4.70

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.

virtual void HGL::ImageOutput::IPreRenderOutput::update

(

const CurvePrimitive *const

primitive

)

throw (ImageOutputException) [pure virtual]

Notification about a curve to render.

Parameters:

primitive

the curve primitive

Exceptions:

HGL::ImageOutput::ImageOutputException

in case of an unrecoverable error

Since:

0.5.0

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.

virtual void HGL::ImageOutput::IPreRenderOutput::update

(

const LinePrimitive *const

primitive

)

throw (ImageOutputException) [pure virtual]

Notification about a line to render.

Parameters:

primitive

the line primitive

Exceptions:

HGL::ImageOutput::ImageOutputException

in case of an unrecoverable error

Since:

0.4.70

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.

virtual void HGL::ImageOutput::IPreRenderOutput::update

(

const PointPrimitive *const

primitive

)

throw (ImageOutputException) [pure virtual]

Notification about a point to render.

Parameters:

primitive

the point primitive

Exceptions:

HGL::ImageOutput::ImageOutputException

in case of an unrecoverable error

Since:

0.4.70

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.

virtual void HGL::ImageOutput::IPreRenderOutput::update

(

const ICanvas::TRANSFORMATIONINFO *const

ti

)

throw (ImageOutputException) [pure virtual]

Notification about transformation information available.

Parameters:

ti

the transformation information

Exceptions:

HGL::ImageOutput::ImageOutputException

in case of an unrecoverable error

Since:

0.5.2

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.

virtual void HGL::ImageOutput::IPreRenderOutput::update

(

const RENDEREVENT

evt

)

throw (ImageOutputException) [pure virtual]

Notification about an general render event.

Parameters:

evt

the event

Exceptions:

HGL::ImageOutput::ImageOutputException

in case of an unrecoverable error

Since:

0.4.70

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.

virtual void HGL::ImageOutput::IOutput::writeImage	(	const ICanvas &	canvas,
		const std::string &	filename = std::string()
	)			const throw (ImageOutputException) [pure virtual, inherited]

Writes an ICanvas bitmap into an image.

Parameters:

	canvas	the ICanvas bitmap to write
	filename	filename to write the image to, if the filename is the empty string it should write to the standard output

Exceptions:

ImageOutputException

if an unrecoverable error occured while writing

See also:

Writer

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.