abstract interface for image readers More...

#include <image_writer.h>

Inheritance diagram for cgv::media::image::abst_image_writer:

Public Member Functions
virtual abst_image_writer *	clone () const =0
	construct a copy of the reader

virtual const char *	get_supported_extensions () const =0
	return a string containing a colon separated list of extensions that can be read with this reader

virtual bool	is_format_supported (const cgv::data::component_format &cf, const std::vector< cgv::data::component_format > *palette_formats) const =0
	check if the chosen writer supports the given component format

virtual const std::string &	get_last_error () const =0
	return a reference to the last error message

virtual bool	supports_multiple_images () const
	return whether multiple images are supported, default implementation returns false

virtual bool	open (const std::string &file_name)=0
	open image file to write

virtual bool	write_image (const cgv::data::const_data_view &dv, const std::vector< cgv::data::const_data_view > *palettes, double duration)=0
	write one image

virtual bool	close ()=0
	close image [stream]

Public Member Functions inherited from cgv::base::base
virtual std::string	get_type_name () const
	overload to return the type name of this object. By default the type interface is queried over get_type.

virtual std::string	get_default_options () const
	overload to provide default options for registration

std::string	get_name_or_type_name () const
	determine name of instance by checking cgv::base::named interface and in failure fallback to get_type_name()

virtual void	on_register ()
	overload to handle register events that is sent after the instance has been registered

virtual void	unregister ()
	overload to handle unregistration of instances

virtual bool	on_exit_request ()
	overload to handle the appication exit request, return true if exiting is allowed and false otherwise

virtual void	stream_stats (std::ostream &)
	overload to show the content of this object

virtual data::ref_ptr< named, true >	get_named ()
	perform downcast to named

virtual data::ref_ptr< node, true >	get_node ()
	perform downcast to node

virtual data::ref_ptr< group, true >	get_group ()
	perform downcast to group

virtual data::ref_ptr< const named, true >	get_named_const () const
	perform downcast to const named

virtual data::ref_ptr< const node, true >	get_node_const () const
	perform downcast to const node

virtual data::ref_ptr< const group, true >	get_group_const () const
	perform downcast to const group

template<class T >
data::ref_ptr< T, true >	cast ()
	cast to arbitrary class, but use the casts to named, node and group from the interface

template<class T >
data::ref_ptr< const T, true >	cast_const ()
	const cast to arbitrary class, but use the casts to named, node and group from the interface

template<class T >
T *	get_interface ()
	use dynamic type cast to check for the given interface

template<class T >
const T *	get_const_interface () const
	use dynamic type cast to check for the given interface

virtual void	update ()
	this virtual update allows for example to ask a view to update the viewed value. The default implementation is empty.

virtual void *	get_user_data () const
	this virtual method allows to pass application specific data for internal purposes

virtual bool	self_reflect (cgv::reflect::reflection_handler &)
	used for simple self reflection

virtual std::string	get_property_declarations ()
	return a semicolon separated list of property declarations

virtual bool	set_void (const std::string &property, const std::string &value_type, const void *value_ptr)
	abstract interface for the setter of a dynamic property.

virtual void	on_set (void *member_ptr)
	this callback is called when the set_void method has changed a member and can be overloaded in derived class

virtual bool	get_void (const std::string &property, const std::string &value_type, void *value_ptr)
	abstract interface for the getter of a dynamic property.

virtual bool	call_void (const std::string &method, const std::vector< std::string > &param_value_types, const std::vector< const void * > &param_value_ptrs, const std::string &result_type="", void *result_value_ptr=0)
	abstract interface to call an action

void	set (const std::string &property, const char *value)
	specialization of set method to support const char* as strings

template<typename T >
void	set (const std::string &property, const T &value)
	set a property of the element to the given value and perform standard conversions if necessary.

template<typename T >
T	get (const std::string &property)
	query a property of the element and perform standard conversions if necessary.

void	multi_set (const std::string &property_assignments, bool report_error=true)
	set several properties

bool	is_property (const std::string &property_name, std::string *type_name=0)
	check if the given name specifies a property.

void *	find_member_ptr (const std::string &property_name, std::string *type_name=0)
	find a member pointer by name.

Public Member Functions inherited from cgv::data::ref_counted
int	get_ref_count () const
	read access to current count

Friends
class	image_writer

Additional Inherited Members
Protected Member Functions inherited from cgv::base::base
virtual	~base ()
	make destructor virtual and not accessible from outside

Protected Member Functions inherited from cgv::data::ref_counted
	ref_counted ()
	constructor initializes the count to 0

void	set_ref_count (int c) const
	write access is also const to allow ref counted pointers to const instances

Static Protected Member Functions inherited from cgv::base::base
template<class T >
static data::ref_ptr< T, true >	cast_dynamic (base *b)
	use dynamic cast for upcast to given class

Detailed Description

abstract interface for image readers

Definition at line 16 of file image_writer.h.

Member Function Documentation

◆ clone()

virtual abst_image_writer * cgv::media::image::abst_image_writer::clone ( ) const

pure virtual

construct a copy of the reader

Implemented in cgv::media::image::bmp_writer.

◆ close()

virtual bool cgv::media::image::abst_image_writer::close ( )

pure virtual

close image [stream]

Implemented in cgv::media::image::bmp_writer.

Referenced by cgv::media::image::image_writer::close().

◆ get_last_error()

virtual const std::string & cgv::media::image::abst_image_writer::get_last_error ( ) const

pure virtual

return a reference to the last error message

Implemented in cgv::media::image::bmp_writer.

Referenced by cgv::media::image::image_writer::get_last_error().

◆ get_supported_extensions()

virtual const char * cgv::media::image::abst_image_writer::get_supported_extensions ( ) const

pure virtual

return a string containing a colon separated list of extensions that can be read with this reader

Implemented in cgv::media::image::bmp_writer.

◆ is_format_supported()

virtual bool cgv::media::image::abst_image_writer::is_format_supported	(	const cgv::data::component_format &	cf,
		const std::vector< cgv::data::component_format > *	palette_formats
	)		const

pure virtual

check if the chosen writer supports the given component format

Implemented in cgv::media::image::bmp_writer.

Referenced by cgv::media::image::image_writer::is_format_supported().

◆ open()

virtual bool cgv::media::image::abst_image_writer::open ( const std::string & file_name )

pure virtual

open image file to write

Implemented in cgv::media::image::bmp_writer.

Referenced by cgv::media::image::image_writer::write_image().

◆ supports_multiple_images()

bool cgv::media::image::abst_image_writer::supports_multiple_images ( ) const

virtual

return whether multiple images are supported, default implementation returns false

Definition at line 43 of file image_writer.cxx.

Referenced by cgv::media::image::image_writer::supports_multiple_images().

◆ write_image()

virtual bool cgv::media::image::abst_image_writer::write_image	(	const cgv::data::const_data_view &	dv,
		const std::vector< cgv::data::const_data_view > *	palettes,
		double	duration
	)

pure virtual

write one image

Implemented in cgv::media::image::bmp_writer.

Referenced by cgv::media::image::image_writer::write_image().

Friends And Related Symbol Documentation

◆ image_writer

friend class image_writer

friend

Definition at line 19 of file image_writer.h.

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

cgv/media/image/image_writer.h
cgv/media/image/image_writer.cxx

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ close()

◆ get_last_error()

◆ get_supported_extensions()

◆ is_format_supported()

◆ open()

◆ supports_multiple_images()

◆ write_image()

Friends And Related Symbol Documentation

◆ image_writer