implements the image writer interface for bmp files More...
#include <bmp_writer.h>
Public Member Functions | |
| bmp_writer () | |
| default constructor | |
| std::string | get_type_name () const |
| overload to return the type name of this object | |
| abst_image_writer * | clone () const |
| construct a copy of the reader | |
| const char * | get_supported_extensions () const |
| return a string containing a colon separated list of extensions that can be read with this reader | |
| bool | is_format_supported (const cgv::data::component_format &cf, const std::vector< cgv::data::component_format > *palette_formats) const |
| check if the chosen writer supports the given component format | |
| std::string | get_options () const |
| return a colon separated list of supported options | |
| const std::string & | get_last_error () const |
| return a reference to the last error message | |
| bool | open (const std::string &file_name) |
| open image file to write | |
| bool | write_image (const cgv::data::const_data_view &dv, const std::vector< cgv::data::const_data_view > *palettes, double duration) |
| write the data stored in the data view to a file with the file name given in the constructor. | |
| bool | close () |
| close image [stream] | |
 Public Member Functions inherited from cgv::media::image::abst_image_writer | |
| virtual bool | supports_multiple_images () const |
| return whether multiple images are supported, default implementation returns false | |
| Public Member Functions inherited from cgv::base::base | |
| 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 > ¶m_value_types, const std::vector< const void * > ¶m_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 | |
Protected Attributes | |
| std::string | last_error |
| FILE * | fp |
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
implements the image writer interface for bmp files
Definition at line 12 of file bmp_writer.h.
Constructor & Destructor Documentation
◆ bmp_writer()
| cgv::media::image::bmp_writer::bmp_writer | ( | ) |
Member Function Documentation
◆ clone()
|
virtual |
construct a copy of the reader
Implements cgv::media::image::abst_image_writer.
Definition at line 26 of file bmp_writer.cxx.
References bmp_writer().
◆ close()
|
virtual |
close image [stream]
Implements cgv::media::image::abst_image_writer.
Definition at line 178 of file bmp_writer.cxx.
◆ get_last_error()
|
virtual |
return a reference to the last error message
Implements cgv::media::image::abst_image_writer.
Definition at line 63 of file bmp_writer.cxx.
◆ get_options()
| std::string cgv::media::image::bmp_writer::get_options | ( | ) | const |
return a colon separated list of supported options
Definition at line 58 of file bmp_writer.cxx.
◆ get_supported_extensions()
|
virtual |
return a string containing a colon separated list of extensions that can be read with this reader
Implements cgv::media::image::abst_image_writer.
Definition at line 31 of file bmp_writer.cxx.
◆ get_type_name()
|
virtual |
overload to return the type name of this object
Reimplemented from cgv::base::base.
Definition at line 21 of file bmp_writer.cxx.
◆ is_format_supported()
|
virtual |
check if the chosen writer supports the given component format
Implements cgv::media::image::abst_image_writer.
Definition at line 37 of file bmp_writer.cxx.
References cgv::data::CF_BGR, cgv::data::CF_L, cgv::data::CF_RGB, cgv::data::component_format::get_component_type(), cgv::data::component_format::get_nr_components(), cgv::data::component_format::get_standard_component_format(), and cgv::type::info::TI_UINT8.
◆ open()
|
virtual |
open image file to write
write the data stored in the data view to a file with the file name given in the constructor.
Implements cgv::media::image::abst_image_writer.
Definition at line 69 of file bmp_writer.cxx.
◆ write_image()
|
virtual |
write the data stored in the data view to a file with the file name given in the constructor.
Implements cgv::media::image::abst_image_writer.
Definition at line 82 of file bmp_writer.cxx.
References cgv::data::packing_info::align(), cgv::data::CF_BGR, cgv::data::CF_RGB, cgv::data::data_view_impl< D, P >::get(), cgv::data::component_format::get_component_name(), cgv::data::data_view_base::get_format(), cgv::data::data_format::get_height(), cgv::data::component_format::get_nr_components(), cgv::data::data_view_impl< D, P >::get_ptr(), cgv::data::component_format::get_standard_component_format(), and cgv::data::data_format::get_width().
Member Data Documentation
◆ fp
|
protected |
Definition at line 16 of file bmp_writer.h.
◆ last_error
|
protected |
Definition at line 15 of file bmp_writer.h.
The documentation for this class was generated from the following files:
- cgv/media/image/bmp_writer.h
- cgv/media/image/bmp_writer.cxx
