HGL::ImageOutput::DefaultPreRenderOutput Class Reference
[Image output plugins]

Empty implementation of the HGL::ImageOutput::IPreRenderOutput interface. More...

#include <defaultprerenderoutput.h>

List of all members.

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

---

Detailed Description

Empty implementation of the HGL::ImageOutput::IPreRenderOutput interface.

You can use this class if you are not interested in implementing all notifications in your plugin.

The default iplemenentations are empty.

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 [inherited]

Indicates the state of rendering.

Since:

0.4.70

Enumerator:

START	overall rendering has started
END	overall rendering has ended

---

Member Function Documentation

void HGL::ImageOutput::DefaultPreRenderOutput::announceOutputFilename

(

const std::string &

outputFilename

)

const [protected]

Announces a (new) output filename.

A plugin may add a suffix or even alter the output filename at all. In this case the new filename can get announced to the interpreter, which will use it furthermore.

Since:

0.5.25

virtual std::string HGL::ImageOutput::DefaultPreRenderOutput::getOutputFilename

(

)

const [virtual]

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

Implements HGL::ImageOutput::IOutput.

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::DefaultPreRenderOutput::update

(

const TextPrimitive *

primitive

)

throw (ImageOutputException) [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

Implements HGL::ImageOutput::IPreRenderOutput.

virtual void HGL::ImageOutput::DefaultPreRenderOutput::update

(

const EllipsePrimitive *

primitive

)

throw (ImageOutputException) [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

Implements HGL::ImageOutput::IPreRenderOutput.

virtual void HGL::ImageOutput::DefaultPreRenderOutput::update

(

const PolyPrimitive *

primitive

)

throw (ImageOutputException) [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

Implements HGL::ImageOutput::IPreRenderOutput.

virtual void HGL::ImageOutput::DefaultPreRenderOutput::update

(

const CurvePrimitive *

primitive

)

throw (ImageOutputException) [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

Implements HGL::ImageOutput::IPreRenderOutput.

virtual void HGL::ImageOutput::DefaultPreRenderOutput::update

(

const LinePrimitive *

primitive

)

throw (ImageOutputException) [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

Implements HGL::ImageOutput::IPreRenderOutput.

virtual void HGL::ImageOutput::DefaultPreRenderOutput::update

(

const PointPrimitive *

primitive

)

throw (ImageOutputException) [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

Implements HGL::ImageOutput::IPreRenderOutput.

virtual void HGL::ImageOutput::DefaultPreRenderOutput::update

(

const ICanvas::TRANSFORMATIONINFO *

ti

)

throw (ImageOutputException) [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

Implements HGL::ImageOutput::IPreRenderOutput.

virtual void HGL::ImageOutput::DefaultPreRenderOutput::update

(

const

evt

)

throw (ImageOutputException) [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

Implements HGL::ImageOutput::IPreRenderOutput.

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

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

Implements HGL::ImageOutput::IOutput.