IfcImage class

Ifc Image class

Inheritance: IfcImage → Image → DataStreamSupporter → DisposableObject

The IfcImage type exposes the following members:

Property	Description
disposed	Gets a value indicating whether this instance is disposed.
data_stream_container	Gets the object’s data stream.
is_cached	Gets a value indicating whether object’s data is cached currently and no data readig is required.
bounds	Gets the image bounds.
container	Gets the `Image` container.
height	Gets the image height.
palette	Gets or sets the color palette.
size	Gets the image size.
width	Gets the image width.
has_background_color	Gets or sets a value indicating whether image has background color.
background_color	Gets or sets a value for the background color.
unit_type	Gets current unit type.
unitless_default_unit_type	Assumed unit type when UnitType is set to Unitless
header	Gets the header.
layers	Gets list of layers in image
depth	Gets the depth.

Method	Description
save	Saves the image data to the underlying stream.
save	Saves the object’s data to the specified file location in the specified file format according to save options.
save	Saves the image’s data to the specified stream in the specified file format according to save options.
save	Saves the object’s data to the specified stream.
save	Saves the object’s data to the specified file location.
save	Saves the object’s data to the specified file location.
can_load	Determines whether image can be loaded from the specified file path.
can_load	Determines whether an image can be loaded from the specified file path and optionally using the specified open options
can_load	Determines whether image can be loaded from the specified stream.
can_load	Determines whether image can be loaded from the specified stream and optionally using the specified `load_options`.
get_file_format	Gets the file format.
get_file_format	Gets the file format.
load	Loads a new image from the specified file.
load	Loads a new image from the specified file.
load	Loads a new image from the specified stream.
load	Loads a new image from the specified stream.
cache_data	Caches the data and ensures no additional data loading will be performed from the underlying `DataStreamSupporter.data_stream_container`.
get_strings	Gets all string values from image.
can_save	Determines whether image can be saved to the specified file format represented by the passed save options.