IfcImage class

IfcImage class

Ifc Image class

Inheritance: IfcImageImageDataStreamSupporterDisposableObject

The IfcImage type exposes the following members:

Properties

PropertyDescription
disposedGets a value indicating whether this instance is disposed.
data_stream_containerGets the object’s data stream.
is_cachedGets a value indicating whether object’s data is cached currently and no data readig is required.
boundsGets the image bounds.
containerGets the Image container.
heightGets the image height.
paletteGets or sets the color palette.
sizeGets the image size.
widthGets the image width.
has_background_colorGets or sets a value indicating whether image has background color.
background_colorGets or sets a value for the background color.
unit_typeGets current unit type.
unitless_default_unit_typeAssumed unit type when UnitType is set to Unitless
headerGets the header.
layersGets list of layers in image
depthGets the depth.

Methods

MethodDescription
saveSaves the image data to the underlying stream.
saveSaves the object’s data to the specified file location in the specified file format according to save options.
saveSaves the image’s data to the specified stream in the specified file format according to save options.
saveSaves the object’s data to the specified stream.
saveSaves the object’s data to the specified file location.
saveSaves the object’s data to the specified file location.
can_loadDetermines whether image can be loaded from the specified file path.
can_loadDetermines whether an image can be loaded from the specified file path and optionally using the specified open options
can_loadDetermines whether image can be loaded from the specified stream.
can_loadDetermines whether image can be loaded from the specified stream and optionally using the specified load_options.
get_file_formatGets the file format.
get_file_formatGets the file format.
loadLoads a new image from the specified file.
loadLoads a new image from the specified file.
loadLoads a new image from the specified stream.
loadLoads a new image from the specified stream.
cache_dataCaches the data and ensures no additional data loading will be performed from the underlying DataStreamSupporter.data_stream_container.
get_stringsGets all string values from image.
can_saveDetermines whether image can be saved to the specified file format represented by the passed save options.

See Also